mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-09 19:56:17 +02:00
Code

api-parse-options.txt: fix description of OPT_CMDMODE 

The description of the 'OPT_CMDMODE' macro states that "enum_val is
set to int_var when ...", but it's the other way around, 'int_var' is
set to 'enum_val'.  Fix this.

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
SZEDER Gábor 2022-08-19 18:03:56 +02:00 committed by Junio C Hamano
parent c1b117d31c
commit 80882bc5e7
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -236,7 +236,7 @@ There are some macros to easily define options:
`OPT_CMDMODE(short, long, &int_var, description, enum_val)`:: `OPT_CMDMODE(short, long, &int_var, description, enum_val)`::
Define an "operation mode" option, only one of which in the same Define an "operation mode" option, only one of which in the same
group of "operating mode" options that share the same `int_var` 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 can be given by the user. `int_var` is set to `enum_val` when the
option is used, but an error is reported if other "operating mode" option is used, but an error is reported if other "operating mode"
option has already set its value to the same `int_var`. option has already set its value to the same `int_var`.