diff options
| author |  Tim Henigan <tim.henigan@gmail.com> | 2012-02-24 18:12:57 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2012-02-27 12:41:13 -0800 |
| commit | 48f359bfafa7db4c399fa13f17ccfea7c35f333b (patch) | |
| tree | 235f3de55b49bcd5d681de7efa835fe916e4abc7 /Documentation | |
| parent | post-receive-email: match up $LOGBEGIN..$LOGEND pairs correctly (diff) | |
| download | tgif-48f359bfafa7db4c399fa13f17ccfea7c35f333b.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 483008699f..cfe3785909 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -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. |