diff options
| author | Stephen Boyd <bebarino@gmail.com> | 2009-05-21 00:33:17 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-05-22 22:46:04 -0700 |
| commit | 29f25d493c1021a53acf41e5763e732217dd75c3 (patch) | |
| tree | bd8cd30ac668fc61db313ce920dd2f3e5658079b /parse-options.h | |
| parent | 5acb3e5012966cc11e54f50e0592b3639bade02c (diff) | |
| download | git-29f25d493c1021a53acf41e5763e732217dd75c3.tar.gz | |
parse-options: add PARSE_OPT_LITERAL_ARGHELP for complicated argh's
Usually, the argh element in struct option points at a placeholder value
(e.g. "val"), and is shown in the usage message as
--option=<val>
by enclosing the string inside of angle brackets.
When the option is more complex (e.g. optional arguments separated by a
comma), you would want to produce a usage message that looks like
--option=<val1>[,<val2>]
In such a case, the caller can pass a string to argh with placeholders
already enclosed in necessary angle brackets (e.g. "<val1>[,<val2>]")
and set this flag.
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'parse-options.h')
| -rw-r--r-- | parse-options.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/parse-options.h b/parse-options.h index b54eec128b..910aa1e9f1 100644 --- a/parse-options.h +++ b/parse-options.h @@ -31,6 +31,7 @@ enum parse_opt_option_flags { PARSE_OPT_NONEG = 4, PARSE_OPT_HIDDEN = 8, PARSE_OPT_LASTARG_DEFAULT = 16, + PARSE_OPT_LITERAL_ARGHELP = 64, }; struct option; @@ -66,6 +67,9 @@ typedef int parse_opt_cb(const struct option *, const char *arg, int unset); * PARSE_OPT_NONEG: says that this option cannot be negated * PARSE_OPT_HIDDEN this option is skipped in the default usage, showed in * the long one. + * PARSE_OPT_LITERAL_ARGHELP: says that argh shouldn't be enclosed in brackets + * (i.e. '<argh>') in the help message. + * Useful for options with multiple parameters. * * `callback`:: * pointer to the callback to use for OPTION_CALLBACK. |