mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-05-04 22:56:34 +02:00
Code

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>
This commit is contained in:
René Scharfe 2022-01-20 11:30:15 +01:00 committed by Junio C Hamano
parent e9d7761bb9
commit 518e15db74
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
parse-options.h
View File

@ -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.