Re: [PATCH v2 1/5] doc: add documentation for OPT_STRING_LIST

From: Philip Oakley <philipoakley@iee.org>
Date: Dec 17, 2016, 11:56 UTC
Message-ID: <67572777448E4DCE967BA079110A3487@PhilipOakley>
In-Reply-To: <20161217012431.29548-2-jacob.e.keller@intel.com>

From: "Jacob Keller" <jacob.e.keller@intel.com>

Show 23 quoted lines

> 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..92791740aa64 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)`::

should there be an extra comma between 'short long' in a similar manner to the OPT_INTEGER argument list below?

Show 11 quoted lines

> + Introduce an option with a string argument. Repeated invocations
> + accumulate into a list of strings. Reset and clear the list with
> + `--no-option`.
> +
> `OPT_INTEGER(short, long, &int_var, description)`::
>  Introduce an option with integer argument.
>  The integer is put into `int_var`.
> -- 
> 2.11.0.rc2.152.g4d04e67
>
>