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 <jacob.keller@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jacob Keller committed
Jan 18, 2017 at 15:06 UTC
4a68748893e62d66ebab1591f6da91eeb18d08e9
1 file changed
+5
Documentation/technical/api-parse-options.txt
+5
@@ -168,6 +168,11 @@ There are some macros to easily define options:
168
Introduce an option with string argument.
169
The string argument is put into `str_var`.
170
171
+`OPT_STRING_LIST(short, long, &struct string_list, arg_str, description)`::
172
+ Introduce an option with string argument.
173
+ The string argument is stored as an element in `string_list`.
174
+ Use of `--no-option` will clear the list of preceding values.
175
+
176
`OPT_INTEGER(short, long, &int_var, description)`::
177
Introduce an option with integer argument.
178
The integer is put into `int_var`.