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.
6 * Copyright (C) Linus Torvalds, 2005
9 #include "repository.h"
15 #include "parse-options.h"
16 #include "resolve-undo.h"
17 #include "string-list.h"
19 #include "run-command.h"
20 #include "submodule.h"
21 #include "submodule-config.h"
24 static int show_deleted;
25 static int show_cached;
26 static int show_others;
27 static int show_stage;
28 static int show_unmerged;
29 static int show_resolve_undo;
30 static int show_modified;
31 static int show_killed;
32 static int show_valid_bit;
33 static int show_fsmonitor_bit;
34 static int line_terminator = '\n';
35 static int debug_mode;
37 static int recurse_submodules;
38 static int skipping_duplicates;
40 static const char *prefix;
41 static int max_prefix_len;
42 static int prefix_len;
43 static struct pathspec pathspec;
44 static int error_unmatch;
45 static char *ps_matched;
46 static const char *with_tree;
48 static int exclude_args;
50 static const char *tag_cached = "";
51 static const char *tag_unmerged = "";
52 static const char *tag_removed = "";
53 static const char *tag_other = "";
54 static const char *tag_killed = "";
55 static const char *tag_modified = "";
56 static const char *tag_skip_worktree = "";
57 static const char *tag_resolve_undo = "";
59 static void write_eolinfo(const struct index_state *istate,
60 const struct cache_entry *ce, const char *path)
64 const char *i_txt = "";
65 const char *w_txt = "";
66 const char *a_txt = get_convert_attr_ascii(istate, path);
67 if (ce && S_ISREG(ce->ce_mode))
68 i_txt = get_cached_convert_stats_ascii(istate,
70 if (!lstat(path, &st) && S_ISREG(st.st_mode))
71 w_txt = get_wt_convert_stats_ascii(path);
72 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
76 static void write_name(const char *name)
79 * With "--full-name", prefix_len=0; this caller needs to pass
80 * an empty string in that case (a NULL is good for "").
82 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
83 stdout, line_terminator);
86 static const char *get_tag(const struct cache_entry *ce, const char *tag)
88 static char alttag[4];
90 if (tag && *tag && ((show_valid_bit && (ce->ce_flags & CE_VALID)) ||
91 (show_fsmonitor_bit && (ce->ce_flags & CE_FSMONITOR_VALID)))) {
92 memcpy(alttag, tag, 3);
94 if (isalpha(tag[0])) {
95 alttag[0] = tolower(tag[0]);
96 } else if (tag[0] == '?') {
111 static void print_debug(const struct cache_entry *ce)
114 const struct stat_data *sd = &ce->ce_stat_data;
116 printf(" ctime: %u:%u\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
117 printf(" mtime: %u:%u\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
118 printf(" dev: %u\tino: %u\n", sd->sd_dev, sd->sd_ino);
119 printf(" uid: %u\tgid: %u\n", sd->sd_uid, sd->sd_gid);
120 printf(" size: %u\tflags: %x\n", sd->sd_size, ce->ce_flags);
124 static void show_dir_entry(const struct index_state *istate,
125 const char *tag, struct dir_entry *ent)
127 int len = max_prefix_len;
130 die("git ls-files: internal error - directory entry not superset of prefix");
132 /* If ps_matches is non-NULL, figure out which pathspec(s) match. */
134 dir_path_match(istate, ent, &pathspec, len, ps_matched);
137 write_eolinfo(istate, NULL, ent->name);
138 write_name(ent->name);
141 static void show_other_files(const struct index_state *istate,
142 const struct dir_struct *dir)
146 for (i = 0; i < dir->nr; i++) {
147 struct dir_entry *ent = dir->entries[i];
148 if (!index_name_is_other(istate, ent->name, ent->len))
150 show_dir_entry(istate, tag_other, ent);
154 static void show_killed_files(const struct index_state *istate,
155 const struct dir_struct *dir)
158 for (i = 0; i < dir->nr; i++) {
159 struct dir_entry *ent = dir->entries[i];
161 int pos, len, killed = 0;
163 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
164 sp = strchr(cp, '/');
166 /* If ent->name is prefix of an entry in the
167 * cache, it will be killed.
169 pos = index_name_pos(istate, ent->name, ent->len);
171 BUG("killed-file %.*s not found",
172 ent->len, ent->name);
174 while (pos < istate->cache_nr &&
175 ce_stage(istate->cache[pos]))
176 pos++; /* skip unmerged */
177 if (istate->cache_nr <= pos)
179 /* pos points at a name immediately after
180 * ent->name in the cache. Does it expect
181 * ent->name to be a directory?
183 len = ce_namelen(istate->cache[pos]);
184 if ((ent->len < len) &&
185 !strncmp(istate->cache[pos]->name,
186 ent->name, ent->len) &&
187 istate->cache[pos]->name[ent->len] == '/')
191 if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
192 /* If any of the leading directories in
193 * ent->name is registered in the cache,
194 * ent->name will be killed.
201 show_dir_entry(istate, tag_killed, dir->entries[i]);
205 static void show_files(struct repository *repo, struct dir_struct *dir);
207 static void show_submodule(struct repository *superproject,
208 struct dir_struct *dir, const char *path)
210 struct repository subrepo;
211 const struct submodule *sub = submodule_from_path(superproject,
214 if (repo_submodule_init(&subrepo, superproject, sub))
217 if (repo_read_index(&subrepo) < 0)
218 die("index file corrupt");
220 show_files(&subrepo, dir);
222 repo_clear(&subrepo);
225 static void show_ce(struct repository *repo, struct dir_struct *dir,
226 const struct cache_entry *ce, const char *fullname,
229 if (max_prefix_len > strlen(fullname))
230 die("git ls-files: internal error - cache entry not superset of prefix");
232 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
233 is_submodule_active(repo, ce->name)) {
234 show_submodule(repo, dir, ce->name);
235 } else if (match_pathspec(repo->index, &pathspec, fullname, strlen(fullname),
236 max_prefix_len, ps_matched,
237 S_ISDIR(ce->ce_mode) ||
238 S_ISGITLINK(ce->ce_mode))) {
239 tag = get_tag(ce, tag);
244 printf("%s%06o %s %d\t",
247 find_unique_abbrev(&ce->oid, abbrev),
250 write_eolinfo(repo->index, ce, fullname);
251 write_name(fullname);
256 static void show_ru_info(const struct index_state *istate)
258 struct string_list_item *item;
260 if (!istate->resolve_undo)
263 for_each_string_list_item(item, istate->resolve_undo) {
264 const char *path = item->string;
265 struct resolve_undo_info *ui = item->util;
269 if (len < max_prefix_len)
270 continue; /* outside of the prefix */
271 if (!match_pathspec(istate, &pathspec, path, len,
272 max_prefix_len, ps_matched, 0))
273 continue; /* uninterested */
274 for (i = 0; i < 3; i++) {
277 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
278 find_unique_abbrev(&ui->oid[i], abbrev),
285 static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
286 const char *fullname, const struct cache_entry *ce)
288 int dtype = ce_to_dtype(ce);
289 return is_excluded(dir, istate, fullname, &dtype);
292 static void construct_fullname(struct strbuf *out, const struct repository *repo,
293 const struct cache_entry *ce)
296 if (repo->submodule_prefix)
297 strbuf_addstr(out, repo->submodule_prefix);
298 strbuf_addstr(out, ce->name);
301 static void show_files(struct repository *repo, struct dir_struct *dir)
304 struct strbuf fullname = STRBUF_INIT;
306 /* For cached/deleted files we don't need to even do the readdir */
307 if (show_others || show_killed) {
309 dir->flags |= DIR_COLLECT_KILLED_ONLY;
310 fill_directory(dir, repo->index, &pathspec);
312 show_other_files(repo->index, dir);
314 show_killed_files(repo->index, dir);
317 if (!(show_cached || show_stage || show_deleted || show_modified))
319 for (i = 0; i < repo->index->cache_nr; i++) {
320 const struct cache_entry *ce = repo->index->cache[i];
324 construct_fullname(&fullname, repo, ce);
326 if ((dir->flags & DIR_SHOW_IGNORED) &&
327 !ce_excluded(dir, repo->index, fullname.buf, ce))
329 if (ce->ce_flags & CE_UPDATE)
331 if ((show_cached || show_stage) &&
332 (!show_unmerged || ce_stage(ce))) {
333 show_ce(repo, dir, ce, fullname.buf,
334 ce_stage(ce) ? tag_unmerged :
335 (ce_skip_worktree(ce) ? tag_skip_worktree :
337 if (skipping_duplicates)
338 goto skip_to_next_name;
341 if (!(show_deleted || show_modified))
343 if (ce_skip_worktree(ce))
345 stat_err = lstat(fullname.buf, &st);
346 if (stat_err && (errno != ENOENT && errno != ENOTDIR))
347 error_errno("cannot lstat '%s'", fullname.buf);
348 if (stat_err && show_deleted) {
349 show_ce(repo, dir, ce, fullname.buf, tag_removed);
350 if (skipping_duplicates)
351 goto skip_to_next_name;
354 (stat_err || ie_modified(repo->index, ce, &st, 0))) {
355 show_ce(repo, dir, ce, fullname.buf, tag_modified);
356 if (skipping_duplicates)
357 goto skip_to_next_name;
364 struct cache_entry **cache = repo->index->cache;
365 for (j = i + 1; j < repo->index->cache_nr; j++)
366 if (strcmp(ce->name, cache[j]->name))
368 i = j - 1; /* compensate for the for loop */
372 strbuf_release(&fullname);
376 * Prune the index to only contain stuff starting with "prefix"
378 static void prune_index(struct index_state *istate,
379 const char *prefix, size_t prefixlen)
382 unsigned int first, last;
384 if (!prefix || !istate->cache_nr)
386 pos = index_name_pos(istate, prefix, prefixlen);
390 last = istate->cache_nr;
391 while (last > first) {
392 int next = first + ((last - first) >> 1);
393 const struct cache_entry *ce = istate->cache[next];
394 if (!strncmp(ce->name, prefix, prefixlen)) {
400 MOVE_ARRAY(istate->cache, istate->cache + pos, last - pos);
401 istate->cache_nr = last - pos;
404 static int get_common_prefix_len(const char *common_prefix)
406 int common_prefix_len;
411 common_prefix_len = strlen(common_prefix);
414 * If the prefix has a trailing slash, strip it so that submodules wont
415 * be pruned from the index.
417 if (common_prefix[common_prefix_len - 1] == '/')
420 return common_prefix_len;
424 * Read the tree specified with --with-tree option
425 * (typically, HEAD) into stage #1 and then
426 * squash them down to stage #0. This is used for
427 * --error-unmatch to list and check the path patterns
428 * that were given from the command line. We are not
429 * going to write this index out.
431 void overlay_tree_on_index(struct index_state *istate,
432 const char *tree_name, const char *prefix)
435 struct object_id oid;
436 struct pathspec pathspec;
437 struct cache_entry *last_stage0 = NULL;
440 if (get_oid(tree_name, &oid))
441 die("tree-ish %s not found.", tree_name);
442 tree = parse_tree_indirect(&oid);
444 die("bad tree-ish %s", tree_name);
446 /* Hoist the unmerged entries up to stage #3 to make room */
447 for (i = 0; i < istate->cache_nr; i++) {
448 struct cache_entry *ce = istate->cache[i];
451 ce->ce_flags |= CE_STAGEMASK;
455 static const char *(matchbuf[1]);
457 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
458 PATHSPEC_PREFER_CWD, prefix, matchbuf);
460 memset(&pathspec, 0, sizeof(pathspec));
461 if (read_tree(the_repository, tree, 1, &pathspec, istate))
462 die("unable to read tree entries %s", tree_name);
464 for (i = 0; i < istate->cache_nr; i++) {
465 struct cache_entry *ce = istate->cache[i];
466 switch (ce_stage(ce)) {
474 * If there is stage #0 entry for this, we do not
475 * need to show it. We use CE_UPDATE bit to mark
479 !strcmp(last_stage0->name, ce->name))
480 ce->ce_flags |= CE_UPDATE;
485 static const char * const ls_files_usage[] = {
486 N_("git ls-files [<options>] [<file>...]"),
490 static int option_parse_exclude(const struct option *opt,
491 const char *arg, int unset)
493 struct string_list *exclude_list = opt->value;
495 BUG_ON_OPT_NEG(unset);
498 string_list_append(exclude_list, arg);
503 static int option_parse_exclude_from(const struct option *opt,
504 const char *arg, int unset)
506 struct dir_struct *dir = opt->value;
508 BUG_ON_OPT_NEG(unset);
511 add_patterns_from_file(dir, arg);
516 static int option_parse_exclude_standard(const struct option *opt,
517 const char *arg, int unset)
519 struct dir_struct *dir = opt->value;
521 BUG_ON_OPT_NEG(unset);
525 setup_standard_excludes(dir);
530 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
532 int require_work_tree = 0, show_tag = 0, i;
533 const char *max_prefix;
534 struct dir_struct dir;
535 struct pattern_list *pl;
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('f', NULL, &show_fsmonitor_bit,
546 N_("use lowercase letters for 'fsmonitor clean' files")),
547 OPT_BOOL('c', "cached", &show_cached,
548 N_("show cached files in the output (default)")),
549 OPT_BOOL('d', "deleted", &show_deleted,
550 N_("show deleted files in the output")),
551 OPT_BOOL('m', "modified", &show_modified,
552 N_("show modified files in the output")),
553 OPT_BOOL('o', "others", &show_others,
554 N_("show other files in the output")),
555 OPT_BIT('i', "ignored", &dir.flags,
556 N_("show ignored files in the output"),
558 OPT_BOOL('s', "stage", &show_stage,
559 N_("show staged contents' object name in the output")),
560 OPT_BOOL('k', "killed", &show_killed,
561 N_("show files on the filesystem that need to be removed")),
562 OPT_BIT(0, "directory", &dir.flags,
563 N_("show 'other' directories' names only"),
564 DIR_SHOW_OTHER_DIRECTORIES),
565 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
566 OPT_NEGBIT(0, "empty-directory", &dir.flags,
567 N_("don't show empty directories"),
568 DIR_HIDE_EMPTY_DIRECTORIES),
569 OPT_BOOL('u', "unmerged", &show_unmerged,
570 N_("show unmerged files in the output")),
571 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
572 N_("show resolve-undo information")),
573 OPT_CALLBACK_F('x', "exclude", &exclude_list, N_("pattern"),
574 N_("skip files matching pattern"),
575 PARSE_OPT_NONEG, option_parse_exclude),
576 OPT_CALLBACK_F('X', "exclude-from", &dir, N_("file"),
577 N_("exclude patterns are read from <file>"),
578 PARSE_OPT_NONEG, option_parse_exclude_from),
579 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
580 N_("read additional per-directory exclude patterns in <file>")),
581 OPT_CALLBACK_F(0, "exclude-standard", &dir, NULL,
582 N_("add the standard git exclusions"),
583 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
584 option_parse_exclude_standard),
585 OPT_SET_INT_F(0, "full-name", &prefix_len,
586 N_("make the output relative to the project top directory"),
588 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
589 N_("recurse through submodules")),
590 OPT_BOOL(0, "error-unmatch", &error_unmatch,
591 N_("if any <file> is not in the index, treat this as an error")),
592 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
593 N_("pretend that paths removed since <tree-ish> are still present")),
594 OPT__ABBREV(&abbrev),
595 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
596 OPT_BOOL(0, "deduplicate", &skipping_duplicates,
597 N_("suppress duplicate entries")),
601 if (argc == 2 && !strcmp(argv[1], "-h"))
602 usage_with_options(ls_files_usage, builtin_ls_files_options);
607 prefix_len = strlen(prefix);
608 git_config(git_default_config, NULL);
610 if (repo_read_index(the_repository) < 0)
611 die("index file corrupt");
613 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
615 pl = add_pattern_list(&dir, EXC_CMDL, "--exclude option");
616 for (i = 0; i < exclude_list.nr; i++) {
617 add_pattern(exclude_list.items[i].string, "", 0, pl, --exclude_args);
619 if (show_tag || show_valid_bit || show_fsmonitor_bit) {
626 tag_skip_worktree = "S ";
627 tag_resolve_undo = "U ";
629 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
630 require_work_tree = 1;
633 * There's no point in showing unmerged unless
634 * you also show the stage information.
637 if (show_tag || show_stage)
638 skipping_duplicates = 0;
639 if (dir.exclude_per_dir)
642 if (require_work_tree && !is_inside_work_tree())
645 if (recurse_submodules &&
646 (show_stage || show_deleted || show_others || show_unmerged ||
647 show_killed || show_modified || show_resolve_undo || with_tree))
648 die("ls-files --recurse-submodules unsupported mode");
650 if (recurse_submodules && error_unmatch)
651 die("ls-files --recurse-submodules does not support "
654 parse_pathspec(&pathspec, 0,
659 * Find common prefix for all pathspec's
660 * This is used as a performance optimization which unfortunately cannot
661 * be done when recursing into submodules because when a pathspec is
662 * given which spans repository boundaries you can't simply remove the
663 * submodule entry because the pathspec may match something inside the
666 if (recurse_submodules)
669 max_prefix = common_prefix(&pathspec);
670 max_prefix_len = get_common_prefix_len(max_prefix);
672 prune_index(the_repository->index, max_prefix, max_prefix_len);
674 /* Treat unmatching pathspec elements as errors */
675 if (pathspec.nr && error_unmatch)
676 ps_matched = xcalloc(pathspec.nr, 1);
678 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
679 die("ls-files --ignored needs some exclude pattern");
681 /* With no flags, we default to showing the cached files */
682 if (!(show_stage || show_deleted || show_others || show_unmerged ||
683 show_killed || show_modified || show_resolve_undo))
688 * Basic sanity check; show-stages and show-unmerged
689 * would not make any sense with this option.
691 if (show_stage || show_unmerged)
692 die("ls-files --with-tree is incompatible with -s or -u");
693 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
696 show_files(the_repository, &dir);
698 if (show_resolve_undo)
699 show_ru_info(the_repository->index);
703 bad = report_path_error(ps_matched, &pathspec);
705 fprintf(stderr, "Did you forget to 'git add'?\n");