[PATCH] Usage-string fixes.

Usage string fixes to make maintenance easier (only one instance
of a string to update not multiple copies).  I've spotted and
corrected inconsistent usage text in diff-tree while doing this.

Also diff-cache and read-tree usage text have been corrected to
match their up-to-date features.  Earlier, neither "--cached"
form of diff-cache nor "-m single-merge" form of read-tree were
described.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

diff --git a/commit-tree.c b/commit-tree.c
index 043c7aa371101a1ea8cfc467279abf6c8acc7fd1..c0b07f89286c3f6cceae8122b4c3142c8efaf8e1 100644 (file)
--- a/commit-tree.c
+++ b/commit-tree.c
@@ -268,15 +268,13 @@ static void check_valid(unsigned char *sha1, const char *expect)
 }
 
 /*
 }
 
 /*

- * Having more than two parents may be strange, but hey, there's
- * no conceptual reason why the file format couldn't accept multi-way
- * merges. It might be the "union" of several packages, for example.
- *
- * I don't really expect that to happen, but this is here to make
- * it clear that _conceptually_ it's ok..
+ * Having more than two parents is not strange at all, and this is
+ * how multi-way merges are represented.

  */
 #define MAXPARENT (16)
 
  */
 #define MAXPARENT (16)
 

+static char *commit_tree_usage = "commit-tree <sha1> [-p <sha1>]* < changelog";
+

 int main(int argc, char **argv)
 {
        int i, len;
 int main(int argc, char **argv)
 {
        int i, len;


@@ -296,14 +294,14 @@ int main(int argc, char **argv)
        unsigned int size;
 
        if (argc < 2 || get_sha1_hex(argv[1], tree_sha1) < 0)
        unsigned int size;
 
        if (argc < 2 || get_sha1_hex(argv[1], tree_sha1) < 0)

-               usage("commit-tree <sha1> [-p <sha1>]* < changelog");
+               usage(commit_tree_usage);

 
        check_valid(tree_sha1, "tree");
        for (i = 2; i < argc; i += 2) {
                char *a, *b;
                a = argv[i]; b = argv[i+1];
                if (!b || strcmp(a, "-p") || get_sha1_hex(b, parent_sha1[parents]))
 
        check_valid(tree_sha1, "tree");
        for (i = 2; i < argc; i += 2) {
                char *a, *b;
                a = argv[i]; b = argv[i+1];
                if (!b || strcmp(a, "-p") || get_sha1_hex(b, parent_sha1[parents]))

-                       usage("commit-tree <sha1> [-p <sha1>]* < changelog");
+                       usage(commit_tree_usage);

                check_valid(parent_sha1[parents], "commit");
                parents++;
        }
                check_valid(parent_sha1[parents], "commit");
                parents++;
        }

diff --git a/diff-cache.c b/diff-cache.c
index 015fd5fec08a7e9b200dc8c9124e84f3a933eff4..5e1d1a6e6d83291964dca82e6969e576f6a839ec 100644 (file)
--- a/diff-cache.c
+++ b/diff-cache.c
@@ -215,6 +215,8 @@ static int diff_cache(void *tree, unsigned long size, struct cache_entry **ac, i
        return 0;
 }
 
        return 0;
 }
 

+static char *diff_cache_usage = "diff-cache [-r] [-z] [--cached] <tree sha1>";
+

 int main(int argc, char **argv)
 {
        unsigned char tree_sha1[20];
 int main(int argc, char **argv)
 {
        unsigned char tree_sha1[20];


@@ -238,11 +240,11 @@ int main(int argc, char **argv)
                        cached_only = 1;
                        continue;
                }
                        cached_only = 1;
                        continue;
                }

-               usage("diff-cache [-r] [-z] <tree sha1>");
+               usage(diff_cache_usage);

        }
 
        if (argc != 2 || get_sha1_hex(argv[1], tree_sha1))
        }
 
        if (argc != 2 || get_sha1_hex(argv[1], tree_sha1))

-               usage("diff-cache [-r] [-z] <tree sha1>");
+               usage(diff_cache_usage);

 
        tree = read_tree_with_tree_or_commit_sha1(tree_sha1, &size, 0);
        if (!tree)
 
        tree = read_tree_with_tree_or_commit_sha1(tree_sha1, &size, 0);
        if (!tree)

diff --git a/diff-tree.c b/diff-tree.c
index 222591936f8a8ada4bf40fe848ba59bcd067357e..0f370927dd2496a420af53d137676b6c3c445f75 100644 (file)
--- a/diff-tree.c
+++ b/diff-tree.c
@@ -178,6 +178,8 @@ static int diff_tree_sha1(const unsigned char *old, const unsigned char *new, co
        return retval;
 }
 
        return retval;
 }
 

+static char *diff_tree_usage = "diff-tree [-r] [-z] <tree sha1> <tree sha1>";
+

 int main(int argc, char **argv)
 {
        unsigned char old[20], new[20];
 int main(int argc, char **argv)
 {
        unsigned char old[20], new[20];


@@ -194,10 +196,10 @@ int main(int argc, char **argv)
                        line_termination = '\0';
                        continue;
                }
                        line_termination = '\0';
                        continue;
                }

-               usage("diff-tree [-r] [-z] <tree sha1> <tree sha1>");
+               usage(diff_tree_usage);

        }
 
        if (argc != 3 || get_sha1_hex(argv[1], old) || get_sha1_hex(argv[2], new))
        }
 
        if (argc != 3 || get_sha1_hex(argv[1], old) || get_sha1_hex(argv[2], new))

-               usage("diff-tree <tree sha1> <tree sha1>");
+               usage(diff_tree_usage);

        return diff_tree_sha1(old, new, "");
 }
        return diff_tree_sha1(old, new, "");
 }

diff --git a/read-tree.c b/read-tree.c
index 2773ce0cf171e9b54e9ed53bc9cc9e5d34f6a268..53351f05c74cb892530c2d351592cc0cc1a1274c 100644 (file)
--- a/read-tree.c
+++ b/read-tree.c
@@ -217,6 +217,8 @@ static void merge_stat_info(struct cache_entry **src, int nr)
        }
 }
 
        }
 }
 

+static char *read_tree_usage = "read-tree (<sha> | -m <sha1> [<sha2> <sha3>])";
+

 int main(int argc, char **argv)
 {
        int i, newfd, merge;
 int main(int argc, char **argv)
 {
        int i, newfd, merge;


@@ -236,20 +238,20 @@ int main(int argc, char **argv)
                if (!strcmp(arg, "-m")) {
                        int i;
                        if (stage)
                if (!strcmp(arg, "-m")) {
                        int i;
                        if (stage)

-                               usage("-m needs to come first");
+                               die("-m needs to come first");

                        read_cache();
                        for (i = 0; i < active_nr; i++) {
                                if (ce_stage(active_cache[i]))
                        read_cache();
                        for (i = 0; i < active_nr; i++) {
                                if (ce_stage(active_cache[i]))

-                                       usage("you need to resolve your current index first");
+                                       die("you need to resolve your current index first");

                        }
                        stage = 1;
                        merge = 1;
                        continue;
                }
                if (get_sha1_hex(arg, sha1) < 0)
                        }
                        stage = 1;
                        merge = 1;
                        continue;
                }
                if (get_sha1_hex(arg, sha1) < 0)

-                       usage("read-tree [-m] <sha1>");
+                       usage(read_tree_usage);

                if (stage > 3)
                if (stage > 3)

-                       usage("can't merge more than two trees");
+                       usage(read_tree_usage);

                if (read_tree(sha1, "", 0) < 0)
                        die("failed to unpack tree object %s", arg);
                stage++;
                if (read_tree(sha1, "", 0) < 0)
                        die("failed to unpack tree object %s", arg);
                stage++;