undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

api-parse-options.txt: document OPT_CMDMODE()

Browse Source 
OPT_CMDMODE mechanism was introduced in the release of 1.8.5 to actively
notice when multiple "operation mode" options that specify mutually
incompatible operation modes are given.

Signed-off-by: Pranit Bauva <pranit.bauva@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Pranit Bauva 2016-03-25 18:58:58 +00:00 committed by Junio C Hamano
parent e46579643d
commit c3f6b853bf
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/technical/api-parse-options.txt
View File

@ -231,6 +231,13 @@ There are some macros to easily define options:
pass the command-line option, which can be specified multiple times, pass the command-line option, which can be specified multiple times,
to another command. to another command.
`OPT_CMDMODE(short, long, &int_var, description, enum_val)`::
Define an "operation mode" option, only one of which in the same
group of "operating mode" options that share the same `int_var`
can be given by the user. `enum_val` is set to `int_var` when the
option is used, but an error is reported if other "operating mode"
option has already set its value to the same `int_var`.
The last element of the array must be `OPT_END()`. The last element of the array must be `OPT_END()`.