CodingGuidelines: Add a note about spaces after redirection
During code review of some patches, it was noted that redirection operators should have space before, but no space after them. Signed-off-by: Tim Henigan <tim.henigan@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Tim Henigan committed
Feb 24, 2012 at 18:12 UTC
48f359bfafa7db4c399fa13f17ccfea7c35f333b
1 file changed
+7
Documentation/CodingGuidelines
+7
@@ -35,6 +35,13 @@ For shell scripts specifically (not exhaustive):
35
36
- Case arms are indented at the same depth as case and esac lines.
37
38
+ - Redirection operators should be written with space before, but no
39
+ space after them. In other words, write 'echo test >"$file"'
40
+ instead of 'echo test> $file' or 'echo test > $file'. Note that
41
+ even though it is not required by POSIX to double-quote the
42
+ redirection target in a variable (as shown above), our code does so
43
+ because some versions of bash issue a warning without the quotes.
44
+
45
- We prefer $( ... ) for command substitution; unlike ``, it
46
properly nests. It should have been the way Bourne spelled
47
it from day one, but unfortunately isn't.