Documentation: clarify which parameters are optional to git-cherry

diff --git a/builtin-describe.c b/builtin-describe.c
index 7a5ab012b1fabe3f67cd2d9bc776794e34431d80..d2cfb1b0837ffd1ab3b1f69e8dee0ffa36f2e1ab 100644 (file)
--- a/builtin-describe.c
+++ b/builtin-describe.c
@@ -10,17 +10,18 @@
 #define MAX_TAGS       (FLAG_BITS - 1)
 
 static const char * const describe_usage[] = {
-       "git-describe [options] <committish>*",
+       "git describe [options] <committish>*",
        NULL
 };
 
 static int debug;      /* Display lots of verbose info */
-static int all;        /* Default to annotated tags only */
-static int tags;       /* But allow any tags if --tags is specified */
+static int all;        /* Any valid ref can be used */
+static int tags;       /* Allow lightweight tags */
 static int longformat;
 static int abbrev = DEFAULT_ABBREV;
 static int max_candidates = 10;
-const char *pattern = NULL;
+static const char *pattern;
+static int always;
 
 struct commit_name {
        struct tag *tag;
@@ -79,12 +80,13 @@ static int get_name(const char *path, const unsigned char *sha1, int flag, void
         * Otherwise only annotated tags are used.
         */
        if (might_be_tag) {
-               if (is_tag) {
+               if (is_tag)
                        prio = 2;
-                       if (pattern && fnmatch(pattern, path + 10, 0))
-                               prio = 0;
-               } else
+               else
                        prio = 1;
+
+               if (pattern && fnmatch(pattern, path + 10, 0))
+                       prio = 0;
        }
        else
                prio = 0;
@@ -110,8 +112,6 @@ static int compare_pt(const void *a_, const void *b_)
 {
        struct possible_tag *a = (struct possible_tag *)a_;
        struct possible_tag *b = (struct possible_tag *)b_;
-       if (a->name->prio != b->name->prio)
-               return b->name->prio - a->name->prio;
        if (a->depth != b->depth)
                return a->depth - b->depth;
        if (a->found_order != b->found_order)
@@ -202,7 +202,7 @@ static void describe(const char *arg, int last_one)
                 */
                display_name(n);
                if (longformat)
-                       show_suffix(0, n->tag->tagged->sha1);
+                       show_suffix(0, n->tag ? n->tag->tagged->sha1 : sha1);
                printf("\n");
                return;
        }
@@ -257,8 +257,14 @@ static void describe(const char *arg, int last_one)
                }
        }
 
-       if (!match_cnt)
-               die("cannot describe '%s'", sha1_to_hex(cmit->object.sha1));
+       if (!match_cnt) {
+               const unsigned char *sha1 = cmit->object.sha1;
+               if (always) {
+                       printf("%s\n", find_unique_abbrev(sha1, abbrev));
+                       return;
+               }
+               die("cannot describe '%s'", sha1_to_hex(sha1));
+       }
 
        qsort(all_matches, match_cnt, sizeof(all_matches[0]), compare_pt);
 
@@ -311,6 +317,8 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
                            "consider <n> most recent tags (default: 10)"),
                OPT_STRING(0, "match",       &pattern, "pattern",
                           "only consider tags matching <pattern>"),
+               OPT_BOOLEAN(0, "always",     &always,
+                          "show abbreviated commit object as fallback"),
                OPT_END(),
        };
 
@@ -326,11 +334,13 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
                die("--long is incompatible with --abbrev=0");
 
        if (contains) {
-               const char **args = xmalloc((6 + argc) * sizeof(char*));
+               const char **args = xmalloc((7 + argc) * sizeof(char*));
                int i = 0;
                args[i++] = "name-rev";
                args[i++] = "--name-only";
                args[i++] = "--no-undefined";
+               if (always)
+                       args[i++] = "--always";
                if (!all) {
                        args[i++] = "--tags";
                        if (pattern) {