[PATCH] api-parse-options.txt: document OPT_CMDMODE()
From: Pranit Bauva <hidden>
Date: 2016-06-15 23:08:55
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
OPT_CMDMODE() was introduced in the release of 1.8.5 which makes the use of subcommands in the form of arguments a lot cleaner and easier. --- Documentation/technical/api-parse-options.txt | 6 ++++++ 1 file changed, 6 insertions(+)
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 5f0757d..8130d26 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt@@ -231,6 +231,12 @@ 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)`:: + Introduce an option for subcommands. It is useful when you want to use + the command with a particular sub command only and ignore other sub + commands it has. It will set `int_var` to enum_val if the argument is + invoked. + The last element of the array must be `OPT_END()`. --
https://github.com/git/git/pull/219