From c3f6b853bfafa2046f2c6b0b9661d284436900b6 Mon Sep 17 00:00:00 2001 From: Pranit Bauva Date: Fri, 25 Mar 2016 18:58:58 +0000 Subject: api-parse-options.txt: document OPT_CMDMODE() 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 Signed-off-by: Junio C Hamano --- Documentation/technical/api-parse-options.txt | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Documentation/technical') diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index 5f0757dcc9..695bd4bf43 100644 --- a/Documentation/technical/api-parse-options.txt +++ b/Documentation/technical/api-parse-options.txt @@ -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()`. -- cgit v1.2.3