diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-02-27 15:37:02 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-02-27 15:37:02 -0800 |
| commit | 25a7850a106ed0f27b88b8ce0b89fd326120dff4 (patch) | |
| tree | a9928a82c3a2f58018e80426d3a45d956590ef40 /Documentation/CodingGuidelines | |
| parent | git-p4: missing she-bang line in t9804 confuses prove (diff) | |
| parent | Update draft release notes to 1.7.9.3 (diff) | |
| download | git-25a7850a106ed0f27b88b8ce0b89fd326120dff4.tar.gz git-25a7850a106ed0f27b88b8ce0b89fd326120dff4.zip | |
Merge branch 'maint'
* maint:
Update draft release notes to 1.7.9.3
CodingGuidelines: do not use 'which' in shell scripts
CodingGuidelines: Add a note about spaces after redirection
post-receive-email: match up $LOGBEGIN..$LOGEND pairs correctly
post-receive-email: remove unused variable
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 483008699f..45577117c2 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -35,10 +35,22 @@ 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. + - If you want to find out if a command is available on the user's + $PATH, you should use 'type <command>', instead of 'which <command>'. + The output of 'which' is not machine parseable and its exit code + is not reliable across platforms. + - We use POSIX compliant parameter substitutions and avoid bashisms; namely: |