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>

diff --git a/Documentation/technical/api-parse-options.txt b/Documentation/technical/api-parse-options.txt
index 969489bbe52c66073e9b9ab32dfb09b7e7c41b9e..00c447c74c7d5df85b0521f2fc90b12470a5950f 100644 (file)
--- 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)`::

diff --git a/builtin/add.c b/builtin/add.c
index fbf14035c32ce7eaf0659ff5dee73f7e6b54e8bb..9625ceeb5bb6c6e7c8c37ea505ab7d8a9511ef9d 100644 (file)
--- a/builtin/add.c
+++ b/builtin/add.c
@@ -313,7 +313,7 @@ static int verbose = 0, show_only = 0, ignored_too = 0, refresh_only = 0;
 static int ignore_add_errors, addremove, intent_to_add, ignore_missing = 0;
 
 static struct option builtin_add_options[] = {
-       OPT__DRY_RUN(&show_only),
+       OPT__DRY_RUN(&show_only, "dry run"),
        OPT__VERBOSE(&verbose, "be verbose"),
        OPT_GROUP(""),
        OPT_BOOLEAN('i', "interactive", &add_interactive, "interactive picking"),

diff --git a/builtin/clean.c b/builtin/clean.c
index c8798f549ed12192a098ab90b35c0437b8059351..17ecbe6eea5139c4a10cece3b4798ea188ac159e 100644 (file)
--- a/builtin/clean.c
+++ b/builtin/clean.c
@@ -49,7 +49,7 @@ int cmd_clean(int argc, const char **argv, const char *prefix)
        char *seen = NULL;
        struct option options[] = {
                OPT__QUIET(&quiet),
-               OPT__DRY_RUN(&show_only),
+               OPT__DRY_RUN(&show_only, "dry run"),
                OPT_BOOLEAN('f', "force", &force, "force"),
                OPT_BOOLEAN('d', NULL, &remove_directories,
                                "remove whole directories"),

diff --git a/builtin/mv.c b/builtin/mv.c
index cdbb09473c0c45efff23a63e78b7623cad523350..8677bd2e40d98de1ce6cf727119176dc26357fed 100644 (file)
--- a/builtin/mv.c
+++ b/builtin/mv.c
@@ -55,7 +55,7 @@ int cmd_mv(int argc, const char **argv, const char *prefix)
        int i, newfd;
        int verbose = 0, show_only = 0, force = 0, ignore_errors = 0;
        struct option builtin_mv_options[] = {
-               OPT__DRY_RUN(&show_only),
+               OPT__DRY_RUN(&show_only, "dry run"),
                OPT_BOOLEAN('f', "force", &force, "force move/rename even if target exists"),
                OPT_BOOLEAN('k', NULL, &ignore_errors, "skip move/rename errors"),
                OPT_END(),

diff --git a/builtin/notes.c b/builtin/notes.c
index e0a1f62fc9eb0ee6a1943e7a3438e1077a666cb9..2ab070fa09dd1dfb253ae48d867d4c06699e40c3 100644 (file)
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -804,8 +804,7 @@ static int prune(int argc, const char **argv, const char *prefix)
        struct notes_tree *t;
        int show_only = 0, verbose = 0;
        struct option options[] = {
-               OPT_BOOLEAN('n', "dry-run", &show_only,
-                           "do not remove, show only"),
+               OPT__DRY_RUN(&show_only, "do not remove, show only"),
                OPT__VERBOSE(&verbose, "report pruned notes"),
                OPT_END()
        };

diff --git a/builtin/prune.c b/builtin/prune.c
index 8b770affff34d816a9fc4fe02b60787cb3d7675a..e65690ba370511072dfa1e64838eef5e5686aac9 100644 (file)
--- a/builtin/prune.c
+++ b/builtin/prune.c
@@ -125,8 +125,7 @@ int cmd_prune(int argc, const char **argv, const char *prefix)
 {
        struct rev_info revs;
        const struct option options[] = {
-               OPT_BOOLEAN('n', "dry-run", &show_only,
-                           "do not remove, show only"),
+               OPT__DRY_RUN(&show_only, "do not remove, show only"),
                OPT__VERBOSE(&verbose, "report pruned objects"),
                OPT_DATE(0, "expire", &expire,
                         "expire objects older than <time>"),

diff --git a/builtin/remote.c b/builtin/remote.c
index b944b91056b7b2bce00844e0c9575f83f8f97b42..30b992275a694562edd40b734cfdef06add145c4 100644 (file)
--- a/builtin/remote.c
+++ b/builtin/remote.c
@@ -1200,7 +1200,7 @@ static int prune(int argc, const char **argv)
 {
        int dry_run = 0, result = 0;
        struct option options[] = {
-               OPT__DRY_RUN(&dry_run),
+               OPT__DRY_RUN(&dry_run, "dry run"),
                OPT_END()
        };
 

diff --git a/builtin/rm.c b/builtin/rm.c
index f3772c84de0a1f1a18123e55ae6e6983739f590b..26b7412aaa2d365d4e28093f1cb8e2343e3c6135 100644 (file)
--- a/builtin/rm.c
+++ b/builtin/rm.c
@@ -139,7 +139,7 @@ static int show_only = 0, force = 0, index_only = 0, recursive = 0, quiet = 0;
 static int ignore_unmatch = 0;
 
 static struct option builtin_rm_options[] = {
-       OPT__DRY_RUN(&show_only),
+       OPT__DRY_RUN(&show_only, "dry run"),
        OPT__QUIET(&quiet),
        OPT_BOOLEAN( 0 , "cached",         &index_only, "only remove from the index"),
        OPT_BOOLEAN('f', "force",          &force,      "override the up-to-date check"),

diff --git a/parse-options.h b/parse-options.h
index 14918b16e5e904581032a92466468c15a3639417..69ce09415890ca38330a3e98b15d2c3d61b2fa6d 100644 (file)
--- a/parse-options.h
+++ b/parse-options.h
@@ -205,7 +205,7 @@ extern int parse_opt_tertiary(const struct option *, const char *, int);
          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }, \
        { OPTION_CALLBACK, 'q', "quiet", (var), NULL, "be more quiet", \
          PARSE_OPT_NOARG, &parse_opt_verbosity_cb, 0 }
-#define OPT__DRY_RUN(var)  OPT_BOOLEAN('n', "dry-run", (var), "dry run")
+#define OPT__DRY_RUN(var, h)  OPT_BOOLEAN('n', "dry-run", (var), (h))
 #define OPT__ABBREV(var)  \
        { OPTION_CALLBACK, 0, "abbrev", (var), "n", \
          "use <n> digits to display SHA-1s", \

diff --git a/test-parse-options.c b/test-parse-options.c
index bd7b8a4ea809a56ccb0240d00043fea7acbd5884..cddd10643f3bc6362dd8a40637b432f94d81999a 100644 (file)
--- a/test-parse-options.c
+++ b/test-parse-options.c
@@ -67,7 +67,7 @@ int main(int argc, const char **argv)
                OPT_GROUP("Standard options"),
                OPT__ABBREV(&abbrev),
                OPT__VERBOSE(&verbose, "be verbose"),
-               OPT__DRY_RUN(&dry_run),
+               OPT__DRY_RUN(&dry_run, "dry run"),
                OPT__QUIET(&quiet),
                OPT_END(),
        };