From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Junio C Hamano <gitster@pobox.com>
Cc: Philip Oakley <philipoakley@iee.org>,
Jacob Keller <jacob.e.keller@intel.com>,
git@vger.kernel.org, Johannes Sixt <j6t@kdbg.org>,
Jacob Keller <jacob.keller@gmail.com>
Subject: Re: [PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST
Date: Thu, 19 Jan 2017 17:55:22 +0100 (CET) [thread overview]
Message-ID: <alpine.DEB.2.20.1701191749340.3469@virtualbox> (raw)
In-Reply-To: <xmqqr3403x1r.fsf@gitster.mtv.corp.google.com>
Hi Junio,
On Wed, 18 Jan 2017, Junio C Hamano wrote:
> "Philip Oakley" <philipoakley@iee.org> writes:
>
> >>> +`OPT_STRING_LIST(short, long, &list, arg_str, description)`::
> >>> + Introduce an option with string argument.
> >>> + The string argument is stored as an element in `&list` which must be a
> >>> + struct string_list. Reset the list using `--no-option`.
> >>> +
> >>
> >> I do not know if it is clear enough that 'option' in the last
> >> sentence is a placeholder. I then wondered if spelling it as
> >> `--no-<long>` would make it a bit clearer, but that is ugly.
> >
> > Bikeshedding:: `--no-<option>` maybe, i.e. just surround the option
> > word with the angle brackets to indicate it is to be replaced by the
> > real option's name.
>
> Yeah, I bikeshedded that myself, and rejected it because there is no
> <option> mentioned anywhere in the enumeration header.
As I pointed out in a previous review round: the surrounding test uses
--no-option (I agree that it is tedious to go back to the original code
for review, rather than a mere patch review that lacks context, but I
suspected that Jake did not come up with that `--no-option` himself), so
by our own recommendation (imitate the surrounding, existing code/text)
Jake did exactly the right thing:
$ git grep -e --no-option upstream/master -- Documentation/technical/api-parse-options.txt
upstream/master:Documentation/technical/api-parse-options.txt: `--option` and set to zero with `--no-option`.
upstream/master:Documentation/technical/api-parse-options.txt: (even if initially negative), and `--no-option` resets it to
upstream/master:Documentation/technical/api-parse-options.txt: zero. To determine if `--option` or `--no-option` was encountered at
upstream/master:Documentation/technical/api-parse-options.txt: `--no-option` was seen.
upstream/master:Documentation/technical/api-parse-options.txt: reset to zero with `--no-option`.
Ciao,
Johannes
next prev parent reply other threads:[~2017-01-19 16:56 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-18 0:09 [PATCH v3 0/5] extend git-describe pattern matching Jacob Keller
2017-01-18 0:09 ` [PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST Jacob Keller
2017-01-18 19:45 ` Junio C Hamano
2017-01-18 20:08 ` Philip Oakley
2017-01-18 20:58 ` Junio C Hamano
2017-01-19 16:55 ` Johannes Schindelin [this message]
2017-01-18 21:10 ` Jacob Keller
2017-01-19 17:58 ` Junio C Hamano
2017-01-18 0:09 ` [PATCH v3 2/5] name-rev: extend --refs to accept multiple patterns Jacob Keller
2017-01-18 20:04 ` Junio C Hamano
2017-01-18 21:12 ` Jacob Keller
2017-01-18 22:42 ` Junio C Hamano
2017-01-18 0:09 ` [PATCH v3 3/5] name-rev: add support to exclude refs by pattern match Jacob Keller
2017-01-18 20:11 ` Junio C Hamano
2017-01-18 21:13 ` Jacob Keller
2017-01-18 21:56 ` Junio C Hamano
2017-01-18 22:31 ` Jacob Keller
2017-01-18 0:09 ` [PATCH v3 4/5] describe: teach --match to accept multiple patterns Jacob Keller
2017-01-18 0:09 ` [PATCH v3 5/5] describe: teach describe negative pattern matches Jacob Keller
2017-01-18 20:17 ` Junio C Hamano
2017-01-18 20:18 ` [PATCH v3 0/5] extend git-describe pattern matching Junio C Hamano
2017-01-18 21:06 ` Jacob Keller
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.DEB.2.20.1701191749340.3469@virtualbox \
--to=johannes.schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=j6t@kdbg.org \
--cc=jacob.e.keller@intel.com \
--cc=jacob.keller@gmail.com \
--cc=philipoakley@iee.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://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).