diff options
| author | René Scharfe <rene.scharfe@lsrfire.ath.cx> | 2011-09-28 19:44:30 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-09-28 12:46:21 -0700 |
| commit | 6acec0380bfcd5e3f91c9100bf4d415db8f7acfd (patch) | |
| tree | 16f376495294910ce5ab5b52415a4e8a774d5936 /Documentation | |
| parent | f858c646b5428519c4f847c5f15a9ead72a62b16 (diff) | |
| download | git-6acec0380bfcd5e3f91c9100bf4d415db8f7acfd.tar.gz | |
parseopt: add OPT_NOOP_NOARG
Add OPT_NOOP_NOARG, a helper macro to define deprecated options in a
standard way. The help text is taken from the no-op option -r of
git revert.
The callback could be made to emit a (conditional?) warning later. And
we could also add OPT_NOOP (requiring an argument) etc. as needed.
Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/technical/api-parse-options.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt index acf17607df..4b92514f60 100644 --- a/Documentation/technical/api-parse-options.txt +++ b/Documentation/technical/api-parse-options.txt @@ -204,6 +204,11 @@ There are some macros to easily define options: "auto", set `int_var` to 1 if stdout is a tty or a pager, 0 otherwise. +`OPT_NOOP_NOARG(short, long)`:: + Introduce an option that has no effect and takes no arguments. + Use it to hide deprecated options that are still to be recognized + and ignored silently. + The last element of the array must be `OPT_END()`. |