parse-options: document bracketing of argh
Signed-off-by: René Scharfe <l.s.r@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
René Scharfe committed
Jan 20, 2022 at 11:30 UTC
518e15db742ee58e73d486251c67218c6a0fa4f5
1 file changed
+5
parse-options.h
+5
@@ -85,6 +85,11 @@ typedef enum parse_opt_result parse_opt_ll_cb(struct parse_opt_ctx_t *ctx,
85
* token to explain the kind of argument this option wants. Does not
86
* begin in capital letter, and does not end with a full stop.
87
* 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.
93
*
94
* `help`::
95
* the short help associated to what the option does.