mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CodingGuidelines: do not use 'which' in shell scripts

Browse Source 
During the code review of a recent patch, it was noted that shell scripts
must not use 'which $cmd' to check the availability of the command $cmd.
The output of the command is not machine parseable and its exit code is
not reliable across platforms.

It is better to use 'type' to accomplish this task.

Signed-off-by: Tim Henigan <tim.henigan@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Tim Henigan
2012-02-24 18:12:58 -05:00
committed by Junio C Hamano
parent 48f359bfaf
commit 860f70f9f4
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/CodingGuidelines
View File

@ -46,6 +46,11 @@ For shell scripts specifically (not exhaustive):
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.
- 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; - We use POSIX compliant parameter substitutions and avoid bashisms;
namely: namely: