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
;
39 static const char *prefix
;
40 static int max_prefix_len
;
41 static int prefix_len
;
42 static struct pathspec pathspec
;
43 static int error_unmatch
;
44 static char *ps_matched
;
45 static const char *with_tree
;
47 static int exclude_args
;
49 static const char *tag_cached
= "";
50 static const char *tag_unmerged
= "";
51 static const char *tag_removed
= "";
52 static const char *tag_other
= "";
53 static const char *tag_killed
= "";
54 static const char *tag_modified
= "";
55 static const char *tag_skip_worktree
= "";
56 static const char *tag_resolve_undo
= "";
58 static void write_eolinfo(const struct index_state
*istate
,
59 const struct cache_entry
*ce
, const char *path
)
63 const char *i_txt
= "";
64 const char *w_txt
= "";
65 const char *a_txt
= get_convert_attr_ascii(istate
, path
);
66 if (ce
&& S_ISREG(ce
->ce_mode
))
67 i_txt
= get_cached_convert_stats_ascii(istate
,
69 if (!lstat(path
, &st
) && S_ISREG(st
.st_mode
))
70 w_txt
= get_wt_convert_stats_ascii(path
);
71 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt
, w_txt
, a_txt
);
75 static void write_name(const char *name
)
78 * With "--full-name", prefix_len=0; this caller needs to pass
79 * an empty string in that case (a NULL is good for "").
81 write_name_quoted_relative(name
, prefix_len
? prefix
: NULL
,
82 stdout
, line_terminator
);
85 static const char *get_tag(const struct cache_entry
*ce
, const char *tag
)
87 static char alttag
[4];
89 if (tag
&& *tag
&& ((show_valid_bit
&& (ce
->ce_flags
& CE_VALID
)) ||
90 (show_fsmonitor_bit
&& (ce
->ce_flags
& CE_FSMONITOR_VALID
)))) {
91 memcpy(alttag
, tag
, 3);
93 if (isalpha(tag
[0])) {
94 alttag
[0] = tolower(tag
[0]);
95 } else if (tag
[0] == '?') {
110 static void print_debug(const struct cache_entry
*ce
)
113 const struct stat_data
*sd
= &ce
->ce_stat_data
;
115 printf(" ctime: %u:%u\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
116 printf(" mtime: %u:%u\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
117 printf(" dev: %u\tino: %u\n", sd
->sd_dev
, sd
->sd_ino
);
118 printf(" uid: %u\tgid: %u\n", sd
->sd_uid
, sd
->sd_gid
);
119 printf(" size: %u\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
123 static void show_dir_entry(const struct index_state
*istate
,
124 const char *tag
, struct dir_entry
*ent
)
126 int len
= max_prefix_len
;
129 die("git ls-files: internal error - directory entry not superset of prefix");
131 /* If ps_matches is non-NULL, figure out which pathspec(s) match. */
133 dir_path_match(istate
, ent
, &pathspec
, len
, ps_matched
);
136 write_eolinfo(istate
, NULL
, ent
->name
);
137 write_name(ent
->name
);
140 static void show_other_files(const struct index_state
*istate
,
141 const struct dir_struct
*dir
)
145 for (i
= 0; i
< dir
->nr
; i
++) {
146 struct dir_entry
*ent
= dir
->entries
[i
];
147 if (!index_name_is_other(istate
, ent
->name
, ent
->len
))
149 show_dir_entry(istate
, tag_other
, ent
);
153 static void show_killed_files(const struct index_state
*istate
,
154 const struct dir_struct
*dir
)
157 for (i
= 0; i
< dir
->nr
; i
++) {
158 struct dir_entry
*ent
= dir
->entries
[i
];
160 int pos
, len
, killed
= 0;
162 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
163 sp
= strchr(cp
, '/');
165 /* If ent->name is prefix of an entry in the
166 * cache, it will be killed.
168 pos
= index_name_pos(istate
, ent
->name
, ent
->len
);
170 BUG("killed-file %.*s not found",
171 ent
->len
, ent
->name
);
173 while (pos
< istate
->cache_nr
&&
174 ce_stage(istate
->cache
[pos
]))
175 pos
++; /* skip unmerged */
176 if (istate
->cache_nr
<= pos
)
178 /* pos points at a name immediately after
179 * ent->name in the cache. Does it expect
180 * ent->name to be a directory?
182 len
= ce_namelen(istate
->cache
[pos
]);
183 if ((ent
->len
< len
) &&
184 !strncmp(istate
->cache
[pos
]->name
,
185 ent
->name
, ent
->len
) &&
186 istate
->cache
[pos
]->name
[ent
->len
] == '/')
190 if (0 <= index_name_pos(istate
, ent
->name
, sp
- ent
->name
)) {
191 /* If any of the leading directories in
192 * ent->name is registered in the cache,
193 * ent->name will be killed.
200 show_dir_entry(istate
, tag_killed
, dir
->entries
[i
]);
204 static void show_files(struct repository
*repo
, struct dir_struct
*dir
);
206 static void show_submodule(struct repository
*superproject
,
207 struct dir_struct
*dir
, const char *path
)
209 struct repository subrepo
;
210 const struct submodule
*sub
= submodule_from_path(superproject
,
213 if (repo_submodule_init(&subrepo
, superproject
, sub
))
216 if (repo_read_index(&subrepo
) < 0)
217 die("index file corrupt");
219 show_files(&subrepo
, dir
);
221 repo_clear(&subrepo
);
224 static void show_ce(struct repository
*repo
, struct dir_struct
*dir
,
225 const struct cache_entry
*ce
, const char *fullname
,
228 if (max_prefix_len
> strlen(fullname
))
229 die("git ls-files: internal error - cache entry not superset of prefix");
231 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
232 is_submodule_active(repo
, ce
->name
)) {
233 show_submodule(repo
, dir
, ce
->name
);
234 } else if (match_pathspec(repo
->index
, &pathspec
, fullname
, strlen(fullname
),
235 max_prefix_len
, ps_matched
,
236 S_ISDIR(ce
->ce_mode
) ||
237 S_ISGITLINK(ce
->ce_mode
))) {
238 tag
= get_tag(ce
, tag
);
243 printf("%s%06o %s %d\t",
246 find_unique_abbrev(&ce
->oid
, abbrev
),
249 write_eolinfo(repo
->index
, ce
, fullname
);
250 write_name(fullname
);
255 static void show_ru_info(const struct index_state
*istate
)
257 struct string_list_item
*item
;
259 if (!istate
->resolve_undo
)
262 for_each_string_list_item(item
, istate
->resolve_undo
) {
263 const char *path
= item
->string
;
264 struct resolve_undo_info
*ui
= item
->util
;
268 if (len
< max_prefix_len
)
269 continue; /* outside of the prefix */
270 if (!match_pathspec(istate
, &pathspec
, path
, len
,
271 max_prefix_len
, ps_matched
, 0))
272 continue; /* uninterested */
273 for (i
= 0; i
< 3; i
++) {
276 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
277 find_unique_abbrev(&ui
->oid
[i
], abbrev
),
284 static int ce_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
285 const char *fullname
, const struct cache_entry
*ce
)
287 int dtype
= ce_to_dtype(ce
);
288 return is_excluded(dir
, istate
, fullname
, &dtype
);
291 static void construct_fullname(struct strbuf
*out
, const struct repository
*repo
,
292 const struct cache_entry
*ce
)
295 if (repo
->submodule_prefix
)
296 strbuf_addstr(out
, repo
->submodule_prefix
);
297 strbuf_addstr(out
, ce
->name
);
300 static void show_files(struct repository
*repo
, struct dir_struct
*dir
)
303 struct strbuf fullname
= STRBUF_INIT
;
305 /* For cached/deleted files we don't need to even do the readdir */
306 if (show_others
|| show_killed
) {
308 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
309 fill_directory(dir
, repo
->index
, &pathspec
);
311 show_other_files(repo
->index
, dir
);
313 show_killed_files(repo
->index
, dir
);
315 if (show_cached
|| show_stage
) {
316 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
317 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
319 construct_fullname(&fullname
, repo
, ce
);
321 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
322 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
324 if (show_unmerged
&& !ce_stage(ce
))
326 if (ce
->ce_flags
& CE_UPDATE
)
328 show_ce(repo
, dir
, ce
, fullname
.buf
,
329 ce_stage(ce
) ? tag_unmerged
:
330 (ce_skip_worktree(ce
) ? tag_skip_worktree
:
334 if (show_deleted
|| show_modified
) {
335 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
336 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
340 construct_fullname(&fullname
, repo
, ce
);
342 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
343 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
345 if (ce
->ce_flags
& CE_UPDATE
)
347 if (ce_skip_worktree(ce
))
349 err
= lstat(fullname
.buf
, &st
);
350 if (show_deleted
&& err
)
351 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_removed
);
352 if (show_modified
&& ie_modified(repo
->index
, ce
, &st
, 0))
353 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_modified
);
357 strbuf_release(&fullname
);
361 * Prune the index to only contain stuff starting with "prefix"
363 static void prune_index(struct index_state
*istate
,
364 const char *prefix
, size_t prefixlen
)
367 unsigned int first
, last
;
369 if (!prefix
|| !istate
->cache_nr
)
371 pos
= index_name_pos(istate
, prefix
, prefixlen
);
375 last
= istate
->cache_nr
;
376 while (last
> first
) {
377 int next
= first
+ ((last
- first
) >> 1);
378 const struct cache_entry
*ce
= istate
->cache
[next
];
379 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
385 MOVE_ARRAY(istate
->cache
, istate
->cache
+ pos
, last
- pos
);
386 istate
->cache_nr
= last
- pos
;
389 static int get_common_prefix_len(const char *common_prefix
)
391 int common_prefix_len
;
396 common_prefix_len
= strlen(common_prefix
);
399 * If the prefix has a trailing slash, strip it so that submodules wont
400 * be pruned from the index.
402 if (common_prefix
[common_prefix_len
- 1] == '/')
405 return common_prefix_len
;
409 * Read the tree specified with --with-tree option
410 * (typically, HEAD) into stage #1 and then
411 * squash them down to stage #0. This is used for
412 * --error-unmatch to list and check the path patterns
413 * that were given from the command line. We are not
414 * going to write this index out.
416 void overlay_tree_on_index(struct index_state
*istate
,
417 const char *tree_name
, const char *prefix
)
420 struct object_id oid
;
421 struct pathspec pathspec
;
422 struct cache_entry
*last_stage0
= NULL
;
425 if (get_oid(tree_name
, &oid
))
426 die("tree-ish %s not found.", tree_name
);
427 tree
= parse_tree_indirect(&oid
);
429 die("bad tree-ish %s", tree_name
);
431 /* Hoist the unmerged entries up to stage #3 to make room */
432 for (i
= 0; i
< istate
->cache_nr
; i
++) {
433 struct cache_entry
*ce
= istate
->cache
[i
];
436 ce
->ce_flags
|= CE_STAGEMASK
;
440 static const char *(matchbuf
[1]);
442 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
443 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
445 memset(&pathspec
, 0, sizeof(pathspec
));
446 if (read_tree(the_repository
, tree
, 1, &pathspec
, istate
))
447 die("unable to read tree entries %s", tree_name
);
449 for (i
= 0; i
< istate
->cache_nr
; i
++) {
450 struct cache_entry
*ce
= istate
->cache
[i
];
451 switch (ce_stage(ce
)) {
459 * If there is stage #0 entry for this, we do not
460 * need to show it. We use CE_UPDATE bit to mark
464 !strcmp(last_stage0
->name
, ce
->name
))
465 ce
->ce_flags
|= CE_UPDATE
;
470 static const char * const ls_files_usage
[] = {
471 N_("git ls-files [<options>] [<file>...]"),
475 static int option_parse_exclude(const struct option
*opt
,
476 const char *arg
, int unset
)
478 struct string_list
*exclude_list
= opt
->value
;
480 BUG_ON_OPT_NEG(unset
);
483 string_list_append(exclude_list
, arg
);
488 static int option_parse_exclude_from(const struct option
*opt
,
489 const char *arg
, int unset
)
491 struct dir_struct
*dir
= opt
->value
;
493 BUG_ON_OPT_NEG(unset
);
496 add_patterns_from_file(dir
, arg
);
501 static int option_parse_exclude_standard(const struct option
*opt
,
502 const char *arg
, int unset
)
504 struct dir_struct
*dir
= opt
->value
;
506 BUG_ON_OPT_NEG(unset
);
510 setup_standard_excludes(dir
);
515 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
517 int require_work_tree
= 0, show_tag
= 0, i
;
518 const char *max_prefix
;
519 struct dir_struct dir
;
520 struct pattern_list
*pl
;
521 struct string_list exclude_list
= STRING_LIST_INIT_NODUP
;
522 struct option builtin_ls_files_options
[] = {
523 /* Think twice before adding "--nul" synonym to this */
524 OPT_SET_INT('z', NULL
, &line_terminator
,
525 N_("paths are separated with NUL character"), '\0'),
526 OPT_BOOL('t', NULL
, &show_tag
,
527 N_("identify the file status with tags")),
528 OPT_BOOL('v', NULL
, &show_valid_bit
,
529 N_("use lowercase letters for 'assume unchanged' files")),
530 OPT_BOOL('f', NULL
, &show_fsmonitor_bit
,
531 N_("use lowercase letters for 'fsmonitor clean' files")),
532 OPT_BOOL('c', "cached", &show_cached
,
533 N_("show cached files in the output (default)")),
534 OPT_BOOL('d', "deleted", &show_deleted
,
535 N_("show deleted files in the output")),
536 OPT_BOOL('m', "modified", &show_modified
,
537 N_("show modified files in the output")),
538 OPT_BOOL('o', "others", &show_others
,
539 N_("show other files in the output")),
540 OPT_BIT('i', "ignored", &dir
.flags
,
541 N_("show ignored files in the output"),
543 OPT_BOOL('s', "stage", &show_stage
,
544 N_("show staged contents' object name in the output")),
545 OPT_BOOL('k', "killed", &show_killed
,
546 N_("show files on the filesystem that need to be removed")),
547 OPT_BIT(0, "directory", &dir
.flags
,
548 N_("show 'other' directories' names only"),
549 DIR_SHOW_OTHER_DIRECTORIES
),
550 OPT_BOOL(0, "eol", &show_eol
, N_("show line endings of files")),
551 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
552 N_("don't show empty directories"),
553 DIR_HIDE_EMPTY_DIRECTORIES
),
554 OPT_BOOL('u', "unmerged", &show_unmerged
,
555 N_("show unmerged files in the output")),
556 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
557 N_("show resolve-undo information")),
558 OPT_CALLBACK_F('x', "exclude", &exclude_list
, N_("pattern"),
559 N_("skip files matching pattern"),
560 PARSE_OPT_NONEG
, option_parse_exclude
),
561 OPT_CALLBACK_F('X', "exclude-from", &dir
, N_("file"),
562 N_("exclude patterns are read from <file>"),
563 PARSE_OPT_NONEG
, option_parse_exclude_from
),
564 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
565 N_("read additional per-directory exclude patterns in <file>")),
566 OPT_CALLBACK_F(0, "exclude-standard", &dir
, NULL
,
567 N_("add the standard git exclusions"),
568 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
,
569 option_parse_exclude_standard
),
570 OPT_SET_INT_F(0, "full-name", &prefix_len
,
571 N_("make the output relative to the project top directory"),
573 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
574 N_("recurse through submodules")),
575 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
576 N_("if any <file> is not in the index, treat this as an error")),
577 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
578 N_("pretend that paths removed since <tree-ish> are still present")),
579 OPT__ABBREV(&abbrev
),
580 OPT_BOOL(0, "debug", &debug_mode
, N_("show debugging data")),
584 if (argc
== 2 && !strcmp(argv
[1], "-h"))
585 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
587 memset(&dir
, 0, sizeof(dir
));
590 prefix_len
= strlen(prefix
);
591 git_config(git_default_config
, NULL
);
593 if (repo_read_index(the_repository
) < 0)
594 die("index file corrupt");
596 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
598 pl
= add_pattern_list(&dir
, EXC_CMDL
, "--exclude option");
599 for (i
= 0; i
< exclude_list
.nr
; i
++) {
600 add_pattern(exclude_list
.items
[i
].string
, "", 0, pl
, --exclude_args
);
602 if (show_tag
|| show_valid_bit
|| show_fsmonitor_bit
) {
609 tag_skip_worktree
= "S ";
610 tag_resolve_undo
= "U ";
612 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
613 require_work_tree
= 1;
616 * There's no point in showing unmerged unless
617 * you also show the stage information.
620 if (dir
.exclude_per_dir
)
623 if (require_work_tree
&& !is_inside_work_tree())
626 if (recurse_submodules
&&
627 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
628 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
629 die("ls-files --recurse-submodules unsupported mode");
631 if (recurse_submodules
&& error_unmatch
)
632 die("ls-files --recurse-submodules does not support "
635 parse_pathspec(&pathspec
, 0,
640 * Find common prefix for all pathspec's
641 * This is used as a performance optimization which unfortunately cannot
642 * be done when recursing into submodules because when a pathspec is
643 * given which spans repository boundaries you can't simply remove the
644 * submodule entry because the pathspec may match something inside the
647 if (recurse_submodules
)
650 max_prefix
= common_prefix(&pathspec
);
651 max_prefix_len
= get_common_prefix_len(max_prefix
);
653 prune_index(the_repository
->index
, max_prefix
, max_prefix_len
);
655 /* Treat unmatching pathspec elements as errors */
656 if (pathspec
.nr
&& error_unmatch
)
657 ps_matched
= xcalloc(pathspec
.nr
, 1);
659 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
660 die("ls-files --ignored needs some exclude pattern");
662 /* With no flags, we default to showing the cached files */
663 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
664 show_killed
|| show_modified
|| show_resolve_undo
))
669 * Basic sanity check; show-stages and show-unmerged
670 * would not make any sense with this option.
672 if (show_stage
|| show_unmerged
)
673 die("ls-files --with-tree is incompatible with -s or -u");
674 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
677 show_files(the_repository
, &dir
);
679 if (show_resolve_undo
)
680 show_ru_info(the_repository
->index
);
684 bad
= report_path_error(ps_matched
, &pathspec
);
686 fprintf(stderr
, "Did you forget to 'git add'?\n");