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
8 #define NO_THE_INDEX_COMPATIBILITY_MACROS
10 #include "repository.h"
16 #include "parse-options.h"
17 #include "resolve-undo.h"
18 #include "string-list.h"
20 #include "run-command.h"
21 #include "submodule.h"
22 #include "submodule-config.h"
25 static int show_deleted
;
26 static int show_cached
;
27 static int show_others
;
28 static int show_stage
;
29 static int show_unmerged
;
30 static int show_resolve_undo
;
31 static int show_modified
;
32 static int show_killed
;
33 static int show_valid_bit
;
34 static int show_fsmonitor_bit
;
35 static int line_terminator
= '\n';
36 static int debug_mode
;
38 static int recurse_submodules
;
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(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: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
117 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
118 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
119 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
120 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
124 static void show_dir_entry(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 (!dir_path_match(ent
, &pathspec
, len
, ps_matched
))
135 write_eolinfo(NULL
, NULL
, ent
->name
);
136 write_name(ent
->name
);
139 static void show_other_files(const struct index_state
*istate
,
140 const struct dir_struct
*dir
)
144 for (i
= 0; i
< dir
->nr
; i
++) {
145 struct dir_entry
*ent
= dir
->entries
[i
];
146 if (!index_name_is_other(istate
, ent
->name
, ent
->len
))
148 show_dir_entry(tag_other
, ent
);
152 static void show_killed_files(const struct index_state
*istate
,
153 const struct dir_struct
*dir
)
156 for (i
= 0; i
< dir
->nr
; i
++) {
157 struct dir_entry
*ent
= dir
->entries
[i
];
159 int pos
, len
, killed
= 0;
161 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
162 sp
= strchr(cp
, '/');
164 /* If ent->name is prefix of an entry in the
165 * cache, it will be killed.
167 pos
= index_name_pos(istate
, ent
->name
, ent
->len
);
169 die("BUG: killed-file %.*s not found",
170 ent
->len
, ent
->name
);
172 while (pos
< istate
->cache_nr
&&
173 ce_stage(istate
->cache
[pos
]))
174 pos
++; /* skip unmerged */
175 if (istate
->cache_nr
<= pos
)
177 /* pos points at a name immediately after
178 * ent->name in the cache. Does it expect
179 * ent->name to be a directory?
181 len
= ce_namelen(istate
->cache
[pos
]);
182 if ((ent
->len
< len
) &&
183 !strncmp(istate
->cache
[pos
]->name
,
184 ent
->name
, ent
->len
) &&
185 istate
->cache
[pos
]->name
[ent
->len
] == '/')
189 if (0 <= index_name_pos(istate
, ent
->name
, sp
- ent
->name
)) {
190 /* If any of the leading directories in
191 * ent->name is registered in the cache,
192 * ent->name will be killed.
199 show_dir_entry(tag_killed
, dir
->entries
[i
]);
203 static void show_files(struct repository
*repo
, struct dir_struct
*dir
);
205 static void show_submodule(struct repository
*superproject
,
206 struct dir_struct
*dir
, const char *path
)
208 struct repository submodule
;
210 if (repo_submodule_init(&submodule
, superproject
, path
))
213 if (repo_read_index(&submodule
) < 0)
214 die("index file corrupt");
216 show_files(&submodule
, dir
);
218 repo_clear(&submodule
);
221 static void show_ce(struct repository
*repo
, struct dir_struct
*dir
,
222 const struct cache_entry
*ce
, const char *fullname
,
225 if (max_prefix_len
> strlen(fullname
))
226 die("git ls-files: internal error - cache entry not superset of prefix");
228 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
229 is_submodule_active(repo
, ce
->name
)) {
230 show_submodule(repo
, dir
, ce
->name
);
231 } else if (match_pathspec(&pathspec
, fullname
, strlen(fullname
),
232 max_prefix_len
, ps_matched
,
233 S_ISDIR(ce
->ce_mode
) ||
234 S_ISGITLINK(ce
->ce_mode
))) {
235 tag
= get_tag(ce
, tag
);
240 printf("%s%06o %s %d\t",
243 find_unique_abbrev(&ce
->oid
, abbrev
),
246 write_eolinfo(repo
->index
, ce
, fullname
);
247 write_name(fullname
);
252 static void show_ru_info(const struct index_state
*istate
)
254 struct string_list_item
*item
;
256 if (!istate
->resolve_undo
)
259 for_each_string_list_item(item
, istate
->resolve_undo
) {
260 const char *path
= item
->string
;
261 struct resolve_undo_info
*ui
= item
->util
;
265 if (len
< max_prefix_len
)
266 continue; /* outside of the prefix */
267 if (!match_pathspec(&pathspec
, path
, len
,
268 max_prefix_len
, ps_matched
, 0))
269 continue; /* uninterested */
270 for (i
= 0; i
< 3; i
++) {
273 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
274 find_unique_abbrev(&ui
->oid
[i
], abbrev
),
281 static int ce_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
282 const char *fullname
, const struct cache_entry
*ce
)
284 int dtype
= ce_to_dtype(ce
);
285 return is_excluded(dir
, istate
, fullname
, &dtype
);
288 static void construct_fullname(struct strbuf
*out
, const struct repository
*repo
,
289 const struct cache_entry
*ce
)
292 if (repo
->submodule_prefix
)
293 strbuf_addstr(out
, repo
->submodule_prefix
);
294 strbuf_addstr(out
, ce
->name
);
297 static void show_files(struct repository
*repo
, struct dir_struct
*dir
)
300 struct strbuf fullname
= STRBUF_INIT
;
302 /* For cached/deleted files we don't need to even do the readdir */
303 if (show_others
|| show_killed
) {
305 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
306 fill_directory(dir
, repo
->index
, &pathspec
);
308 show_other_files(repo
->index
, dir
);
310 show_killed_files(repo
->index
, dir
);
312 if (show_cached
|| show_stage
) {
313 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
314 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
316 construct_fullname(&fullname
, repo
, ce
);
318 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
319 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
321 if (show_unmerged
&& !ce_stage(ce
))
323 if (ce
->ce_flags
& CE_UPDATE
)
325 show_ce(repo
, dir
, ce
, fullname
.buf
,
326 ce_stage(ce
) ? tag_unmerged
:
327 (ce_skip_worktree(ce
) ? tag_skip_worktree
:
331 if (show_deleted
|| show_modified
) {
332 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
333 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
337 construct_fullname(&fullname
, repo
, ce
);
339 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
340 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
342 if (ce
->ce_flags
& CE_UPDATE
)
344 if (ce_skip_worktree(ce
))
346 err
= lstat(fullname
.buf
, &st
);
347 if (show_deleted
&& err
)
348 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_removed
);
349 if (show_modified
&& ie_modified(repo
->index
, ce
, &st
, 0))
350 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_modified
);
354 strbuf_release(&fullname
);
358 * Prune the index to only contain stuff starting with "prefix"
360 static void prune_index(struct index_state
*istate
,
361 const char *prefix
, size_t prefixlen
)
364 unsigned int first
, last
;
366 if (!prefix
|| !istate
->cache_nr
)
368 pos
= index_name_pos(istate
, prefix
, prefixlen
);
372 last
= istate
->cache_nr
;
373 while (last
> first
) {
374 int next
= (last
+ first
) >> 1;
375 const struct cache_entry
*ce
= istate
->cache
[next
];
376 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
382 MOVE_ARRAY(istate
->cache
, istate
->cache
+ pos
, last
- pos
);
383 istate
->cache_nr
= last
- pos
;
386 static int get_common_prefix_len(const char *common_prefix
)
388 int common_prefix_len
;
393 common_prefix_len
= strlen(common_prefix
);
396 * If the prefix has a trailing slash, strip it so that submodules wont
397 * be pruned from the index.
399 if (common_prefix
[common_prefix_len
- 1] == '/')
402 return common_prefix_len
;
406 * Read the tree specified with --with-tree option
407 * (typically, HEAD) into stage #1 and then
408 * squash them down to stage #0. This is used for
409 * --error-unmatch to list and check the path patterns
410 * that were given from the command line. We are not
411 * going to write this index out.
413 void overlay_tree_on_index(struct index_state
*istate
,
414 const char *tree_name
, const char *prefix
)
417 struct object_id oid
;
418 struct pathspec pathspec
;
419 struct cache_entry
*last_stage0
= NULL
;
422 if (get_oid(tree_name
, &oid
))
423 die("tree-ish %s not found.", tree_name
);
424 tree
= parse_tree_indirect(&oid
);
426 die("bad tree-ish %s", tree_name
);
428 /* Hoist the unmerged entries up to stage #3 to make room */
429 for (i
= 0; i
< istate
->cache_nr
; i
++) {
430 struct cache_entry
*ce
= istate
->cache
[i
];
433 ce
->ce_flags
|= CE_STAGEMASK
;
437 static const char *(matchbuf
[1]);
439 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
440 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
442 memset(&pathspec
, 0, sizeof(pathspec
));
443 if (read_tree(tree
, 1, &pathspec
, istate
))
444 die("unable to read tree entries %s", tree_name
);
446 for (i
= 0; i
< istate
->cache_nr
; i
++) {
447 struct cache_entry
*ce
= istate
->cache
[i
];
448 switch (ce_stage(ce
)) {
456 * If there is stage #0 entry for this, we do not
457 * need to show it. We use CE_UPDATE bit to mark
461 !strcmp(last_stage0
->name
, ce
->name
))
462 ce
->ce_flags
|= CE_UPDATE
;
467 static const char * const ls_files_usage
[] = {
468 N_("git ls-files [<options>] [<file>...]"),
472 static int option_parse_exclude(const struct option
*opt
,
473 const char *arg
, int unset
)
475 struct string_list
*exclude_list
= opt
->value
;
478 string_list_append(exclude_list
, arg
);
483 static int option_parse_exclude_from(const struct option
*opt
,
484 const char *arg
, int unset
)
486 struct dir_struct
*dir
= opt
->value
;
489 add_excludes_from_file(dir
, arg
);
494 static int option_parse_exclude_standard(const struct option
*opt
,
495 const char *arg
, int unset
)
497 struct dir_struct
*dir
= opt
->value
;
500 setup_standard_excludes(dir
);
505 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
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('f', NULL
, &show_fsmonitor_bit
,
521 N_("use lowercase letters for 'fsmonitor clean' files")),
522 OPT_BOOL('c', "cached", &show_cached
,
523 N_("show cached files in the output (default)")),
524 OPT_BOOL('d', "deleted", &show_deleted
,
525 N_("show deleted files in the output")),
526 OPT_BOOL('m', "modified", &show_modified
,
527 N_("show modified files in the output")),
528 OPT_BOOL('o', "others", &show_others
,
529 N_("show other files in the output")),
530 OPT_BIT('i', "ignored", &dir
.flags
,
531 N_("show ignored files in the output"),
533 OPT_BOOL('s', "stage", &show_stage
,
534 N_("show staged contents' object name in the output")),
535 OPT_BOOL('k', "killed", &show_killed
,
536 N_("show files on the filesystem that need to be removed")),
537 OPT_BIT(0, "directory", &dir
.flags
,
538 N_("show 'other' directories' names only"),
539 DIR_SHOW_OTHER_DIRECTORIES
),
540 OPT_BOOL(0, "eol", &show_eol
, N_("show line endings of files")),
541 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
542 N_("don't show empty directories"),
543 DIR_HIDE_EMPTY_DIRECTORIES
),
544 OPT_BOOL('u', "unmerged", &show_unmerged
,
545 N_("show unmerged files in the output")),
546 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
547 N_("show resolve-undo information")),
548 { OPTION_CALLBACK
, 'x', "exclude", &exclude_list
, N_("pattern"),
549 N_("skip files matching pattern"),
550 0, option_parse_exclude
},
551 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, N_("file"),
552 N_("exclude patterns are read from <file>"),
553 0, option_parse_exclude_from
},
554 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
555 N_("read additional per-directory exclude patterns in <file>")),
556 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
557 N_("add the standard git exclusions"),
558 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
559 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
560 N_("make the output relative to the project top directory"),
561 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
562 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
563 N_("recurse through submodules")),
564 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
565 N_("if any <file> is not in the index, treat this as an error")),
566 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
567 N_("pretend that paths removed since <tree-ish> are still present")),
568 OPT__ABBREV(&abbrev
),
569 OPT_BOOL(0, "debug", &debug_mode
, N_("show debugging data")),
573 if (argc
== 2 && !strcmp(argv
[1], "-h"))
574 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
576 memset(&dir
, 0, sizeof(dir
));
579 prefix_len
= strlen(prefix
);
580 git_config(git_default_config
, NULL
);
582 if (repo_read_index(the_repository
) < 0)
583 die("index file corrupt");
585 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
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
);
591 if (show_tag
|| show_valid_bit
|| show_fsmonitor_bit
) {
598 tag_skip_worktree
= "S ";
599 tag_resolve_undo
= "U ";
601 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
602 require_work_tree
= 1;
605 * There's no point in showing unmerged unless
606 * you also show the stage information.
609 if (dir
.exclude_per_dir
)
612 if (require_work_tree
&& !is_inside_work_tree())
615 if (recurse_submodules
&&
616 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
617 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
618 die("ls-files --recurse-submodules unsupported mode");
620 if (recurse_submodules
&& error_unmatch
)
621 die("ls-files --recurse-submodules does not support "
624 parse_pathspec(&pathspec
, 0,
629 * Find common prefix for all pathspec's
630 * This is used as a performance optimization which unfortunately cannot
631 * be done when recursing into submodules because when a pathspec is
632 * given which spans repository boundaries you can't simply remove the
633 * submodule entry because the pathspec may match something inside the
636 if (recurse_submodules
)
639 max_prefix
= common_prefix(&pathspec
);
640 max_prefix_len
= get_common_prefix_len(max_prefix
);
642 prune_index(the_repository
->index
, max_prefix
, max_prefix_len
);
644 /* Treat unmatching pathspec elements as errors */
645 if (pathspec
.nr
&& error_unmatch
)
646 ps_matched
= xcalloc(pathspec
.nr
, 1);
648 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
649 die("ls-files --ignored needs some exclude pattern");
651 /* With no flags, we default to showing the cached files */
652 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
653 show_killed
|| show_modified
|| show_resolve_undo
))
658 * Basic sanity check; show-stages and show-unmerged
659 * would not make any sense with this option.
661 if (show_stage
|| show_unmerged
)
662 die("ls-files --with-tree is incompatible with -s or -u");
663 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
666 show_files(the_repository
, &dir
);
668 if (show_resolve_undo
)
669 show_ru_info(the_repository
->index
);
673 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
675 fprintf(stderr
, "Did you forget to 'git add'?\n");