diff options
| author |  Jacob Keller <jacob.keller@gmail.com> | 2017-01-18 15:06:04 -0800 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-01-19 13:10:09 -0800 |
| commit | 4a68748893e62d66ebab1591f6da91eeb18d08e9 (patch) | |
| tree | 44944dd8f49816823c43bfa4e073046c3b3239ff /Documentation/technical | |
| parent | Git 2.11 (diff) | |
| download | tgif-4a68748893e62d66ebab1591f6da91eeb18d08e9.tar.xz | |
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>
Diffstat (limited to 'Documentation/technical')
| -rw-r--r-- | Documentation/technical/api-parse-options.txt | 5 |
1 files changed, 5 insertions, 0 deletions
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`. |