Re: [PATCH 1/6] CodingGuidelines: mention whitespace preferences for shell scripts

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 30, 2010, 00:30 UTC
Message-ID: <7vy68by7om.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1291042075-19983-2-git-send-email-giuseppe.bilotta@gmail.com>

Giuseppe Bilotta <giuseppe.bilotta@gmail.com> writes:

Show 14 quoted lines

> Signed-off-by: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
> ---
>  Documentation/CodingGuidelines |    6 ++++++
>  1 files changed, 6 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 5aa2d34..7ecce51 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -31,6 +31,12 @@ But if you must have a list of rules, here they are.
>  
>  For shell scripts specifically (not exhaustive):
>  
> + - We use tabs for indentation.

Ok.

> + - The choices in case ... esac statement are not indented with respect
> +   to the the case and esac lines. The body of the choices however _is_
> +   indented (by one tab).
> +

Nit; "choices" are called "case arms".

I don't think there is any need to emphasize your surprise that case body is indented with "however _is_", which implies "against common sense or normal convention" or somesuch. The thing is, there is no single _right_ convention, and we want people to folow the one just picked---we should just describe what it is without being emotional nor emphatic.

Thanks.