From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 15 Apr 2016 01:37:13 +0000 (-0700)
Subject: Merge branch 'pb/opt-cmdmode-doc' into maint
X-Git-Tag: v2.8.2~29
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/48adfa18bc5c865d72cb9a5d0f2a875d282dafb1?hp=f0acaa6b1cea3acd0b7bd137ee7b74d90f2946f5

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

Minor API documentation update.

* pb/opt-cmdmode-doc:
api-parse-options.txt: document OPT_CMDMODE()
---

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()`.