builtin/describe.c

   1 #include "builtin.h"
   2 #include "config.h"
   3 #include "environment.h"
   4 #include "gettext.h"
   5 #include "hex.h"
   6 #include "lockfile.h"
   7 #include "commit.h"
   8 #include "tag.h"
   9 #include "refs.h"
  10 #include "object-name.h"
  11 #include "parse-options.h"
  12 #include "read-cache-ll.h"
  13 #include "revision.h"
  14 #include "diff.h"
  15 #include "hashmap.h"
  16 #include "setup.h"
  17 #include "strvec.h"
  18 #include "run-command.h"
  19 #include "object-store-ll.h"
  20 #include "list-objects.h"
  21 #include "commit-slab.h"
  22 #include "wildmatch.h"
  23
  24 #define MAX_TAGS        (FLAG_BITS - 1)
  25 #define DEFAULT_CANDIDATES 10
  26
  27 define_commit_slab(commit_names, struct commit_name *);
  28
  29 static const char * const describe_usage[] = {
  30         N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]"),
  31         N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]"),
  32         N_("git describe <blob>"),
  33         NULL
  34 };
  35
  36 static int debug;       /* Display lots of verbose info */
  37 static int all; /* Any valid ref can be used */
  38 static int tags;        /* Allow lightweight tags */
  39 static int longformat;
  40 static int first_parent;
  41 static int abbrev = -1; /* unspecified */
  42 static int max_candidates = DEFAULT_CANDIDATES;
  43 static struct hashmap names;
  44 static int have_util;
  45 static struct string_list patterns = STRING_LIST_INIT_NODUP;
  46 static struct string_list exclude_patterns = STRING_LIST_INIT_NODUP;
  47 static int always;
  48 static const char *suffix, *dirty, *broken;
  49 static struct commit_names commit_names;
  50
  51 /* diff-index command arguments to check if working tree is dirty. */
  52 static const char *diff_index_args[] = {
  53         "diff-index", "--quiet", "HEAD", "--", NULL
  54 };
  55
  56 struct commit_name {
  57         struct hashmap_entry entry;
  58         struct object_id peeled;
  59         struct tag *tag;
  60         unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
  61         unsigned name_checked:1;
  62         unsigned misnamed:1;
  63         struct object_id oid;
  64         char *path;
  65 };
  66
  67 static const char *prio_names[] = {
  68         N_("head"), N_("lightweight"), N_("annotated"),
  69 };
  70
  71 static int commit_name_neq(const void *cmp_data UNUSED,
  72                            const struct hashmap_entry *eptr,
  73                            const struct hashmap_entry *entry_or_key,
  74                            const void *peeled)
  75 {
  76         const struct commit_name *cn1, *cn2;
  77
  78         cn1 = container_of(eptr, const struct commit_name, entry);
  79         cn2 = container_of(entry_or_key, const struct commit_name, entry);
  80
  81         return !oideq(&cn1->peeled, peeled ? peeled : &cn2->peeled);
  82 }
  83
  84 static inline struct commit_name *find_commit_name(const struct object_id *peeled)
  85 {
  86         return hashmap_get_entry_from_hash(&names, oidhash(peeled), peeled,
  87                                                 struct commit_name, entry);
  88 }
  89
  90 static int replace_name(struct commit_name *e,
  91                                int prio,
  92                                const struct object_id *oid,
  93                                struct tag **tag)
  94 {
  95         if (!e || e->prio < prio)
  96                 return 1;
  97
  98         if (e->prio == 2 && prio == 2) {
  99                 /* Multiple annotated tags point to the same commit.
 100                  * Select one to keep based upon their tagger date.
 101                  */
 102                 struct tag *t;
 103
 104                 if (!e->tag) {
 105                         t = lookup_tag(the_repository, &e->oid);
 106                         if (!t || parse_tag(t))
 107                                 return 1;
 108                         e->tag = t;
 109                 }
 110
 111                 t = lookup_tag(the_repository, oid);
 112                 if (!t || parse_tag(t))
 113                         return 0;
 114                 *tag = t;
 115
 116                 if (e->tag->date < t->date)
 117                         return 1;
 118         }
 119
 120         return 0;
 121 }
 122
 123 static void add_to_known_names(const char *path,
 124                                const struct object_id *peeled,
 125                                int prio,
 126                                const struct object_id *oid)
 127 {
 128         struct commit_name *e = find_commit_name(peeled);
 129         struct tag *tag = NULL;
 130         if (replace_name(e, prio, oid, &tag)) {
 131                 if (!e) {
 132                         e = xmalloc(sizeof(struct commit_name));
 133                         oidcpy(&e->peeled, peeled);
 134                         hashmap_entry_init(&e->entry, oidhash(peeled));
 135                         hashmap_add(&names, &e->entry);
 136                         e->path = NULL;
 137                 }
 138                 e->tag = tag;
 139                 e->prio = prio;
 140                 e->name_checked = 0;
 141                 e->misnamed = 0;
 142                 oidcpy(&e->oid, oid);
 143                 free(e->path);
 144                 e->path = xstrdup(path);
 145         }
 146 }
 147
 148 static int get_name(const char *path, const struct object_id *oid,
 149                     int flag UNUSED, void *cb_data UNUSED)
 150 {
 151         int is_tag = 0;
 152         struct object_id peeled;
 153         int is_annotated, prio;
 154         const char *path_to_match = NULL;
 155
 156         if (skip_prefix(path, "refs/tags/", &path_to_match)) {
 157                 is_tag = 1;
 158         } else if (all) {
 159                 if ((exclude_patterns.nr || patterns.nr) &&
 160                     !skip_prefix(path, "refs/heads/", &path_to_match) &&
 161                     !skip_prefix(path, "refs/remotes/", &path_to_match)) {
 162                         /* Only accept reference of known type if there are match/exclude patterns */
 163                         return 0;
 164                 }
 165         } else {
 166                 /* Reject anything outside refs/tags/ unless --all */
 167                 return 0;
 168         }
 169
 170         /*
 171          * If we're given exclude patterns, first exclude any tag which match
 172          * any of the exclude pattern.
 173          */
 174         if (exclude_patterns.nr) {
 175                 struct string_list_item *item;
 176
 177                 for_each_string_list_item(item, &exclude_patterns) {
 178                         if (!wildmatch(item->string, path_to_match, 0))
 179                                 return 0;
 180                 }
 181         }
 182
 183         /*
 184          * If we're given patterns, accept only tags which match at least one
 185          * pattern.
 186          */
 187         if (patterns.nr) {
 188                 int found = 0;
 189                 struct string_list_item *item;
 190
 191                 for_each_string_list_item(item, &patterns) {
 192                         if (!wildmatch(item->string, path_to_match, 0)) {
 193                                 found = 1;
 194                                 break;
 195                         }
 196                 }
 197
 198                 if (!found)
 199                         return 0;
 200         }
 201
 202         /* Is it annotated? */
 203         if (!peel_iterated_oid(the_repository, oid, &peeled)) {
 204                 is_annotated = !oideq(oid, &peeled);
 205         } else {
 206                 oidcpy(&peeled, oid);
 207                 is_annotated = 0;
 208         }
 209
 210         /*
 211          * By default, we only use annotated tags, but with --tags
 212          * we fall back to lightweight ones (even without --tags,
 213          * we still remember lightweight ones, only to give hints
 214          * in an error message).  --all allows any refs to be used.
 215          */
 216         if (is_annotated)
 217                 prio = 2;
 218         else if (is_tag)
 219                 prio = 1;
 220         else
 221                 prio = 0;
 222
 223         add_to_known_names(all ? path + 5 : path + 10, &peeled, prio, oid);
 224         return 0;
 225 }
 226
 227 struct possible_tag {
 228         struct commit_name *name;
 229         int depth;
 230         int found_order;
 231         unsigned flag_within;
 232 };
 233
 234 static int compare_pt(const void *a_, const void *b_)
 235 {
 236         struct possible_tag *a = (struct possible_tag *)a_;
 237         struct possible_tag *b = (struct possible_tag *)b_;
 238         if (a->depth != b->depth)
 239                 return a->depth - b->depth;
 240         if (a->found_order != b->found_order)
 241                 return a->found_order - b->found_order;
 242         return 0;
 243 }
 244
 245 static unsigned long finish_depth_computation(
 246         struct commit_list **list,
 247         struct possible_tag *best)
 248 {
 249         unsigned long seen_commits = 0;
 250         while (*list) {
 251                 struct commit *c = pop_commit(list);
 252                 struct commit_list *parents = c->parents;
 253                 seen_commits++;
 254                 if (c->object.flags & best->flag_within) {
 255                         struct commit_list *a = *list;
 256                         while (a) {
 257                                 struct commit *i = a->item;
 258                                 if (!(i->object.flags & best->flag_within))
 259                                         break;
 260                                 a = a->next;
 261                         }
 262                         if (!a)
 263                                 break;
 264                 } else
 265                         best->depth++;
 266                 while (parents) {
 267                         struct commit *p = parents->item;
 268                         repo_parse_commit(the_repository, p);
 269                         if (!(p->object.flags & SEEN))
 270                                 commit_list_insert_by_date(p, list);
 271                         p->object.flags |= c->object.flags;
 272                         parents = parents->next;
 273                 }
 274         }
 275         return seen_commits;
 276 }
 277
 278 static void append_name(struct commit_name *n, struct strbuf *dst)
 279 {
 280         if (n->prio == 2 && !n->tag) {
 281                 n->tag = lookup_tag(the_repository, &n->oid);
 282                 if (!n->tag || parse_tag(n->tag))
 283                         die(_("annotated tag %s not available"), n->path);
 284         }
 285         if (n->tag && !n->name_checked) {
 286                 if (strcmp(n->tag->tag, all ? n->path + 5 : n->path)) {
 287                         warning(_("tag '%s' is externally known as '%s'"),
 288                                 n->path, n->tag->tag);
 289                         n->misnamed = 1;
 290                 }
 291                 n->name_checked = 1;
 292         }
 293
 294         if (n->tag) {
 295                 if (all)
 296                         strbuf_addstr(dst, "tags/");
 297                 strbuf_addstr(dst, n->tag->tag);
 298         } else {
 299                 strbuf_addstr(dst, n->path);
 300         }
 301 }
 302
 303 static void append_suffix(int depth, const struct object_id *oid, struct strbuf *dst)
 304 {
 305         strbuf_addf(dst, "-%d-g%s", depth,
 306                     repo_find_unique_abbrev(the_repository, oid, abbrev));
 307 }
 308
 309 static void describe_commit(struct object_id *oid, struct strbuf *dst)
 310 {
 311         struct commit *cmit, *gave_up_on = NULL;
 312         struct commit_list *list;
 313         struct commit_name *n;
 314         struct possible_tag all_matches[MAX_TAGS];
 315         unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
 316         unsigned long seen_commits = 0;
 317         unsigned int unannotated_cnt = 0;
 318
 319         cmit = lookup_commit_reference(the_repository, oid);
 320
 321         n = find_commit_name(&cmit->object.oid);
 322         if (n && (tags || all || n->prio == 2)) {
 323                 /*
 324                  * Exact match to an existing ref.
 325                  */
 326                 append_name(n, dst);
 327                 if (n->misnamed || longformat)
 328                         append_suffix(0, n->tag ? get_tagged_oid(n->tag) : oid, dst);
 329                 if (suffix)
 330                         strbuf_addstr(dst, suffix);
 331                 return;
 332         }
 333
 334         if (!max_candidates)
 335                 die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit->object.oid));
 336         if (debug)
 337                 fprintf(stderr, _("No exact match on refs or tags, searching to describe\n"));
 338
 339         if (!have_util) {
 340                 struct hashmap_iter iter;
 341                 struct commit *c;
 342                 struct commit_name *n;
 343
 344                 init_commit_names(&commit_names);
 345                 hashmap_for_each_entry(&names, &iter, n,
 346                                         entry /* member name */) {
 347                         c = lookup_commit_reference_gently(the_repository,
 348                                                            &n->peeled, 1);
 349                         if (c)
 350                                 *commit_names_at(&commit_names, c) = n;
 351                 }
 352                 have_util = 1;
 353         }
 354
 355         list = NULL;
 356         cmit->object.flags = SEEN;
 357         commit_list_insert(cmit, &list);
 358         while (list) {
 359                 struct commit *c = pop_commit(&list);
 360                 struct commit_list *parents = c->parents;
 361                 struct commit_name **slot;
 362
 363                 seen_commits++;
 364                 slot = commit_names_peek(&commit_names, c);
 365                 n = slot ? *slot : NULL;
 366                 if (n) {
 367                         if (!tags && !all && n->prio < 2) {
 368                                 unannotated_cnt++;
 369                         } else if (match_cnt < max_candidates) {
 370                                 struct possible_tag *t = &all_matches[match_cnt++];
 371                                 t->name = n;
 372                                 t->depth = seen_commits - 1;
 373                                 t->flag_within = 1u << match_cnt;
 374                                 t->found_order = match_cnt;
 375                                 c->object.flags |= t->flag_within;
 376                                 if (n->prio == 2)
 377                                         annotated_cnt++;
 378                         }
 379                         else {
 380                                 gave_up_on = c;
 381                                 break;
 382                         }
 383                 }
 384                 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
 385                         struct possible_tag *t = &all_matches[cur_match];
 386                         if (!(c->object.flags & t->flag_within))
 387                                 t->depth++;
 388                 }
 389                 /* Stop if last remaining path already covered by best candidate(s) */
 390                 if (annotated_cnt && !list) {
 391                         int best_depth = INT_MAX;
 392                         unsigned best_within = 0;
 393                         for (cur_match = 0; cur_match < match_cnt; cur_match++) {
 394                                 struct possible_tag *t = &all_matches[cur_match];
 395                                 if (t->depth < best_depth) {
 396                                         best_depth = t->depth;
 397                                         best_within = t->flag_within;
 398                                 } else if (t->depth == best_depth) {
 399                                         best_within |= t->flag_within;
 400                                 }
 401                         }
 402                         if ((c->object.flags & best_within) == best_within) {
 403                                 if (debug)
 404                                         fprintf(stderr, _("finished search at %s\n"),
 405                                                 oid_to_hex(&c->object.oid));
 406                                 break;
 407                         }
 408                 }
 409                 while (parents) {
 410                         struct commit *p = parents->item;
 411                         repo_parse_commit(the_repository, p);
 412                         if (!(p->object.flags & SEEN))
 413                                 commit_list_insert_by_date(p, &list);
 414                         p->object.flags |= c->object.flags;
 415                         parents = parents->next;
 416
 417                         if (first_parent)
 418                                 break;
 419                 }
 420         }
 421
 422         if (!match_cnt) {
 423                 struct object_id *cmit_oid = &cmit->object.oid;
 424                 if (always) {
 425                         strbuf_add_unique_abbrev(dst, cmit_oid, abbrev);
 426                         if (suffix)
 427                                 strbuf_addstr(dst, suffix);
 428                         return;
 429                 }
 430                 if (unannotated_cnt)
 431                         die(_("No annotated tags can describe '%s'.\n"
 432                             "However, there were unannotated tags: try --tags."),
 433                             oid_to_hex(cmit_oid));
 434                 else
 435                         die(_("No tags can describe '%s'.\n"
 436                             "Try --always, or create some tags."),
 437                             oid_to_hex(cmit_oid));
 438         }
 439
 440         QSORT(all_matches, match_cnt, compare_pt);
 441
 442         if (gave_up_on) {
 443                 commit_list_insert_by_date(gave_up_on, &list);
 444                 seen_commits--;
 445         }
 446         seen_commits += finish_depth_computation(&list, &all_matches[0]);
 447         free_commit_list(list);
 448
 449         if (debug) {
 450                 static int label_width = -1;
 451                 if (label_width < 0) {
 452                         int i, w;
 453                         for (i = 0; i < ARRAY_SIZE(prio_names); i++) {
 454                                 w = strlen(_(prio_names[i]));
 455                                 if (label_width < w)
 456                                         label_width = w;
 457                         }
 458                 }
 459                 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
 460                         struct possible_tag *t = &all_matches[cur_match];
 461                         fprintf(stderr, " %-*s %8d %s\n",
 462                                 label_width, _(prio_names[t->name->prio]),
 463                                 t->depth, t->name->path);
 464                 }
 465                 fprintf(stderr, _("traversed %lu commits\n"), seen_commits);
 466                 if (gave_up_on) {
 467                         fprintf(stderr,
 468                                 _("more than %i tags found; listed %i most recent\n"
 469                                 "gave up search at %s\n"),
 470                                 max_candidates, max_candidates,
 471                                 oid_to_hex(&gave_up_on->object.oid));
 472                 }
 473         }
 474
 475         append_name(all_matches[0].name, dst);
 476         if (all_matches[0].name->misnamed || abbrev)
 477                 append_suffix(all_matches[0].depth, &cmit->object.oid, dst);
 478         if (suffix)
 479                 strbuf_addstr(dst, suffix);
 480 }
 481
 482 struct process_commit_data {
 483         struct object_id current_commit;
 484         struct object_id looking_for;
 485         struct strbuf *dst;
 486         struct rev_info *revs;
 487 };
 488
 489 static void process_commit(struct commit *commit, void *data)
 490 {
 491         struct process_commit_data *pcd = data;
 492         pcd->current_commit = commit->object.oid;
 493 }
 494
 495 static void process_object(struct object *obj, const char *path, void *data)
 496 {
 497         struct process_commit_data *pcd = data;
 498
 499         if (oideq(&pcd->looking_for, &obj->oid) && !pcd->dst->len) {
 500                 reset_revision_walk();
 501                 describe_commit(&pcd->current_commit, pcd->dst);
 502                 strbuf_addf(pcd->dst, ":%s", path);
 503                 free_commit_list(pcd->revs->commits);
 504                 pcd->revs->commits = NULL;
 505         }
 506 }
 507
 508 static void describe_blob(struct object_id oid, struct strbuf *dst)
 509 {
 510         struct rev_info revs;
 511         struct strvec args = STRVEC_INIT;
 512         struct process_commit_data pcd = { *null_oid(), oid, dst, &revs};
 513
 514         strvec_pushl(&args, "internal: The first arg is not parsed",
 515                      "--objects", "--in-commit-order", "--reverse", "HEAD",
 516                      NULL);
 517
 518         repo_init_revisions(the_repository, &revs, NULL);
 519         if (setup_revisions(args.nr, args.v, &revs, NULL) > 1)
 520                 BUG("setup_revisions could not handle all args?");
 521
 522         if (prepare_revision_walk(&revs))
 523                 die("revision walk setup failed");
 524
 525         traverse_commit_list(&revs, process_commit, process_object, &pcd);
 526         reset_revision_walk();
 527         release_revisions(&revs);
 528 }
 529
 530 static void describe(const char *arg, int last_one)
 531 {
 532         struct object_id oid;
 533         struct commit *cmit;
 534         struct strbuf sb = STRBUF_INIT;
 535
 536         if (debug)
 537                 fprintf(stderr, _("describe %s\n"), arg);
 538
 539         if (repo_get_oid(the_repository, arg, &oid))
 540                 die(_("Not a valid object name %s"), arg);
 541         cmit = lookup_commit_reference_gently(the_repository, &oid, 1);
 542
 543         if (cmit)
 544                 describe_commit(&oid, &sb);
 545         else if (oid_object_info(the_repository, &oid, NULL) == OBJ_BLOB)
 546                 describe_blob(oid, &sb);
 547         else
 548                 die(_("%s is neither a commit nor blob"), arg);
 549
 550         puts(sb.buf);
 551
 552         if (!last_one)
 553                 clear_commit_marks(cmit, -1);
 554
 555         strbuf_release(&sb);
 556 }
 557
 558 static int option_parse_exact_match(const struct option *opt, const char *arg,
 559                                     int unset)
 560 {
 561         int *val = opt->value;
 562
 563         BUG_ON_OPT_ARG(arg);
 564
 565         *val = unset ? DEFAULT_CANDIDATES : 0;
 566         return 0;
 567 }
 568
 569 int cmd_describe(int argc, const char **argv, const char *prefix)
 570 {
 571         int contains = 0;
 572         struct option options[] = {
 573                 OPT_BOOL(0, "contains",   &contains, N_("find the tag that comes after the commit")),
 574                 OPT_BOOL(0, "debug",      &debug, N_("debug search strategy on stderr")),
 575                 OPT_BOOL(0, "all",        &all, N_("use any ref")),
 576                 OPT_BOOL(0, "tags",       &tags, N_("use any tag, even unannotated")),
 577                 OPT_BOOL(0, "long",       &longformat, N_("always use long format")),
 578                 OPT_BOOL(0, "first-parent", &first_parent, N_("only follow first parent")),
 579                 OPT__ABBREV(&abbrev),
 580                 OPT_CALLBACK_F(0, "exact-match", &max_candidates, NULL,
 581                                N_("only output exact matches"),
 582                                PARSE_OPT_NOARG, option_parse_exact_match),
 583                 OPT_INTEGER(0, "candidates", &max_candidates,
 584                             N_("consider <n> most recent tags (default: 10)")),
 585                 OPT_STRING_LIST(0, "match", &patterns, N_("pattern"),
 586                            N_("only consider tags matching <pattern>")),
 587                 OPT_STRING_LIST(0, "exclude", &exclude_patterns, N_("pattern"),
 588                            N_("do not consider tags matching <pattern>")),
 589                 OPT_BOOL(0, "always",        &always,
 590                         N_("show abbreviated commit object as fallback")),
 591                 {OPTION_STRING, 0, "dirty",  &dirty, N_("mark"),
 592                         N_("append <mark> on dirty working tree (default: \"-dirty\")"),
 593                         PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
 594                 {OPTION_STRING, 0, "broken",  &broken, N_("mark"),
 595                         N_("append <mark> on broken working tree (default: \"-broken\")"),
 596                         PARSE_OPT_OPTARG, NULL, (intptr_t) "-broken"},
 597                 OPT_END(),
 598         };
 599
 600         git_config(git_default_config, NULL);
 601         argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
 602         if (abbrev < 0)
 603                 abbrev = DEFAULT_ABBREV;
 604
 605         if (max_candidates < 0)
 606                 max_candidates = 0;
 607         else if (max_candidates > MAX_TAGS)
 608                 max_candidates = MAX_TAGS;
 609
 610         save_commit_buffer = 0;
 611
 612         if (longformat && abbrev == 0)
 613                 die(_("options '%s' and '%s' cannot be used together"), "--long", "--abbrev=0");
 614
 615         if (contains) {
 616                 struct string_list_item *item;
 617                 struct strvec args;
 618
 619                 strvec_init(&args);
 620                 strvec_pushl(&args, "name-rev",
 621                              "--peel-tag", "--name-only", "--no-undefined",
 622                              NULL);
 623                 if (always)
 624                         strvec_push(&args, "--always");
 625                 if (!all) {
 626                         strvec_push(&args, "--tags");
 627                         for_each_string_list_item(item, &patterns)
 628                                 strvec_pushf(&args, "--refs=refs/tags/%s", item->string);
 629                         for_each_string_list_item(item, &exclude_patterns)
 630                                 strvec_pushf(&args, "--exclude=refs/tags/%s", item->string);
 631                 }
 632                 if (argc)
 633                         strvec_pushv(&args, argv);
 634                 else
 635                         strvec_push(&args, "HEAD");
 636                 return cmd_name_rev(args.nr, args.v, prefix);
 637         }
 638
 639         hashmap_init(&names, commit_name_neq, NULL, 0);
 640         refs_for_each_rawref(get_main_ref_store(the_repository), get_name,
 641                              NULL);
 642         if (!hashmap_get_size(&names) && !always)
 643                 die(_("No names found, cannot describe anything."));
 644
 645         if (argc == 0) {
 646                 if (broken) {
 647                         struct child_process cp = CHILD_PROCESS_INIT;
 648                         strvec_pushv(&cp.args, diff_index_args);
 649                         cp.git_cmd = 1;
 650                         cp.no_stdin = 1;
 651                         cp.no_stdout = 1;
 652
 653                         if (!dirty)
 654                                 dirty = "-dirty";
 655
 656                         switch (run_command(&cp)) {
 657                         case 0:
 658                                 suffix = NULL;
 659                                 break;
 660                         case 1:
 661                                 suffix = dirty;
 662                                 break;
 663                         default:
 664                                 /* diff-index aborted abnormally */
 665                                 suffix = broken;
 666                         }
 667                 } else if (dirty) {
 668                         struct lock_file index_lock = LOCK_INIT;
 669                         struct rev_info revs;
 670                         struct strvec args = STRVEC_INIT;
 671                         int fd;
 672
 673                         setup_work_tree();
 674                         prepare_repo_settings(the_repository);
 675                         the_repository->settings.command_requires_full_index = 0;
 676                         repo_read_index(the_repository);
 677                         refresh_index(the_repository->index, REFRESH_QUIET|REFRESH_UNMERGED,
 678                                       NULL, NULL, NULL);
 679                         fd = repo_hold_locked_index(the_repository,
 680                                                     &index_lock, 0);
 681                         if (0 <= fd)
 682                                 repo_update_index_if_able(the_repository, &index_lock);
 683
 684                         repo_init_revisions(the_repository, &revs, prefix);
 685                         strvec_pushv(&args, diff_index_args);
 686                         if (setup_revisions(args.nr, args.v, &revs, NULL) != 1)
 687                                 BUG("malformed internal diff-index command line");
 688                         run_diff_index(&revs, 0);
 689
 690                         if (!diff_result_code(&revs.diffopt))
 691                                 suffix = NULL;
 692                         else
 693                                 suffix = dirty;
 694                         release_revisions(&revs);
 695                 }
 696                 describe("HEAD", 1);
 697         } else if (dirty) {
 698                 die(_("option '%s' and commit-ishes cannot be used together"), "--dirty");
 699         } else if (broken) {
 700                 die(_("option '%s' and commit-ishes cannot be used together"), "--broken");
 701         } else {
 702                 while (argc-- > 0)
 703                         describe(*argv++, argc == 0);
 704         }
 705         return 0;
 706 }