From: Jacob Keller Date: Wed, 18 Jan 2017 23:06:04 +0000 (-0800) Subject: doc: add documentation for OPT_STRING_LIST X-Git-Tag: v2.13.0-rc0~179^2~4 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4a68748893e62d66ebab1591f6da91eeb18d08e9;p=thirdparty%2Fgit.git doc: add documentation for OPT_STRING_LIST 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 Signed-off-by: Junio C Hamano --- diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index 27bd701c0d..36768b479e 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, &struct string_list, arg_str, description)`:: + Introduce an option with string argument. + The string argument is stored as an element in `string_list`. + Use of `--no-option` will clear the list of preceding values. + `OPT_INTEGER(short, long, &int_var, description)`:: Introduce an option with integer argument. The integer is put into `int_var`.