summaryrefslogtreecommitdiff
path: root/Documentation/technical
diff options
context:
space:
mode:
authorRené Scharfe <rene.scharfe@lsrfire.ath.cx>2010-11-08 18:58:51 +0100
committerJunio C Hamano <gitster@pobox.com>2010-11-15 09:57:37 -0800
commite21adb8c100cd2859cff1d74f7d0e622ac640085 (patch)
tree0dc6a3b9858d1c472ad153430950b0c638b2cc3e /Documentation/technical
parentfd03881a48fc31197ab3343ac2f02ed0cdbbbaaf (diff)
downloadgit-e21adb8c100cd2859cff1d74f7d0e622ac640085.tar.gz
add description parameter to OPT__DRY_RUN
Allows better help text to be defined than "dry run". Also make use of the macro in places that already had a different description. No object code changes intended. Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical')
-rw-r--r--Documentation/technical/api-parse-options.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 969489bbe5..00c447c74c 100644
--- a/Documentation/technical/api-parse-options.txt
+++ b/Documentation/technical/api-parse-options.txt
@@ -118,7 +118,7 @@ There are some macros to easily define options:
`OPT__COLOR(&int_var, description)`::
Add `\--color[=<when>]` and `--no-color`.
-`OPT__DRY_RUN(&int_var)`::
+`OPT__DRY_RUN(&int_var, description)`::
Add `-n, \--dry-run`.
`OPT__QUIET(&int_var)`::