Browse Source

Merge branch 'rs/parse-options-lithelp-help'

Comment update.

* rs/parse-options-lithelp-help:
  parse-options: document bracketing of argh
maint
Junio C Hamano 3 years ago
parent
commit
e66e9906e6
  1. 5
      parse-options.h

5
parse-options.h

@ -85,6 +85,11 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
* token to explain the kind of argument this option wants. Does not * token to explain the kind of argument this option wants. Does not
* begin in capital letter, and does not end with a full stop. * begin in capital letter, and does not end with a full stop.
* Should be wrapped by N_() for translation. * Should be wrapped by N_() for translation.
* Is automatically enclosed in brackets when printed, unless it
* contains any of the following characters: ()<>[]|
* E.g. "name" is shown as "<name>" to indicate that a name value
* needs to be supplied, not the literal string "name", but
* "<start>,<end>" and "(this|that)" are printed verbatim.
* *
* `help`:: * `help`::
* the short help associated to what the option does. * the short help associated to what the option does.

Loading…
Cancel
Save