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"
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 line_terminator
= '\n';
34 static int debug_mode
;
36 static int recurse_submodules
;
38 static const char *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
;
46 static int exclude_args
;
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
= "";
57 static void write_eolinfo(const struct index_state
*istate
,
58 const struct cache_entry
*ce
, const char *path
)
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(istate
,
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
);
74 static void write_name(const char *name
)
77 * With "--full-name", prefix_len=0; this caller needs to pass
78 * an empty string in that case (a NULL is good for "").
80 write_name_quoted_relative(name
, prefix_len
? prefix
: NULL
,
81 stdout
, line_terminator
);
84 static const char *get_tag(const struct cache_entry
*ce
, const char *tag
)
86 static char alttag
[4];
88 if (tag
&& *tag
&& show_valid_bit
&& (ce
->ce_flags
& CE_VALID
)) {
89 memcpy(alttag
, tag
, 3);
91 if (isalpha(tag
[0])) {
92 alttag
[0] = tolower(tag
[0]);
93 } else if (tag
[0] == '?') {
108 static void print_debug(const struct cache_entry
*ce
)
111 const struct stat_data
*sd
= &ce
->ce_stat_data
;
113 printf(" ctime: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
114 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
115 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
116 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
117 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
121 static void show_dir_entry(const char *tag
, struct dir_entry
*ent
)
123 int len
= max_prefix_len
;
126 die("git ls-files: internal error - directory entry not superset of prefix");
128 if (!dir_path_match(ent
, &pathspec
, len
, ps_matched
))
132 write_eolinfo(NULL
, NULL
, ent
->name
);
133 write_name(ent
->name
);
136 static void show_other_files(const struct index_state
*istate
,
137 const struct dir_struct
*dir
)
141 for (i
= 0; i
< dir
->nr
; i
++) {
142 struct dir_entry
*ent
= dir
->entries
[i
];
143 if (!index_name_is_other(istate
, ent
->name
, ent
->len
))
145 show_dir_entry(tag_other
, ent
);
149 static void show_killed_files(const struct index_state
*istate
,
150 const struct dir_struct
*dir
)
153 for (i
= 0; i
< dir
->nr
; i
++) {
154 struct dir_entry
*ent
= dir
->entries
[i
];
156 int pos
, len
, killed
= 0;
158 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
159 sp
= strchr(cp
, '/');
161 /* If ent->name is prefix of an entry in the
162 * cache, it will be killed.
164 pos
= index_name_pos(istate
, ent
->name
, ent
->len
);
166 die("BUG: killed-file %.*s not found",
167 ent
->len
, ent
->name
);
169 while (pos
< istate
->cache_nr
&&
170 ce_stage(istate
->cache
[pos
]))
171 pos
++; /* skip unmerged */
172 if (istate
->cache_nr
<= pos
)
174 /* pos points at a name immediately after
175 * ent->name in the cache. Does it expect
176 * ent->name to be a directory?
178 len
= ce_namelen(istate
->cache
[pos
]);
179 if ((ent
->len
< len
) &&
180 !strncmp(istate
->cache
[pos
]->name
,
181 ent
->name
, ent
->len
) &&
182 istate
->cache
[pos
]->name
[ent
->len
] == '/')
186 if (0 <= index_name_pos(istate
, ent
->name
, sp
- ent
->name
)) {
187 /* If any of the leading directories in
188 * ent->name is registered in the cache,
189 * ent->name will be killed.
196 show_dir_entry(tag_killed
, dir
->entries
[i
]);
200 static void show_files(struct repository
*repo
, struct dir_struct
*dir
);
202 static void show_submodule(struct repository
*superproject
,
203 struct dir_struct
*dir
, const char *path
)
205 struct repository submodule
;
207 if (repo_submodule_init(&submodule
, superproject
, path
))
210 if (repo_read_index(&submodule
) < 0)
211 die("index file corrupt");
213 repo_read_gitmodules(&submodule
);
215 show_files(&submodule
, dir
);
217 repo_clear(&submodule
);
220 static void show_ce(struct repository
*repo
, struct dir_struct
*dir
,
221 const struct cache_entry
*ce
, const char *fullname
,
224 if (max_prefix_len
> strlen(fullname
))
225 die("git ls-files: internal error - cache entry not superset of prefix");
227 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
228 is_submodule_active(repo
, ce
->name
)) {
229 show_submodule(repo
, dir
, ce
->name
);
230 } else if (match_pathspec(&pathspec
, fullname
, strlen(fullname
),
231 max_prefix_len
, ps_matched
,
232 S_ISDIR(ce
->ce_mode
) ||
233 S_ISGITLINK(ce
->ce_mode
))) {
234 tag
= get_tag(ce
, tag
);
239 printf("%s%06o %s %d\t",
242 find_unique_abbrev(ce
->oid
.hash
, abbrev
),
245 write_eolinfo(repo
->index
, ce
, fullname
);
246 write_name(fullname
);
251 static void show_ru_info(const struct index_state
*istate
)
253 struct string_list_item
*item
;
255 if (!istate
->resolve_undo
)
258 for_each_string_list_item(item
, istate
->resolve_undo
) {
259 const char *path
= item
->string
;
260 struct resolve_undo_info
*ui
= item
->util
;
264 if (len
< max_prefix_len
)
265 continue; /* outside of the prefix */
266 if (!match_pathspec(&pathspec
, path
, len
,
267 max_prefix_len
, ps_matched
, 0))
268 continue; /* uninterested */
269 for (i
= 0; i
< 3; i
++) {
272 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
273 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
280 static int ce_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
281 const char *fullname
, const struct cache_entry
*ce
)
283 int dtype
= ce_to_dtype(ce
);
284 return is_excluded(dir
, istate
, fullname
, &dtype
);
287 static void construct_fullname(struct strbuf
*out
, const struct repository
*repo
,
288 const struct cache_entry
*ce
)
291 if (repo
->submodule_prefix
)
292 strbuf_addstr(out
, repo
->submodule_prefix
);
293 strbuf_addstr(out
, ce
->name
);
296 static void show_files(struct repository
*repo
, struct dir_struct
*dir
)
299 struct strbuf fullname
= STRBUF_INIT
;
301 /* For cached/deleted files we don't need to even do the readdir */
302 if (show_others
|| show_killed
) {
304 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
305 fill_directory(dir
, repo
->index
, &pathspec
);
307 show_other_files(repo
->index
, dir
);
309 show_killed_files(repo
->index
, dir
);
311 if (show_cached
|| show_stage
) {
312 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
313 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
315 construct_fullname(&fullname
, repo
, ce
);
317 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
318 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
320 if (show_unmerged
&& !ce_stage(ce
))
322 if (ce
->ce_flags
& CE_UPDATE
)
324 show_ce(repo
, dir
, ce
, fullname
.buf
,
325 ce_stage(ce
) ? tag_unmerged
:
326 (ce_skip_worktree(ce
) ? tag_skip_worktree
:
330 if (show_deleted
|| show_modified
) {
331 for (i
= 0; i
< repo
->index
->cache_nr
; i
++) {
332 const struct cache_entry
*ce
= repo
->index
->cache
[i
];
336 construct_fullname(&fullname
, repo
, ce
);
338 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
339 !ce_excluded(dir
, repo
->index
, fullname
.buf
, ce
))
341 if (ce
->ce_flags
& CE_UPDATE
)
343 if (ce_skip_worktree(ce
))
345 err
= lstat(fullname
.buf
, &st
);
346 if (show_deleted
&& err
)
347 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_removed
);
348 if (show_modified
&& ie_modified(repo
->index
, ce
, &st
, 0))
349 show_ce(repo
, dir
, ce
, fullname
.buf
, tag_modified
);
353 strbuf_release(&fullname
);
357 * Prune the index to only contain stuff starting with "prefix"
359 static void prune_index(struct index_state
*istate
,
360 const char *prefix
, size_t prefixlen
)
363 unsigned int first
, last
;
367 pos
= index_name_pos(istate
, prefix
, prefixlen
);
371 last
= istate
->cache_nr
;
372 while (last
> first
) {
373 int next
= (last
+ first
) >> 1;
374 const struct cache_entry
*ce
= istate
->cache
[next
];
375 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
381 memmove(istate
->cache
, istate
->cache
+ pos
,
382 (last
- pos
) * sizeof(struct cache_entry
*));
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('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"),
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")),
571 if (argc
== 2 && !strcmp(argv
[1], "-h"))
572 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
574 memset(&dir
, 0, sizeof(dir
));
577 prefix_len
= strlen(prefix
);
578 git_config(git_default_config
, NULL
);
580 if (repo_read_index(the_repository
) < 0)
581 die("index file corrupt");
583 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
585 el
= add_exclude_list(&dir
, EXC_CMDL
, "--exclude option");
586 for (i
= 0; i
< exclude_list
.nr
; i
++) {
587 add_exclude(exclude_list
.items
[i
].string
, "", 0, el
, --exclude_args
);
589 if (show_tag
|| show_valid_bit
) {
596 tag_skip_worktree
= "S ";
597 tag_resolve_undo
= "U ";
599 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
600 require_work_tree
= 1;
603 * There's no point in showing unmerged unless
604 * you also show the stage information.
607 if (dir
.exclude_per_dir
)
610 if (require_work_tree
&& !is_inside_work_tree())
613 if (recurse_submodules
)
614 repo_read_gitmodules(the_repository
);
616 if (recurse_submodules
&&
617 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
618 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
619 die("ls-files --recurse-submodules unsupported mode");
621 if (recurse_submodules
&& error_unmatch
)
622 die("ls-files --recurse-submodules does not support "
625 parse_pathspec(&pathspec
, 0,
630 * Find common prefix for all pathspec's
631 * This is used as a performance optimization which unfortunately cannot
632 * be done when recursing into submodules because when a pathspec is
633 * given which spans repository boundaries you can't simply remove the
634 * submodule entry because the pathspec may match something inside the
637 if (recurse_submodules
)
640 max_prefix
= common_prefix(&pathspec
);
641 max_prefix_len
= get_common_prefix_len(max_prefix
);
643 prune_index(the_repository
->index
, max_prefix
, max_prefix_len
);
645 /* Treat unmatching pathspec elements as errors */
646 if (pathspec
.nr
&& error_unmatch
)
647 ps_matched
= xcalloc(pathspec
.nr
, 1);
649 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
650 die("ls-files --ignored needs some exclude pattern");
652 /* With no flags, we default to showing the cached files */
653 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
654 show_killed
|| show_modified
|| show_resolve_undo
))
659 * Basic sanity check; show-stages and show-unmerged
660 * would not make any sense with this option.
662 if (show_stage
|| show_unmerged
)
663 die("ls-files --with-tree is incompatible with -s or -u");
664 overlay_tree_on_index(the_repository
->index
, with_tree
, max_prefix
);
667 show_files(the_repository
, &dir
);
669 if (show_resolve_undo
)
670 show_ru_info(the_repository
->index
);
674 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
676 fprintf(stderr
, "Did you forget to 'git add'?\n");