kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

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 2012-02-24 18:12:57 -05:00 committed by Junio C Hamano
parent 64baa4153b
commit 48f359bfaf
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/CodingGuidelines
View File

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


- Case arms are indented at the same depth as case and esac lines. - 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 - We prefer $( ... ) for command substitution; unlike ``, it
properly nests. It should have been the way Bourne spelled properly nests. It should have been the way Bourne spelled
it from day one, but unfortunately isn't. it from day one, but unfortunately isn't.