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