From: Junio C Hamano Date: Wed, 30 Apr 2014 21:45:09 GMT Subject: [PATCH 5/8] CodingGuidelines: give an example for shell function preamble Message-ID: <1398894312-30763-6-git-send-email-gitster@pobox.com> In-Reply-To: <1398894312-30763-1-git-send-email-gitster@pobox.com> Signed-off-by: Junio C Hamano --- Documentation/CodingGuidelines | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index d72e912..1b0cd2b 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -113,9 +113,17 @@ For shell scripts specifically (not exhaustive): - We do not write the noiseword "function" in front of shell functions. - - We prefer a space between the function name and the parentheses. The - opening "{" should also be on the same line. - E.g.: my_function () { + - We prefer a space between the function name and the parentheses, + and no space inside the parentheses. The opening "{" should also + be on the same line. + + (incorrect) + my_function(){ + ... + + (correct) + my_function () { + ... - As to use of grep, stick to a subset of BRE (namely, no \{m,n\}, [::], [==], or [..]) for portability. -- 2.0.0-rc1-355-gd6d6511