Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: [PATCH 12/16] _git: correct some "undocumented" options



On 30.07.2013 16:39, Nikolai Weibull wrote:
> On Sun, Jul 28, 2013 at 6:22 PM, Øystein Walle <oystwa@xxxxxxxxx> wrote:
>> From: m0viefreak <m0viefreak.cm@xxxxxxxxxxxxxx>
>>
>> diff options:
>>   --cumulative is deprecated --> remove
>>   --follow was already in there --> remove duplicate
>>   -G / -S: reword -S to emphase the difference to -G
>>
>> revision options:
>>   --abbrev: reword, to emphase the --abbrev-commit requirement
> 
>> -  # TODO: --diff3 is undocumented.
> 
>> -  # TODO: --mirror is undocumented.
> 
>> -    # TODO: --cumulative is undocumented.
>> -    '--cumulative[undocumented]'
>> -    # TODO: --follow is undocumented.
>> -    '--follow[undocumented]'
>> -    # TODO: --textconv is undocumented.
>> -    '--textconv[undocumented]'
>> -    # TODO: --no-textconv is undocumented.
>> -    '--no-textconv[undocumented]'
>> -    # TODO: -G is undocumented.
>> -    '-G[undocumented]'
>> -    # TODO: --no-abbrev is undocumented.
>> -    '--no-abbrev[undocumented]'
> 
> Again, # TODO: undocumented means that Git’s documentation doesn’t
> document the option.  Please double-check that all these options have
> been added to the documentation and, if not, send them patches as
> well.
> 

Right. I agree that this is not consistent among the patches.

For some we did it right and put in help texts for _git completion while
keeping the "TODO: undocumented" lines.

For some we removed those lines.



So what's the best way to go forward?
Should a [PATCH 17] be added and re-insert those
# TODO:
comments for options that are still missing in the git docs?



Messages sorted by: Reverse Date, Date, Thread, Author