Skip to content

Commit 4a68748

Browse files
jacob-kellergitster
authored andcommitted
doc: add documentation for OPT_STRING_LIST
Commit c8ba163 ("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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 454cb6b commit 4a68748

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Documentation/technical/api-parse-options.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,11 @@ There are some macros to easily define options:
168168
Introduce an option with string argument.
169169
The string argument is put into `str_var`.
170170

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+
171176
`OPT_INTEGER(short, long, &int_var, description)`::
172177
Introduce an option with integer argument.
173178
The integer is put into `int_var`.

0 commit comments

Comments
 (0)