Re: [PATCH 4/8] CodingGuidelines: give an example for control statements
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Apr 30, 2014, 22:03 UTC
- Message-ID
- <xmqqwqe6cw5u.fsf@gitster.dls.corp.google.com>
- In-Reply-To
- <5361711F.1030208@gmail.com>
Stefan Beller <stefanbeller@gmail.com> writes:
Show 18 quoted lines
> On 30.04.2014 23:45, Junio C Hamano wrote: >> Signed-off-by: Junio C Hamano <gitster@pobox.com> >> --- >> Documentation/CodingGuidelines | 11 +++++++++++ >> 1 file changed, 11 insertions(+) >> >> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines >> index 1e0c4cf..d72e912 100644 >> --- a/Documentation/CodingGuidelines >> +++ b/Documentation/CodingGuidelines >> @@ -97,6 +97,17 @@ For shell scripts specifically (not exhaustive): >> "then" should be on the next line for if statements, and "do" >> should be on the next line for "while" and "for". >> >> + (incorrect) > > At the other patches you used #comments behind oneliners, > not sure if that's also suitable here for consistency of the documentation.
I think you meant this one (are there others?):
+ cat hello > world < universe # incorrect + cat hello >world <universe # correct + + echo hello >$world # incorrect + echo hello >"$world" # correct +
I can certainly go with this instead over there:
(incorrect) cat hello > world < universe echo hello >$world
(correct) cat hello >world <universe echo hello >"$world"
I do not think it is wise to use the trailing comment style on all the incorrect/correct lines for these examples.
Show 14 quoted lines
>> + if test -f hello; then >> + do this >> + fi >> + >> + (correct) >> + if test -f hello >> + then >> + do this >> + fi >> + >> - We prefer "test" over "[ ... ]". >> >> - We do not write the noiseword "function" in front of shell >>