doc: add documentation for OPT_STRING_LIST
authorJacob Keller <jacob.keller@gmail.com>
Wed, 18 Jan 2017 23:06:04 +0000 (15:06 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 19 Jan 2017 21:10:09 +0000 (13:10 -0800)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-parse-options.txt
index 27bd701c0d6862f38c700fbfc02c24b135bd6c0e..36768b479e16c9456982230f078d98513a72c37f 100644 (file)
@@ -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`.