diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2022-02-11 16:55:58 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-02-11 16:55:58 -0800 |
| commit | e66e9906e644ada571a6fd1e044503d292850574 (patch) | |
| tree | 81481f0fdc15706fcf195a747f613c0ab4107522 /parse-options.h | |
| parent | Merge branch 'bc/csprng-mktemps' (diff) | |
| parent | parse-options: document bracketing of argh (diff) | |
| download | tgif-e66e9906e644ada571a6fd1e044503d292850574.tar.xz | |
Merge branch 'rs/parse-options-lithelp-help'
Comment update.
* rs/parse-options-lithelp-help:
parse-options: document bracketing of argh
Diffstat (limited to 'parse-options.h')
| -rw-r--r-- | parse-options.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/parse-options.h b/parse-options.h index cbeb97b90e..659a4c28b2 100644 --- a/parse-options.h +++ b/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 * begin in capital letter, and does not end with a full stop. * 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`:: * the short help associated to what the option does. |