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
13 #include "parse-options.h"
14 #include "resolve-undo.h"
15 #include "string-list.h"
17 #include "run-command.h"
20 static int show_deleted
;
21 static int show_cached
;
22 static int show_others
;
23 static int show_stage
;
24 static int show_unmerged
;
25 static int show_resolve_undo
;
26 static int show_modified
;
27 static int show_killed
;
28 static int show_valid_bit
;
29 static int line_terminator
= '\n';
30 static int debug_mode
;
32 static int recurse_submodules
;
33 static struct argv_array submodule_options
= ARGV_ARRAY_INIT
;
35 static const char *prefix
;
36 static const char *super_prefix
;
37 static int max_prefix_len
;
38 static int prefix_len
;
39 static struct pathspec pathspec
;
40 static int error_unmatch
;
41 static char *ps_matched
;
42 static const char *with_tree
;
44 static int exclude_args
;
46 static const char *tag_cached
= "";
47 static const char *tag_unmerged
= "";
48 static const char *tag_removed
= "";
49 static const char *tag_other
= "";
50 static const char *tag_killed
= "";
51 static const char *tag_modified
= "";
52 static const char *tag_skip_worktree
= "";
53 static const char *tag_resolve_undo
= "";
55 static void write_eolinfo(const struct cache_entry
*ce
, const char *path
)
61 const char *i_txt
= "";
62 const char *w_txt
= "";
63 const char *a_txt
= get_convert_attr_ascii(path
);
64 if (ce
&& S_ISREG(ce
->ce_mode
))
65 i_txt
= get_cached_convert_stats_ascii(ce
->name
);
66 if (!lstat(path
, &st
) && S_ISREG(st
.st_mode
))
67 w_txt
= get_wt_convert_stats_ascii(path
);
68 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt
, w_txt
, a_txt
);
72 static void write_name(const char *name
)
75 * Prepend the super_prefix to name to construct the full_name to be
78 struct strbuf full_name
= STRBUF_INIT
;
80 strbuf_addstr(&full_name
, super_prefix
);
81 strbuf_addstr(&full_name
, name
);
86 * With "--full-name", prefix_len=0; this caller needs to pass
87 * an empty string in that case (a NULL is good for "").
89 write_name_quoted_relative(name
, prefix_len
? prefix
: NULL
,
90 stdout
, line_terminator
);
92 strbuf_release(&full_name
);
95 static void show_dir_entry(const char *tag
, struct dir_entry
*ent
)
97 int len
= max_prefix_len
;
100 die("git ls-files: internal error - directory entry not superset of prefix");
102 if (!dir_path_match(ent
, &pathspec
, len
, ps_matched
))
106 write_eolinfo(NULL
, ent
->name
);
107 write_name(ent
->name
);
110 static void show_other_files(struct dir_struct
*dir
)
114 for (i
= 0; i
< dir
->nr
; i
++) {
115 struct dir_entry
*ent
= dir
->entries
[i
];
116 if (!cache_name_is_other(ent
->name
, ent
->len
))
118 show_dir_entry(tag_other
, ent
);
122 static void show_killed_files(struct dir_struct
*dir
)
125 for (i
= 0; i
< dir
->nr
; i
++) {
126 struct dir_entry
*ent
= dir
->entries
[i
];
128 int pos
, len
, killed
= 0;
130 for (cp
= ent
->name
; cp
- ent
->name
< ent
->len
; cp
= sp
+ 1) {
131 sp
= strchr(cp
, '/');
133 /* If ent->name is prefix of an entry in the
134 * cache, it will be killed.
136 pos
= cache_name_pos(ent
->name
, ent
->len
);
138 die("BUG: killed-file %.*s not found",
139 ent
->len
, ent
->name
);
141 while (pos
< active_nr
&&
142 ce_stage(active_cache
[pos
]))
143 pos
++; /* skip unmerged */
144 if (active_nr
<= pos
)
146 /* pos points at a name immediately after
147 * ent->name in the cache. Does it expect
148 * ent->name to be a directory?
150 len
= ce_namelen(active_cache
[pos
]);
151 if ((ent
->len
< len
) &&
152 !strncmp(active_cache
[pos
]->name
,
153 ent
->name
, ent
->len
) &&
154 active_cache
[pos
]->name
[ent
->len
] == '/')
158 if (0 <= cache_name_pos(ent
->name
, sp
- ent
->name
)) {
159 /* If any of the leading directories in
160 * ent->name is registered in the cache,
161 * ent->name will be killed.
168 show_dir_entry(tag_killed
, dir
->entries
[i
]);
173 * Compile an argv_array with all of the options supported by --recurse_submodules
175 static void compile_submodule_options(const char **argv
,
176 const struct dir_struct
*dir
,
179 if (line_terminator
== '\0')
180 argv_array_push(&submodule_options
, "-z");
182 argv_array_push(&submodule_options
, "-t");
184 argv_array_push(&submodule_options
, "-v");
186 argv_array_push(&submodule_options
, "--cached");
188 argv_array_push(&submodule_options
, "--eol");
190 argv_array_push(&submodule_options
, "--debug");
193 argv_array_push(&submodule_options
, "--");
194 for (; *argv
; argv
++)
195 argv_array_push(&submodule_options
, *argv
);
199 * Recursively call ls-files on a submodule
201 static void show_gitlink(const struct cache_entry
*ce
)
203 struct child_process cp
= CHILD_PROCESS_INIT
;
207 argv_array_pushf(&cp
.env_array
, "%s=%s",
208 GIT_TOPLEVEL_PREFIX_ENVIRONMENT
,
210 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
211 super_prefix
? super_prefix
: "",
213 argv_array_push(&cp
.args
, "ls-files");
214 argv_array_push(&cp
.args
, "--recurse-submodules");
216 /* add supported options */
217 argv_array_pushv(&cp
.args
, submodule_options
.argv
);
221 status
= run_command(&cp
);
226 static void show_ce_entry(const char *tag
, const struct cache_entry
*ce
)
228 struct strbuf name
= STRBUF_INIT
;
229 int len
= max_prefix_len
;
231 strbuf_addstr(&name
, super_prefix
);
232 strbuf_addstr(&name
, ce
->name
);
234 if (len
>= ce_namelen(ce
))
235 die("git ls-files: internal error - cache entry not superset of prefix");
237 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
238 submodule_path_match(&pathspec
, name
.buf
, ps_matched
)) {
240 } else if (match_pathspec(&pathspec
, name
.buf
, name
.len
,
242 S_ISDIR(ce
->ce_mode
) ||
243 S_ISGITLINK(ce
->ce_mode
))) {
244 if (tag
&& *tag
&& show_valid_bit
&&
245 (ce
->ce_flags
& CE_VALID
)) {
246 static char alttag
[4];
247 memcpy(alttag
, tag
, 3);
249 alttag
[0] = tolower(tag
[0]);
250 else if (tag
[0] == '?')
264 printf("%s%06o %s %d\t",
267 find_unique_abbrev(ce
->oid
.hash
, abbrev
),
270 write_eolinfo(ce
, ce
->name
);
271 write_name(ce
->name
);
273 const struct stat_data
*sd
= &ce
->ce_stat_data
;
275 printf(" ctime: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
276 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
277 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
278 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
279 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
283 strbuf_release(&name
);
286 static void show_ru_info(void)
288 struct string_list_item
*item
;
290 if (!the_index
.resolve_undo
)
293 for_each_string_list_item(item
, the_index
.resolve_undo
) {
294 const char *path
= item
->string
;
295 struct resolve_undo_info
*ui
= item
->util
;
299 if (len
< max_prefix_len
)
300 continue; /* outside of the prefix */
301 if (!match_pathspec(&pathspec
, path
, len
,
302 max_prefix_len
, ps_matched
, 0))
303 continue; /* uninterested */
304 for (i
= 0; i
< 3; i
++) {
307 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
308 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
315 static int ce_excluded(struct dir_struct
*dir
, const struct cache_entry
*ce
)
317 int dtype
= ce_to_dtype(ce
);
318 return is_excluded(dir
, ce
->name
, &dtype
);
321 static void show_files(struct dir_struct
*dir
)
325 /* For cached/deleted files we don't need to even do the readdir */
326 if (show_others
|| show_killed
) {
328 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
329 fill_directory(dir
, &pathspec
);
331 show_other_files(dir
);
333 show_killed_files(dir
);
335 if (show_cached
|| show_stage
) {
336 for (i
= 0; i
< active_nr
; i
++) {
337 const struct cache_entry
*ce
= active_cache
[i
];
338 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
339 !ce_excluded(dir
, ce
))
341 if (show_unmerged
&& !ce_stage(ce
))
343 if (ce
->ce_flags
& CE_UPDATE
)
345 show_ce_entry(ce_stage(ce
) ? tag_unmerged
:
346 (ce_skip_worktree(ce
) ? tag_skip_worktree
: tag_cached
), ce
);
349 if (show_deleted
|| show_modified
) {
350 for (i
= 0; i
< active_nr
; i
++) {
351 const struct cache_entry
*ce
= active_cache
[i
];
354 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
355 !ce_excluded(dir
, ce
))
357 if (ce
->ce_flags
& CE_UPDATE
)
359 if (ce_skip_worktree(ce
))
361 err
= lstat(ce
->name
, &st
);
362 if (show_deleted
&& err
)
363 show_ce_entry(tag_removed
, ce
);
364 if (show_modified
&& ce_modified(ce
, &st
, 0))
365 show_ce_entry(tag_modified
, ce
);
371 * Prune the index to only contain stuff starting with "prefix"
373 static void prune_cache(const char *prefix
, size_t prefixlen
)
376 unsigned int first
, last
;
380 pos
= cache_name_pos(prefix
, prefixlen
);
385 while (last
> first
) {
386 int next
= (last
+ first
) >> 1;
387 const struct cache_entry
*ce
= active_cache
[next
];
388 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
394 memmove(active_cache
, active_cache
+ pos
,
395 (last
- pos
) * sizeof(struct cache_entry
*));
396 active_nr
= last
- pos
;
400 * Read the tree specified with --with-tree option
401 * (typically, HEAD) into stage #1 and then
402 * squash them down to stage #0. This is used for
403 * --error-unmatch to list and check the path patterns
404 * that were given from the command line. We are not
405 * going to write this index out.
407 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
)
410 unsigned char sha1
[20];
411 struct pathspec pathspec
;
412 struct cache_entry
*last_stage0
= NULL
;
415 if (get_sha1(tree_name
, sha1
))
416 die("tree-ish %s not found.", tree_name
);
417 tree
= parse_tree_indirect(sha1
);
419 die("bad tree-ish %s", tree_name
);
421 /* Hoist the unmerged entries up to stage #3 to make room */
422 for (i
= 0; i
< active_nr
; i
++) {
423 struct cache_entry
*ce
= active_cache
[i
];
426 ce
->ce_flags
|= CE_STAGEMASK
;
430 static const char *(matchbuf
[1]);
432 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
433 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
435 memset(&pathspec
, 0, sizeof(pathspec
));
436 if (read_tree(tree
, 1, &pathspec
))
437 die("unable to read tree entries %s", tree_name
);
439 for (i
= 0; i
< active_nr
; i
++) {
440 struct cache_entry
*ce
= active_cache
[i
];
441 switch (ce_stage(ce
)) {
449 * If there is stage #0 entry for this, we do not
450 * need to show it. We use CE_UPDATE bit to mark
454 !strcmp(last_stage0
->name
, ce
->name
))
455 ce
->ce_flags
|= CE_UPDATE
;
460 static const char * const ls_files_usage
[] = {
461 N_("git ls-files [<options>] [<file>...]"),
465 static int option_parse_exclude(const struct option
*opt
,
466 const char *arg
, int unset
)
468 struct string_list
*exclude_list
= opt
->value
;
471 string_list_append(exclude_list
, arg
);
476 static int option_parse_exclude_from(const struct option
*opt
,
477 const char *arg
, int unset
)
479 struct dir_struct
*dir
= opt
->value
;
482 add_excludes_from_file(dir
, arg
);
487 static int option_parse_exclude_standard(const struct option
*opt
,
488 const char *arg
, int unset
)
490 struct dir_struct
*dir
= opt
->value
;
493 setup_standard_excludes(dir
);
498 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
500 int require_work_tree
= 0, show_tag
= 0, i
;
501 const char *max_prefix
;
502 struct dir_struct dir
;
503 struct exclude_list
*el
;
504 struct string_list exclude_list
= STRING_LIST_INIT_NODUP
;
505 struct option builtin_ls_files_options
[] = {
506 /* Think twice before adding "--nul" synonym to this */
507 OPT_SET_INT('z', NULL
, &line_terminator
,
508 N_("paths are separated with NUL character"), '\0'),
509 OPT_BOOL('t', NULL
, &show_tag
,
510 N_("identify the file status with tags")),
511 OPT_BOOL('v', NULL
, &show_valid_bit
,
512 N_("use lowercase letters for 'assume unchanged' files")),
513 OPT_BOOL('c', "cached", &show_cached
,
514 N_("show cached files in the output (default)")),
515 OPT_BOOL('d', "deleted", &show_deleted
,
516 N_("show deleted files in the output")),
517 OPT_BOOL('m', "modified", &show_modified
,
518 N_("show modified files in the output")),
519 OPT_BOOL('o', "others", &show_others
,
520 N_("show other files in the output")),
521 OPT_BIT('i', "ignored", &dir
.flags
,
522 N_("show ignored files in the output"),
524 OPT_BOOL('s', "stage", &show_stage
,
525 N_("show staged contents' object name in the output")),
526 OPT_BOOL('k', "killed", &show_killed
,
527 N_("show files on the filesystem that need to be removed")),
528 OPT_BIT(0, "directory", &dir
.flags
,
529 N_("show 'other' directories' names only"),
530 DIR_SHOW_OTHER_DIRECTORIES
),
531 OPT_BOOL(0, "eol", &show_eol
, N_("show line endings of files")),
532 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
533 N_("don't show empty directories"),
534 DIR_HIDE_EMPTY_DIRECTORIES
),
535 OPT_BOOL('u', "unmerged", &show_unmerged
,
536 N_("show unmerged files in the output")),
537 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
538 N_("show resolve-undo information")),
539 { OPTION_CALLBACK
, 'x', "exclude", &exclude_list
, N_("pattern"),
540 N_("skip files matching pattern"),
541 0, option_parse_exclude
},
542 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, N_("file"),
543 N_("exclude patterns are read from <file>"),
544 0, option_parse_exclude_from
},
545 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
546 N_("read additional per-directory exclude patterns in <file>")),
547 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
548 N_("add the standard git exclusions"),
549 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
550 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
551 N_("make the output relative to the project top directory"),
552 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
553 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
554 N_("recurse through submodules")),
555 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
556 N_("if any <file> is not in the index, treat this as an error")),
557 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
558 N_("pretend that paths removed since <tree-ish> are still present")),
559 OPT__ABBREV(&abbrev
),
560 OPT_BOOL(0, "debug", &debug_mode
, N_("show debugging data")),
564 if (argc
== 2 && !strcmp(argv
[1], "-h"))
565 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
567 memset(&dir
, 0, sizeof(dir
));
570 prefix_len
= strlen(prefix
);
571 super_prefix
= get_super_prefix();
572 git_config(git_default_config
, NULL
);
574 if (read_cache() < 0)
575 die("index file corrupt");
577 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
579 el
= add_exclude_list(&dir
, EXC_CMDL
, "--exclude option");
580 for (i
= 0; i
< exclude_list
.nr
; i
++) {
581 add_exclude(exclude_list
.items
[i
].string
, "", 0, el
, --exclude_args
);
583 if (show_tag
|| show_valid_bit
) {
590 tag_skip_worktree
= "S ";
591 tag_resolve_undo
= "U ";
593 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
594 require_work_tree
= 1;
597 * There's no point in showing unmerged unless
598 * you also show the stage information.
601 if (dir
.exclude_per_dir
)
604 if (require_work_tree
&& !is_inside_work_tree())
607 if (recurse_submodules
)
608 compile_submodule_options(argv
, &dir
, show_tag
);
610 if (recurse_submodules
&&
611 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
612 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
613 die("ls-files --recurse-submodules unsupported mode");
615 if (recurse_submodules
&& error_unmatch
)
616 die("ls-files --recurse-submodules does not support "
619 parse_pathspec(&pathspec
, 0,
620 PATHSPEC_PREFER_CWD
|
621 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
,
625 * Find common prefix for all pathspec's
626 * This is used as a performance optimization which unfortunately cannot
627 * be done when recursing into submodules
629 if (recurse_submodules
)
632 max_prefix
= common_prefix(&pathspec
);
633 max_prefix_len
= max_prefix
? strlen(max_prefix
) : 0;
635 /* Treat unmatching pathspec elements as errors */
636 if (pathspec
.nr
&& error_unmatch
)
637 ps_matched
= xcalloc(pathspec
.nr
, 1);
639 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
640 die("ls-files --ignored needs some exclude pattern");
642 /* With no flags, we default to showing the cached files */
643 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
644 show_killed
|| show_modified
|| show_resolve_undo
))
647 prune_cache(max_prefix
, max_prefix_len
);
650 * Basic sanity check; show-stages and show-unmerged
651 * would not make any sense with this option.
653 if (show_stage
|| show_unmerged
)
654 die("ls-files --with-tree is incompatible with -s or -u");
655 overlay_tree_on_cache(with_tree
, max_prefix
);
658 if (show_resolve_undo
)
663 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
665 fprintf(stderr
, "Did you forget to 'git add'?\n");