[PATCH v3 1/5] doc: add documentation for OPT_STRING_LIST
- From
Jacob Keller <jacob.e.keller@intel.com>
- Date
- Jan 18, 2017, 00:09 UTC
- Message-ID
- <20170118000930.5431-2-jacob.e.keller@intel.com>
- In-Reply-To
- <20170118000930.5431-1-jacob.e.keller@intel.com>
From: Jacob Keller <jacob.keller@gmail.com>
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> --- Documentation/technical/api-parse-options.txt | 5 +++++ 1 file changed, 5 insertions(+)
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index 27bd701c0d68..6914f54f5f44 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, &list, arg_str, description)`:: + Introduce an option with string argument. + The string argument is stored as an element in `&list` which must be a + struct string_list. Reset the list using `--no-option`. + `OPT_INTEGER(short, long, &int_var, description)`:: Introduce an option with integer argument. The integer is put into `int_var`.
-- 2.11.0.403.g196674b8396b