From: m0viefreak <m0viefreak.cm@googlemail.com>
To: Nikolai Weibull <now@disu.se>
Cc: "Øystein Walle" <oystwa@gmail.com>, zsh-workers@zsh.org
Subject: Re: [PATCH 12/16] _git: correct some "undocumented" options
Date: Tue, 30 Jul 2013 18:06:29 +0200 [thread overview]
Message-ID: <51F7E485.6050701@googlemail.com> (raw)
In-Reply-To: <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@gmail.com> wrote:
>> From: m0viefreak <m0viefreak.cm@googlemail.com>
>>
>> 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?
next prev parent reply other threads:[~2013-07-30 16:06 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-28 16:21 [PATCH 00/16] Improvements to the Git completion functions Øystein Walle
2013-07-28 16:21 ` [PATCH 01/16] _git: fix a wrong variable in __git_config_values Øystein Walle
2013-07-28 16:21 ` [PATCH 02/16] _git: fix usage of ->int: for some entries in _git-config Øystein Walle
2013-07-28 16:22 ` [PATCH 03/16] _git: make git submodule <cmd> completion work Øystein Walle
2013-07-28 16:22 ` [PATCH 04/16] _git: correctly use __git_guard_number in some cases Øystein Walle
2013-07-28 16:22 ` [PATCH 05/16] _git: completion updates to match latest git v1.8.3 Øystein Walle
2013-07-28 16:22 ` [PATCH 06/16] _git: completion updates to match latest git v1.8.3 part 2 Øystein Walle
2013-07-28 16:22 ` [PATCH 07/16] _git: add new configuration options to match latest git v1.8.3 Øystein Walle
2013-07-28 16:22 ` [PATCH 08/16] _git: reword _git-config TODO Øystein Walle
2013-07-28 16:22 ` [PATCH 09/16] _git: support completing remote branches without <remote>/ prefix Øystein Walle
2013-07-28 16:22 ` [PATCH 10/16] _git: fix some typos Øystein Walle
2013-07-28 16:22 ` [PATCH 11/16] _git: remove TODOs of actually documented options Øystein Walle
2013-07-30 14:40 ` Nikolai Weibull
2013-07-30 18:01 ` Øystein Walle
2013-07-30 20:41 ` Nikolai Weibull
2013-07-28 16:22 ` [PATCH 12/16] _git: correct some "undocumented" options Øystein Walle
2013-07-30 14:39 ` Nikolai Weibull
2013-07-30 16:06 ` m0viefreak [this message]
2013-07-30 20:45 ` Nikolai Weibull
2013-07-28 16:22 ` [PATCH 13/16] _git: change completion text for consistency Øystein Walle
2013-07-28 16:22 ` [PATCH 14/16] _git: move --(no-)follow to be log-specific option Øystein Walle
2013-07-28 16:22 ` [PATCH 15/16] _git: git rm: make git rm --cached work as intended Øystein Walle
2013-07-30 14:37 ` Nikolai Weibull
2013-07-30 15:04 ` Aaron Schrab
2013-07-30 15:47 ` Nikolai Weibull
2013-07-28 16:22 ` [PATCH 16/16] _git: Document --early-output Øystein Walle
2013-07-30 14:35 ` Nikolai Weibull
2013-07-30 16:31 ` Øystein Walle
2013-07-30 20:42 ` Nikolai Weibull
2013-07-28 17:25 ` [PATCH 00/16] Improvements to the Git completion functions Peter Stephenson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=51F7E485.6050701@googlemail.com \
--to=m0viefreak.cm@googlemail.com \
--cc=now@disu.se \
--cc=oystwa@gmail.com \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).