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

Merge branch 'pb/opt-cmdmode-doc' into maint

Browse Source 
Minor API documentation update.

* pb/opt-cmdmode-doc:
  api-parse-options.txt: document OPT_CMDMODE()
This commit is contained in:
Junio C Hamano 2016-04-14 18:37:13 -07:00
commit 48adfa18bc
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,
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()`.