From 48f359bfafa7db4c399fa13f17ccfea7c35f333b Mon Sep 17 00:00:00 2001 From: Tim Henigan Date: Fri, 24 Feb 2012 18:12:57 -0500 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 483008699..cfe378590 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. -- 2.26.2