threads / patch / 42149

patchconfig doc: improve exit code listing

Subject: [PATCH] config doc: improve exit code listing

## tl;dr

5 messages between Apr 26, 2016 and Apr 26, 2016. Diffs are folded; open one to read it.

replies: 4people: 3as markdown or json

Stefan Beller· Apr 26, 2016, 18:10 UTC · lore

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(-)
Show changes to Documentation/git-config.txt +3 −3
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),
-- can not write to the config file (ret=4),
+- The section or key is invalid (ret=1),
 - 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).

-- 
2.8.1.343.gb96d81e

base-commit: 3ad15fd5e17bbb73fb1161ff4e9c3ed254d5b243
Ramsay Jones· Apr 26, 2016, 19:11 UTC · re: Stefan Beller · lore

Re: [PATCH] config doc: improve exit code listing

On 26/04/16 19:10, Stefan Beller wrote:
Show 19 quoted lines
> 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. ;-)
Show 8 quoted lines
>  - 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

Stefan Beller· Apr 26, 2016, 19:18 UTC · re: Ramsay Jones · lore

Re: [PATCH] config doc: improve exit code listing

On Tue, Apr 26, 2016 at 12:11 PM, Ramsay Jones <ramsay@ramsayjones.plus.com> wrote:

Show 24 quoted lines
>
>
> 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 ...

Because the whole listing is a bunch of sentences, stringed together with commas at the end of each line. Note that there is a ',' at the end of each line, except for the last, where you see a '.'. I thought about breaking that up into a list and make all of the bullet points either a sentence (all capitalised and ending in dot) or part sentences (lower case for each bullet point, not clear about the ending)

I kept it as is in a long sentence as I expected to see lowest resistance there. ;)

Show 5 quoted lines
>
>> -- 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. ;-)
It's the first bullet point starting the long sentence.
Show 11 quoted lines
>
>>  - 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.

If the current state bothers you too much, please send a patch with correct lists. :) (Feel free to squash this patch into that or just on top of this)

Thanks, Stefan

Show 5 quoted lines
>
> ATB,
> Ramsay Jones
>
>
Ramsay Jones· Apr 26, 2016, 19:41 UTC · re: Stefan Beller · lore

Re: [PATCH] config doc: improve exit code listing

On 26/04/16 20:18, Stefan Beller wrote:
Show 31 quoted lines
> On Tue, Apr 26, 2016 at 12:11 PM, Ramsay Jones
> <ramsay@ramsayjones.plus.com> wrote:
>>
>>
>> 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 ...
> 
> Because the whole listing is a bunch of sentences,
> stringed together with commas at the end of each line.
> Note that there is a ',' at the end of each line, except for
> the last, where you see a '.'.
Heh, I hadn't noticed the commas, no - I assumed periods.
>                                 I thought about breaking that
> up into a list and make all of the bullet points either a sentence
> (all capitalised and ending in dot) or part sentences (lower
> case for each bullet point, not clear about the ending)
That's probably what I would have done.
> I kept it as is in a long sentence as I expected to see
> lowest resistance there. ;)

'One long sentence' split into a bullet/numbered list is err ... Hmm, I'm lost for words. ;-)

Show 6 quoted lines
>> Only a minor point.
> 
> If the current state bothers you too much,
> please send a patch with correct lists. :)
> (Feel free to squash this patch into that or
> just on top of this)

Having said all that, (since I have very few documentation skills), I will leave this for others to improve, if necessary.

ATB, Ramsay Jones

← back to recent threads