doc: add documentation for OPT_STRING_LIST

Commit c8ba163916 ("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>
This commit is contained in:
Jacob Keller 2017-01-18 15:06:04 -08:00 коммит произвёл Junio C Hamano
Родитель 454cb6bd52
Коммит 4a68748893
1 изменённых файлов: 5 добавлений и 0 удалений

Просмотреть файл

@ -168,6 +168,11 @@ There are some macros to easily define options:
Introduce an option with string argument. Introduce an option with string argument.
The string argument is put into `str_var`. 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)`:: `OPT_INTEGER(short, long, &int_var, description)`::
Introduce an option with integer argument. Introduce an option with integer argument.
The integer is put into `int_var`. The integer is put into `int_var`.