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