Skip to content

Commit e66e990

Browse files
committed
Merge branch 'rs/parse-options-lithelp-help'
Comment update. * rs/parse-options-lithelp-help: parse-options: document bracketing of argh
2 parents d073bdc + 518e15d commit e66e990

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

parse-options.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
8585
* token to explain the kind of argument this option wants. Does not
8686
* begin in capital letter, and does not end with a full stop.
8787
* Should be wrapped by N_() for translation.
88+
* Is automatically enclosed in brackets when printed, unless it
89+
* contains any of the following characters: ()<>[]|
90+
* E.g. "name" is shown as "<name>" to indicate that a name value
91+
* needs to be supplied, not the literal string "name", but
92+
* "<start>,<end>" and "(this|that)" are printed verbatim.
8893
*
8994
* `help`::
9095
* the short help associated to what the option does.

0 commit comments

Comments
 (0)