From: Tim Henigan Date: Fri, 24 Feb 2012 23:12:57 GMT Subject: [PATCH v2 1/2] CodingGuidelines: Add a note about spaces after redirection Message-ID: <1330125178-9194-1-git-send-email-tim.henigan@gmail.com> 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 --- Updated to include double-quotes around redirection target and also document why they are needed. Documentation/CodingGuidelines | 10 ++++++++++ 1 files changed, 10 insertions(+), 0 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 4830086..5a190b9 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -35,6 +35,16 @@ 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. For example: + 'echo test >"$file"' is preferred over + '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 them. + - 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. -- 1.7.9.1