From: Junio C Hamano <gitster@pobox•com>
To: Jacob Keller <jacob.e.keller@intel•com>
Cc: git@vger•kernel.org, Johannes Sixt <j6t@kdbg•org>,
Johannes Schindelin <johannes.schindelin@gmx•de>,
Jacob Keller <jacob.keller@gmail•com>
Subject: Re: [PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST
Date: Wed, 18 Jan 2017 11:45:55 -0800 [thread overview]
Message-ID: <xmqq37gg9moc.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170118000930.5431-2-jacob.e.keller@intel.com> (Jacob Keller's message of "Tue, 17 Jan 2017 16:09:26 -0800")
Jacob Keller <jacob.e.keller@intel•com> writes:
> From: Jacob Keller <jacob.keller@gmail•com>
>
> Commit c8ba16391655 ("parse-options: add OPT_STRING_LIST helper",
> 2011-06-09) added the OPT_STRING_LIST as a way to accumulate a repeated
> list of strings. However, this was not documented in the
> api-parse-options documentation. Add documentation now so that future
> developers may learn of its existence.
>
> Signed-off-by: Jacob Keller <jacob.keller@gmail•com>
> ---
> Documentation/technical/api-parse-options.txt | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
> index 27bd701c0d68..6914f54f5f44 100644
> --- a/Documentation/technical/api-parse-options.txt
> +++ b/Documentation/technical/api-parse-options.txt
> @@ -168,6 +168,11 @@ There are some macros to easily define options:
> Introduce an option with string argument.
> The string argument is put into `str_var`.
>
> +`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.
The "Reset the list" is an instruction to the end-users who interact
with a program written by readers of this document using
OPT_STRING_LIST(), and it feels a bit out of place. Perhaps
End users can reset the list by negating the option,
i.e. passing "--no-<long>", on the command line.
I dunno.
Anyway, thanks for adding a missing doc here.
> `OPT_INTEGER(short, long, &int_var, description)`::
> Introduce an option with integer argument.
> The integer is put into `int_var`.
next prev parent reply other threads:[~2017-01-18 19:46 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 [this message]
2017-01-18 20:08 ` Philip Oakley
2017-01-18 20:58 ` Junio C Hamano
2017-01-19 16:55 ` Johannes Schindelin
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq37gg9moc.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=j6t@kdbg$(echo .)org \
--cc=jacob.e.keller@intel$(echo .)com \
--cc=jacob.keller@gmail$(echo .)com \
--cc=johannes.schindelin@gmx$(echo .)de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox