Browse Source

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>
maint
Tim Henigan 13 years ago committed by Junio C Hamano
parent
commit
48f359bfaf
  1. 7
      Documentation/CodingGuidelines

7
Documentation/CodingGuidelines

@ -35,6 +35,13 @@ For shell scripts specifically (not exhaustive): @@ -35,6 +35,13 @@ For shell scripts specifically (not exhaustive):

- Case arms are indented at the same depth as case and esac lines.

- Redirection operators should be written with space before, but no
space after them. In other words, write 'echo test >"$file"'
instead of 'echo test> $file' or 'echo test > $file'. Note that
even though it is not required by POSIX to double-quote the
redirection target in a variable (as shown above), our code does so
because some versions of bash issue a warning without the quotes.

- We prefer $( ... ) for command substitution; unlike ``, it
properly nests. It should have been the way Bourne spelled
it from day one, but unfortunately isn't.

Loading…
Cancel
Save