Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
Re: [PATCH 12/16] _git: correct some "undocumented" options
- X-seq: zsh-workers 31619
- From: m0viefreak <m0viefreak.cm@xxxxxxxxxxxxxx>
- To: Nikolai Weibull <now@xxxxxxx>
- Subject: Re: [PATCH 12/16] _git: correct some "undocumented" options
- Date: Tue, 30 Jul 2013 18:06:29 +0200
- Cc: Øystein Walle <oystwa@xxxxxxxxx>, zsh-workers@xxxxxxx
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=20120113; h=message-id:date:from:user-agent:mime-version:to:cc:subject :references:in-reply-to:content-type:content-transfer-encoding; bh=ewAXU2txVBdvKFX7GoUdVXW/GIeX1kACLMKfEntjvSk=; b=Z1nr7DGl873OYTSXMxhjxbGciaEHX3wKEBNbm2XSN5OCgU8jD0/2OWdejqlAEvIb06 OfJkkRLHowkgLU32XHZ1QpqKPohQE/lQ2dMClCjUFUbg0CsqvdHTk7KwwL5BmZCiTM3T 4xZ8lV2oee2xMYl7VrcMLUfyvSNP+0HJXAFGGLvMoDU2zeGRjn0toZSGcPwEbjb4zhpP DTfojeT0rpkzfcv+Mpqs7t0Sw1GPup/zWWqLF/56DDhjqfrF1z4tweZFlXIrYgIbPcPB hY+QAzSu1OntY2ete77JwlUX8Ma+RL4ELh8yMQY9hws3Lp/DlLo7F0TbKmtEOECT1lhU ZLeA==
- In-reply-to: <CADdV=Mui9vRNd1sRJGgWRShSvVvGy4rkDnTKjV5QNJewPMEYbw@mail.gmail.com>
- List-help: <mailto:zsh-workers-help@zsh.org>
- List-id: Zsh Workers List <zsh-workers.zsh.org>
- List-post: <mailto:zsh-workers@zsh.org>
- Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm
- References: <cover.1375006129.git.oystwa@gmail.com> <a0d5c7e0f313ee20133dd18f68e86eceb4c9d137.1375006129.git.oystwa@gmail.com> <CADdV=Mui9vRNd1sRJGgWRShSvVvGy4rkDnTKjV5QNJewPMEYbw@mail.gmail.com>
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