git.oblomov.eu Git - git/blob - builtin/ls-files.c

   1 /*
   2  * This merges the file listing in the directory cache index
   3  * with the actual working directory list, and shows different
   4  * combinations of the two.
   5  *
   6  * Copyright (C) Linus Torvalds, 2005
   7  */
   8 #include "cache.h"
   9 #include "quote.h"
  10 #include "dir.h"
  11 #include "builtin.h"
  12 #include "tree.h"
  13 #include "parse-options.h"
  14 #include "resolve-undo.h"
  15 #include "string-list.h"
  16 #include "pathspec.h"
  17 #include "run-command.h"
  18 #include "submodule.h"
  19
  20 static int abbrev;
  21 static int show_deleted;
  22 static int show_cached;
  23 static int show_others;
  24 static int show_stage;
  25 static int show_unmerged;
  26 static int show_resolve_undo;
  27 static int show_modified;
  28 static int show_killed;
  29 static int show_valid_bit;
  30 static int line_terminator = '\n';
  31 static int debug_mode;
  32 static int show_eol;
  33 static int recurse_submodules;
  34 static struct argv_array submodule_options = ARGV_ARRAY_INIT;
  35
  36 static const char *prefix;
  37 static const char *super_prefix;
  38 static int max_prefix_len;
  39 static int prefix_len;
  40 static struct pathspec pathspec;
  41 static int error_unmatch;
  42 static char *ps_matched;
  43 static const char *with_tree;
  44 static int exc_given;
  45 static int exclude_args;
  46
  47 static const char *tag_cached = "";
  48 static const char *tag_unmerged = "";
  49 static const char *tag_removed = "";
  50 static const char *tag_other = "";
  51 static const char *tag_killed = "";
  52 static const char *tag_modified = "";
  53 static const char *tag_skip_worktree = "";
  54 static const char *tag_resolve_undo = "";
  55
  56 static void write_eolinfo(const struct index_state *istate,
  57                           const struct cache_entry *ce, const char *path)
  58 {
  59         if (show_eol) {
  60                 struct stat st;
  61                 const char *i_txt = "";
  62                 const char *w_txt = "";
  63                 const char *a_txt = get_convert_attr_ascii(path);
  64                 if (ce && S_ISREG(ce->ce_mode))
  65                         i_txt = get_cached_convert_stats_ascii(istate,
  66                                                                ce->name);
  67                 if (!lstat(path, &st) && S_ISREG(st.st_mode))
  68                         w_txt = get_wt_convert_stats_ascii(path);
  69                 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
  70         }
  71 }
  72
  73 static void write_name(const char *name)
  74 {
  75         /*
  76          * Prepend the super_prefix to name to construct the full_name to be
  77          * written.
  78          */
  79         struct strbuf full_name = STRBUF_INIT;
  80         if (super_prefix) {
  81                 strbuf_addstr(&full_name, super_prefix);
  82                 strbuf_addstr(&full_name, name);
  83                 name = full_name.buf;
  84         }
  85
  86         /*
  87          * With "--full-name", prefix_len=0; this caller needs to pass
  88          * an empty string in that case (a NULL is good for "").
  89          */
  90         write_name_quoted_relative(name, prefix_len ? prefix : NULL,
  91                                    stdout, line_terminator);
  92
  93         strbuf_release(&full_name);
  94 }
  95
  96 static void show_dir_entry(const char *tag, struct dir_entry *ent)
  97 {
  98         int len = max_prefix_len;
  99
 100         if (len > ent->len)
 101                 die("git ls-files: internal error - directory entry not superset of prefix");
 102
 103         if (!dir_path_match(ent, &pathspec, len, ps_matched))
 104                 return;
 105
 106         fputs(tag, stdout);
 107         write_eolinfo(NULL, NULL, ent->name);
 108         write_name(ent->name);
 109 }
 110
 111 static void show_other_files(const struct index_state *istate,
 112                              const struct dir_struct *dir)
 113 {
 114         int i;
 115
 116         for (i = 0; i < dir->nr; i++) {
 117                 struct dir_entry *ent = dir->entries[i];
 118                 if (!index_name_is_other(istate, ent->name, ent->len))
 119                         continue;
 120                 show_dir_entry(tag_other, ent);
 121         }
 122 }
 123
 124 static void show_killed_files(const struct index_state *istate,
 125                               const struct dir_struct *dir)
 126 {
 127         int i;
 128         for (i = 0; i < dir->nr; i++) {
 129                 struct dir_entry *ent = dir->entries[i];
 130                 char *cp, *sp;
 131                 int pos, len, killed = 0;
 132
 133                 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
 134                         sp = strchr(cp, '/');
 135                         if (!sp) {
 136                                 /* If ent->name is prefix of an entry in the
 137                                  * cache, it will be killed.
 138                                  */
 139                                 pos = index_name_pos(istate, ent->name, ent->len);
 140                                 if (0 <= pos)
 141                                         die("BUG: killed-file %.*s not found",
 142                                                 ent->len, ent->name);
 143                                 pos = -pos - 1;
 144                                 while (pos < istate->cache_nr &&
 145                                        ce_stage(istate->cache[pos]))
 146                                         pos++; /* skip unmerged */
 147                                 if (istate->cache_nr <= pos)
 148                                         break;
 149                                 /* pos points at a name immediately after
 150                                  * ent->name in the cache.  Does it expect
 151                                  * ent->name to be a directory?
 152                                  */
 153                                 len = ce_namelen(istate->cache[pos]);
 154                                 if ((ent->len < len) &&
 155                                     !strncmp(istate->cache[pos]->name,
 156                                              ent->name, ent->len) &&
 157                                     istate->cache[pos]->name[ent->len] == '/')
 158                                         killed = 1;
 159                                 break;
 160                         }
 161                         if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
 162                                 /* If any of the leading directories in
 163                                  * ent->name is registered in the cache,
 164                                  * ent->name will be killed.
 165                                  */
 166                                 killed = 1;
 167                                 break;
 168                         }
 169                 }
 170                 if (killed)
 171                         show_dir_entry(tag_killed, dir->entries[i]);
 172         }
 173 }
 174
 175 /*
 176  * Compile an argv_array with all of the options supported by --recurse_submodules
 177  */
 178 static void compile_submodule_options(const char **argv,
 179                                       const struct dir_struct *dir,
 180                                       int show_tag)
 181 {
 182         if (line_terminator == '\0')
 183                 argv_array_push(&submodule_options, "-z");
 184         if (show_tag)
 185                 argv_array_push(&submodule_options, "-t");
 186         if (show_valid_bit)
 187                 argv_array_push(&submodule_options, "-v");
 188         if (show_cached)
 189                 argv_array_push(&submodule_options, "--cached");
 190         if (show_eol)
 191                 argv_array_push(&submodule_options, "--eol");
 192         if (debug_mode)
 193                 argv_array_push(&submodule_options, "--debug");
 194
 195         /* Add Pathspecs */
 196         argv_array_push(&submodule_options, "--");
 197         for (; *argv; argv++)
 198                 argv_array_push(&submodule_options, *argv);
 199 }
 200
 201 /**
 202  * Recursively call ls-files on a submodule
 203  */
 204 static void show_gitlink(const struct cache_entry *ce)
 205 {
 206         struct child_process cp = CHILD_PROCESS_INIT;
 207         int status;
 208         char *dir;
 209
 210         prepare_submodule_repo_env(&cp.env_array);
 211         argv_array_push(&cp.env_array, GIT_DIR_ENVIRONMENT);
 212
 213         if (prefix_len)
 214                 argv_array_pushf(&cp.env_array, "%s=%s",
 215                                  GIT_TOPLEVEL_PREFIX_ENVIRONMENT,
 216                                  prefix);
 217         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
 218                          super_prefix ? super_prefix : "",
 219                          ce->name);
 220         argv_array_push(&cp.args, "ls-files");
 221         argv_array_push(&cp.args, "--recurse-submodules");
 222
 223         /* add supported options */
 224         argv_array_pushv(&cp.args, submodule_options.argv);
 225
 226         cp.git_cmd = 1;
 227         dir = mkpathdup("%s/%s", get_git_work_tree(), ce->name);
 228         cp.dir = dir;
 229         status = run_command(&cp);
 230         free(dir);
 231         if (status)
 232                 exit(status);
 233 }
 234
 235 static void show_ce_entry(const struct index_state *istate,
 236                           const char *tag, const struct cache_entry *ce)
 237 {
 238         struct strbuf name = STRBUF_INIT;
 239         int len = max_prefix_len;
 240         if (super_prefix)
 241                 strbuf_addstr(&name, super_prefix);
 242         strbuf_addstr(&name, ce->name);
 243
 244         if (len > ce_namelen(ce))
 245                 die("git ls-files: internal error - cache entry not superset of prefix");
 246
 247         if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
 248             submodule_path_match(&pathspec, name.buf, ps_matched)) {
 249                 show_gitlink(ce);
 250         } else if (match_pathspec(&pathspec, name.buf, name.len,
 251                                   len, ps_matched,
 252                                   S_ISDIR(ce->ce_mode) ||
 253                                   S_ISGITLINK(ce->ce_mode))) {
 254                 if (tag && *tag && show_valid_bit &&
 255                     (ce->ce_flags & CE_VALID)) {
 256                         static char alttag[4];
 257                         memcpy(alttag, tag, 3);
 258                         if (isalpha(tag[0]))
 259                                 alttag[0] = tolower(tag[0]);
 260                         else if (tag[0] == '?')
 261                                 alttag[0] = '!';
 262                         else {
 263                                 alttag[0] = 'v';
 264                                 alttag[1] = tag[0];
 265                                 alttag[2] = ' ';
 266                                 alttag[3] = 0;
 267                         }
 268                         tag = alttag;
 269                 }
 270
 271                 if (!show_stage) {
 272                         fputs(tag, stdout);
 273                 } else {
 274                         printf("%s%06o %s %d\t",
 275                                tag,
 276                                ce->ce_mode,
 277                                find_unique_abbrev(ce->oid.hash, abbrev),
 278                                ce_stage(ce));
 279                 }
 280                 write_eolinfo(istate, ce, ce->name);
 281                 write_name(ce->name);
 282                 if (debug_mode) {
 283                         const struct stat_data *sd = &ce->ce_stat_data;
 284
 285                         printf("  ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
 286                         printf("  mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
 287                         printf("  dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
 288                         printf("  uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
 289                         printf("  size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
 290                 }
 291         }
 292
 293         strbuf_release(&name);
 294 }
 295
 296 static void show_ru_info(const struct index_state *istate)
 297 {
 298         struct string_list_item *item;
 299
 300         if (!istate->resolve_undo)
 301                 return;
 302
 303         for_each_string_list_item(item, istate->resolve_undo) {
 304                 const char *path = item->string;
 305                 struct resolve_undo_info *ui = item->util;
 306                 int i, len;
 307
 308                 len = strlen(path);
 309                 if (len < max_prefix_len)
 310                         continue; /* outside of the prefix */
 311                 if (!match_pathspec(&pathspec, path, len,
 312                                     max_prefix_len, ps_matched, 0))
 313                         continue; /* uninterested */
 314                 for (i = 0; i < 3; i++) {
 315                         if (!ui->mode[i])
 316                                 continue;
 317                         printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
 318                                find_unique_abbrev(ui->sha1[i], abbrev),
 319                                i + 1);
 320                         write_name(path);
 321                 }
 322         }
 323 }
 324
 325 static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
 326                        const struct cache_entry *ce)
 327 {
 328         int dtype = ce_to_dtype(ce);
 329         return is_excluded(dir, istate, ce->name, &dtype);
 330 }
 331
 332 static void show_files(struct dir_struct *dir)
 333 {
 334         int i;
 335
 336         /* For cached/deleted files we don't need to even do the readdir */
 337         if (show_others || show_killed) {
 338                 if (!show_others)
 339                         dir->flags |= DIR_COLLECT_KILLED_ONLY;
 340                 fill_directory(dir, &the_index, &pathspec);
 341                 if (show_others)
 342                         show_other_files(&the_index, dir);
 343                 if (show_killed)
 344                         show_killed_files(&the_index, dir);
 345         }
 346         if (show_cached || show_stage) {
 347                 for (i = 0; i < active_nr; i++) {
 348                         const struct cache_entry *ce = active_cache[i];
 349                         if ((dir->flags & DIR_SHOW_IGNORED) &&
 350                             !ce_excluded(dir, &the_index, ce))
 351                                 continue;
 352                         if (show_unmerged && !ce_stage(ce))
 353                                 continue;
 354                         if (ce->ce_flags & CE_UPDATE)
 355                                 continue;
 356                         show_ce_entry(&the_index, ce_stage(ce) ? tag_unmerged :
 357                                 (ce_skip_worktree(ce) ? tag_skip_worktree : tag_cached), ce);
 358                 }
 359         }
 360         if (show_deleted || show_modified) {
 361                 for (i = 0; i < active_nr; i++) {
 362                         const struct cache_entry *ce = active_cache[i];
 363                         struct stat st;
 364                         int err;
 365                         if ((dir->flags & DIR_SHOW_IGNORED) &&
 366                             !ce_excluded(dir, &the_index, ce))
 367                                 continue;
 368                         if (ce->ce_flags & CE_UPDATE)
 369                                 continue;
 370                         if (ce_skip_worktree(ce))
 371                                 continue;
 372                         err = lstat(ce->name, &st);
 373                         if (show_deleted && err)
 374                                 show_ce_entry(&the_index, tag_removed, ce);
 375                         if (show_modified && ce_modified(ce, &st, 0))
 376                                 show_ce_entry(&the_index, tag_modified, ce);
 377                 }
 378         }
 379 }
 380
 381 /*
 382  * Prune the index to only contain stuff starting with "prefix"
 383  */
 384 static void prune_index(struct index_state *istate,
 385                         const char *prefix, size_t prefixlen)
 386 {
 387         int pos;
 388         unsigned int first, last;
 389
 390         if (!prefix)
 391                 return;
 392         pos = index_name_pos(istate, prefix, prefixlen);
 393         if (pos < 0)
 394                 pos = -pos-1;
 395         first = pos;
 396         last = istate->cache_nr;
 397         while (last > first) {
 398                 int next = (last + first) >> 1;
 399                 const struct cache_entry *ce = istate->cache[next];
 400                 if (!strncmp(ce->name, prefix, prefixlen)) {
 401                         first = next+1;
 402                         continue;
 403                 }
 404                 last = next;
 405         }
 406         memmove(istate->cache, istate->cache + pos,
 407                 (last - pos) * sizeof(struct cache_entry *));
 408         istate->cache_nr = last - pos;
 409 }
 410
 411 static int get_common_prefix_len(const char *common_prefix)
 412 {
 413         int common_prefix_len;
 414
 415         if (!common_prefix)
 416                 return 0;
 417
 418         common_prefix_len = strlen(common_prefix);
 419
 420         /*
 421          * If the prefix has a trailing slash, strip it so that submodules wont
 422          * be pruned from the index.
 423          */
 424         if (common_prefix[common_prefix_len - 1] == '/')
 425                 common_prefix_len--;
 426
 427         return common_prefix_len;
 428 }
 429
 430 /*
 431  * Read the tree specified with --with-tree option
 432  * (typically, HEAD) into stage #1 and then
 433  * squash them down to stage #0.  This is used for
 434  * --error-unmatch to list and check the path patterns
 435  * that were given from the command line.  We are not
 436  * going to write this index out.
 437  */
 438 void overlay_tree_on_index(struct index_state *istate,
 439                            const char *tree_name, const char *prefix)
 440 {
 441         struct tree *tree;
 442         struct object_id oid;
 443         struct pathspec pathspec;
 444         struct cache_entry *last_stage0 = NULL;
 445         int i;
 446
 447         if (get_oid(tree_name, &oid))
 448                 die("tree-ish %s not found.", tree_name);
 449         tree = parse_tree_indirect(&oid);
 450         if (!tree)
 451                 die("bad tree-ish %s", tree_name);
 452
 453         /* Hoist the unmerged entries up to stage #3 to make room */
 454         for (i = 0; i < istate->cache_nr; i++) {
 455                 struct cache_entry *ce = istate->cache[i];
 456                 if (!ce_stage(ce))
 457                         continue;
 458                 ce->ce_flags |= CE_STAGEMASK;
 459         }
 460
 461         if (prefix) {
 462                 static const char *(matchbuf[1]);
 463                 matchbuf[0] = NULL;
 464                 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
 465                                PATHSPEC_PREFER_CWD, prefix, matchbuf);
 466         } else
 467                 memset(&pathspec, 0, sizeof(pathspec));
 468         if (read_tree(tree, 1, &pathspec, istate))
 469                 die("unable to read tree entries %s", tree_name);
 470
 471         for (i = 0; i < istate->cache_nr; i++) {
 472                 struct cache_entry *ce = istate->cache[i];
 473                 switch (ce_stage(ce)) {
 474                 case 0:
 475                         last_stage0 = ce;
 476                         /* fallthru */
 477                 default:
 478                         continue;
 479                 case 1:
 480                         /*
 481                          * If there is stage #0 entry for this, we do not
 482                          * need to show it.  We use CE_UPDATE bit to mark
 483                          * such an entry.
 484                          */
 485                         if (last_stage0 &&
 486                             !strcmp(last_stage0->name, ce->name))
 487                                 ce->ce_flags |= CE_UPDATE;
 488                 }
 489         }
 490 }
 491
 492 static const char * const ls_files_usage[] = {
 493         N_("git ls-files [<options>] [<file>...]"),
 494         NULL
 495 };
 496
 497 static int option_parse_exclude(const struct option *opt,
 498                                 const char *arg, int unset)
 499 {
 500         struct string_list *exclude_list = opt->value;
 501
 502         exc_given = 1;
 503         string_list_append(exclude_list, arg);
 504
 505         return 0;
 506 }
 507
 508 static int option_parse_exclude_from(const struct option *opt,
 509                                      const char *arg, int unset)
 510 {
 511         struct dir_struct *dir = opt->value;
 512
 513         exc_given = 1;
 514         add_excludes_from_file(dir, arg);
 515
 516         return 0;
 517 }
 518
 519 static int option_parse_exclude_standard(const struct option *opt,
 520                                          const char *arg, int unset)
 521 {
 522         struct dir_struct *dir = opt->value;
 523
 524         exc_given = 1;
 525         setup_standard_excludes(dir);
 526
 527         return 0;
 528 }
 529
 530 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
 531 {
 532         int require_work_tree = 0, show_tag = 0, i;
 533         const char *max_prefix;
 534         struct dir_struct dir;
 535         struct exclude_list *el;
 536         struct string_list exclude_list = STRING_LIST_INIT_NODUP;
 537         struct option builtin_ls_files_options[] = {
 538                 /* Think twice before adding "--nul" synonym to this */
 539                 OPT_SET_INT('z', NULL, &line_terminator,
 540                         N_("paths are separated with NUL character"), '\0'),
 541                 OPT_BOOL('t', NULL, &show_tag,
 542                         N_("identify the file status with tags")),
 543                 OPT_BOOL('v', NULL, &show_valid_bit,
 544                         N_("use lowercase letters for 'assume unchanged' files")),
 545                 OPT_BOOL('c', "cached", &show_cached,
 546                         N_("show cached files in the output (default)")),
 547                 OPT_BOOL('d', "deleted", &show_deleted,
 548                         N_("show deleted files in the output")),
 549                 OPT_BOOL('m', "modified", &show_modified,
 550                         N_("show modified files in the output")),
 551                 OPT_BOOL('o', "others", &show_others,
 552                         N_("show other files in the output")),
 553                 OPT_BIT('i', "ignored", &dir.flags,
 554                         N_("show ignored files in the output"),
 555                         DIR_SHOW_IGNORED),
 556                 OPT_BOOL('s', "stage", &show_stage,
 557                         N_("show staged contents' object name in the output")),
 558                 OPT_BOOL('k', "killed", &show_killed,
 559                         N_("show files on the filesystem that need to be removed")),
 560                 OPT_BIT(0, "directory", &dir.flags,
 561                         N_("show 'other' directories' names only"),
 562                         DIR_SHOW_OTHER_DIRECTORIES),
 563                 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
 564                 OPT_NEGBIT(0, "empty-directory", &dir.flags,
 565                         N_("don't show empty directories"),
 566                         DIR_HIDE_EMPTY_DIRECTORIES),
 567                 OPT_BOOL('u', "unmerged", &show_unmerged,
 568                         N_("show unmerged files in the output")),
 569                 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
 570                             N_("show resolve-undo information")),
 571                 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
 572                         N_("skip files matching pattern"),
 573                         0, option_parse_exclude },
 574                 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
 575                         N_("exclude patterns are read from <file>"),
 576                         0, option_parse_exclude_from },
 577                 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
 578                         N_("read additional per-directory exclude patterns in <file>")),
 579                 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
 580                         N_("add the standard git exclusions"),
 581                         PARSE_OPT_NOARG, option_parse_exclude_standard },
 582                 { OPTION_SET_INT, 0, "full-name", &prefix_len, NULL,
 583                         N_("make the output relative to the project top directory"),
 584                         PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL },
 585                 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
 586                         N_("recurse through submodules")),
 587                 OPT_BOOL(0, "error-unmatch", &error_unmatch,
 588                         N_("if any <file> is not in the index, treat this as an error")),
 589                 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
 590                         N_("pretend that paths removed since <tree-ish> are still present")),
 591                 OPT__ABBREV(&abbrev),
 592                 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
 593                 OPT_END()
 594         };
 595
 596         if (argc == 2 && !strcmp(argv[1], "-h"))
 597                 usage_with_options(ls_files_usage, builtin_ls_files_options);
 598
 599         memset(&dir, 0, sizeof(dir));
 600         prefix = cmd_prefix;
 601         if (prefix)
 602                 prefix_len = strlen(prefix);
 603         super_prefix = get_super_prefix();
 604         git_config(git_default_config, NULL);
 605
 606         if (read_cache() < 0)
 607                 die("index file corrupt");
 608
 609         argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
 610                         ls_files_usage, 0);
 611         el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
 612         for (i = 0; i < exclude_list.nr; i++) {
 613                 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
 614         }
 615         if (show_tag || show_valid_bit) {
 616                 tag_cached = "H ";
 617                 tag_unmerged = "M ";
 618                 tag_removed = "R ";
 619                 tag_modified = "C ";
 620                 tag_other = "? ";
 621                 tag_killed = "K ";
 622                 tag_skip_worktree = "S ";
 623                 tag_resolve_undo = "U ";
 624         }
 625         if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
 626                 require_work_tree = 1;
 627         if (show_unmerged)
 628                 /*
 629                  * There's no point in showing unmerged unless
 630                  * you also show the stage information.
 631                  */
 632                 show_stage = 1;
 633         if (dir.exclude_per_dir)
 634                 exc_given = 1;
 635
 636         if (require_work_tree && !is_inside_work_tree())
 637                 setup_work_tree();
 638
 639         if (recurse_submodules)
 640                 compile_submodule_options(argv, &dir, show_tag);
 641
 642         if (recurse_submodules &&
 643             (show_stage || show_deleted || show_others || show_unmerged ||
 644              show_killed || show_modified || show_resolve_undo || with_tree))
 645                 die("ls-files --recurse-submodules unsupported mode");
 646
 647         if (recurse_submodules && error_unmatch)
 648                 die("ls-files --recurse-submodules does not support "
 649                     "--error-unmatch");
 650
 651         parse_pathspec(&pathspec, 0,
 652                        PATHSPEC_PREFER_CWD,
 653                        prefix, argv);
 654
 655         /*
 656          * Find common prefix for all pathspec's
 657          * This is used as a performance optimization which unfortunately cannot
 658          * be done when recursing into submodules
 659          */
 660         if (recurse_submodules)
 661                 max_prefix = NULL;
 662         else
 663                 max_prefix = common_prefix(&pathspec);
 664         max_prefix_len = get_common_prefix_len(max_prefix);
 665
 666         prune_index(&the_index, max_prefix, max_prefix_len);
 667
 668         /* Treat unmatching pathspec elements as errors */
 669         if (pathspec.nr && error_unmatch)
 670                 ps_matched = xcalloc(pathspec.nr, 1);
 671
 672         if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
 673                 die("ls-files --ignored needs some exclude pattern");
 674
 675         /* With no flags, we default to showing the cached files */
 676         if (!(show_stage || show_deleted || show_others || show_unmerged ||
 677               show_killed || show_modified || show_resolve_undo))
 678                 show_cached = 1;
 679
 680         if (with_tree) {
 681                 /*
 682                  * Basic sanity check; show-stages and show-unmerged
 683                  * would not make any sense with this option.
 684                  */
 685                 if (show_stage || show_unmerged)
 686                         die("ls-files --with-tree is incompatible with -s or -u");
 687                 overlay_tree_on_index(&the_index, with_tree, max_prefix);
 688         }
 689         show_files(&dir);
 690         if (show_resolve_undo)
 691                 show_ru_info(&the_index);
 692
 693         if (ps_matched) {
 694                 int bad;
 695                 bad = report_path_error(ps_matched, &pathspec, prefix);
 696                 if (bad)
 697                         fprintf(stderr, "Did you forget to 'git add'?\n");
 698
 699                 return bad ? 1 : 0;
 700         }
 701
 702         return 0;
 703 }