From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <zsh-workers-return-31619-mason-zsh=primenet.com.au@zsh.org>
Received: (qmail 26734 invoked by alias); 30 Jul 2013 16:06:45 -0000
Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm
Precedence: bulk
X-No-Archive: yes
List-Id: Zsh Workers List <zsh-workers.zsh.org>
List-Post: <mailto:zsh-workers@zsh.org>
List-Help: <mailto:zsh-workers-help@zsh.org>
X-Seq: 31619
Received: (qmail 23611 invoked from network); 30 Jul 2013 16:06:40 -0000
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on f.primenet.com.au
X-Spam-Level: 
X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW autolearn=ham
	version=3.3.2
Received-SPF: pass (ns1.primenet.com.au: SPF record at _netblocks.google.com designates 209.85.212.66 as permitted sender)
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==
X-Received: by 10.52.35.171 with SMTP id i11mr8094367vdj.4.1375200393404;
        Tue, 30 Jul 2013 09:06:33 -0700 (PDT)
Message-ID: <51F7E485.6050701@googlemail.com>
Date: Tue, 30 Jul 2013 18:06:29 +0200
From: m0viefreak <m0viefreak.cm@googlemail.com>
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:17.0) Gecko/20130620 Thunderbird/17.0.7
MIME-Version: 1.0
To: Nikolai Weibull <now@disu.se>
CC: =?UTF-8?B?w5h5c3RlaW4gV2FsbGU=?= <oystwa@gmail.com>, 
 zsh-workers@zsh.org
Subject: Re: [PATCH 12/16] _git: correct some "undocumented" options
References: <cover.1375006129.git.oystwa@gmail.com> <a0d5c7e0f313ee20133dd18f68e86eceb4c9d137.1375006129.git.oystwa@gmail.com> <CADdV=Mui9vRNd1sRJGgWRShSvVvGy4rkDnTKjV5QNJewPMEYbw@mail.gmail.com>
In-Reply-To: <CADdV=Mui9vRNd1sRJGgWRShSvVvGy4rkDnTKjV5QNJewPMEYbw@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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?