From: Ramsay Jones <ramsay@ramsayjones.plus.com>
Date: Tue, 26 Apr 2016 19:11:14 GMT
Subject: Re: [PATCH] config doc: improve exit code listing
Message-ID: <571FBD52.4040206@ramsayjones.plus.com>
In-Reply-To: <20160426181058.7901-1-sbeller@google.com>



On 26/04/16 19:10, Stefan Beller wrote:
> The possible reasons for exiting are now ordered by the exit code value.
> While at it, rewrite the `can not write to the config file` to
> `the config file cannot be written` to be grammatically correct and a
> proper sentence.
> 
> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>  Documentation/git-config.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> index 6fc08e3..6843114 100644
> --- a/Documentation/git-config.txt
> +++ b/Documentation/git-config.txt
> @@ -58,10 +58,10 @@ that location (you can say '--local' but that is the default).
>  This command will fail with non-zero status upon error.  Some exit
>  codes are:
>  
> -- The config file is invalid (ret=3),
     ^
I don't see why this is capitalised, so ...

> -- can not write to the config file (ret=4),
> +- The section or key is invalid (ret=1),
     ^
I don't think you should transfer the capital here. ;-)

>  - no section or name was provided (ret=2),
> -- the section or key is invalid (ret=1),
> +- the config file is invalid (ret=3),
> +- the config file cannot be written (ret=4),
>  - you try to unset an option which does not exist (ret=5),
>  - you try to unset/set an option for which multiple lines match (ret=5), or
>  - you try to use an invalid regexp (ret=6).
> 

Only a minor point.

ATB,
Ramsay Jones