summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorTim Henigan <tim.henigan@gmail.com>2012-02-24 23:12:57 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-02-27 20:41:13 (GMT)
commit48f359bfafa7db4c399fa13f17ccfea7c35f333b (patch)
tree235f3de55b49bcd5d681de7efa835fe916e4abc7 /Documentation/CodingGuidelines
parent64baa4153b836646ecf6885482f4fc46e04a90db (diff)
downloadgit-48f359bfafa7db4c399fa13f17ccfea7c35f333b.zip
git-48f359bfafa7db4c399fa13f17ccfea7c35f333b.tar.gz
git-48f359bfafa7db4c399fa13f17ccfea7c35f333b.tar.bz2
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/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 4830086..cfe3785 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.