From 518e15db742ee58e73d486251c67218c6a0fa4f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Scharfe?= Date: Thu, 20 Jan 2022 11:30:15 +0100 Subject: parse-options: document bracketing of argh MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: René Scharfe Signed-off-by: Junio C Hamano --- parse-options.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/parse-options.h b/parse-options.h index 275fb44081..eebab6c7d7 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 "" to indicate that a name value + * needs to be supplied, not the literal string "name", but + * "," and "(this|that)" are printed verbatim. * * `help`:: * the short help associated to what the option does. -- cgit v1.2.3