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 submodules_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 struct dir_struct
*dir
, int show_tag
)
177 if (line_terminator
== '\0')
178 argv_array_push(&submodules_options
, "-z");
180 argv_array_push(&submodules_options
, "-t");
182 argv_array_push(&submodules_options
, "-v");
184 argv_array_push(&submodules_options
, "--cached");
186 argv_array_push(&submodules_options
, "--eol");
188 argv_array_push(&submodules_options
, "--debug");
192 * Recursively call ls-files on a submodule
194 static void show_gitlink(const struct cache_entry
*ce
)
196 struct child_process cp
= CHILD_PROCESS_INIT
;
200 argv_array_pushf(&cp
.args
, "--super-prefix=%s%s/",
201 super_prefix
? super_prefix
: "",
203 argv_array_push(&cp
.args
, "ls-files");
204 argv_array_push(&cp
.args
, "--recurse-submodules");
206 /* add supported options */
207 argv_array_pushv(&cp
.args
, submodules_options
.argv
);
210 * Pass in the original pathspec args. The submodule will be
211 * responsible for prepending the 'submodule_prefix' prior to comparing
212 * against the pathspec for matches.
214 argv_array_push(&cp
.args
, "--");
215 for (i
= 0; i
< pathspec
.nr
; i
++)
216 argv_array_push(&cp
.args
, pathspec
.items
[i
].original
);
220 status
= run_command(&cp
);
225 static void show_ce_entry(const char *tag
, const struct cache_entry
*ce
)
227 struct strbuf name
= STRBUF_INIT
;
228 int len
= max_prefix_len
;
230 strbuf_addstr(&name
, super_prefix
);
231 strbuf_addstr(&name
, ce
->name
);
233 if (len
>= ce_namelen(ce
))
234 die("git ls-files: internal error - cache entry not superset of prefix");
236 if (recurse_submodules
&& S_ISGITLINK(ce
->ce_mode
) &&
237 submodule_path_match(&pathspec
, name
.buf
, ps_matched
)) {
239 } else if (match_pathspec(&pathspec
, name
.buf
, name
.len
,
241 S_ISDIR(ce
->ce_mode
) ||
242 S_ISGITLINK(ce
->ce_mode
))) {
243 if (tag
&& *tag
&& show_valid_bit
&&
244 (ce
->ce_flags
& CE_VALID
)) {
245 static char alttag
[4];
246 memcpy(alttag
, tag
, 3);
248 alttag
[0] = tolower(tag
[0]);
249 else if (tag
[0] == '?')
263 printf("%s%06o %s %d\t",
266 find_unique_abbrev(ce
->oid
.hash
, abbrev
),
269 write_eolinfo(ce
, ce
->name
);
270 write_name(ce
->name
);
272 const struct stat_data
*sd
= &ce
->ce_stat_data
;
274 printf(" ctime: %d:%d\n", sd
->sd_ctime
.sec
, sd
->sd_ctime
.nsec
);
275 printf(" mtime: %d:%d\n", sd
->sd_mtime
.sec
, sd
->sd_mtime
.nsec
);
276 printf(" dev: %d\tino: %d\n", sd
->sd_dev
, sd
->sd_ino
);
277 printf(" uid: %d\tgid: %d\n", sd
->sd_uid
, sd
->sd_gid
);
278 printf(" size: %d\tflags: %x\n", sd
->sd_size
, ce
->ce_flags
);
282 strbuf_release(&name
);
285 static void show_ru_info(void)
287 struct string_list_item
*item
;
289 if (!the_index
.resolve_undo
)
292 for_each_string_list_item(item
, the_index
.resolve_undo
) {
293 const char *path
= item
->string
;
294 struct resolve_undo_info
*ui
= item
->util
;
298 if (len
< max_prefix_len
)
299 continue; /* outside of the prefix */
300 if (!match_pathspec(&pathspec
, path
, len
,
301 max_prefix_len
, ps_matched
, 0))
302 continue; /* uninterested */
303 for (i
= 0; i
< 3; i
++) {
306 printf("%s%06o %s %d\t", tag_resolve_undo
, ui
->mode
[i
],
307 find_unique_abbrev(ui
->sha1
[i
], abbrev
),
314 static int ce_excluded(struct dir_struct
*dir
, const struct cache_entry
*ce
)
316 int dtype
= ce_to_dtype(ce
);
317 return is_excluded(dir
, ce
->name
, &dtype
);
320 static void show_files(struct dir_struct
*dir
)
324 /* For cached/deleted files we don't need to even do the readdir */
325 if (show_others
|| show_killed
) {
327 dir
->flags
|= DIR_COLLECT_KILLED_ONLY
;
328 fill_directory(dir
, &pathspec
);
330 show_other_files(dir
);
332 show_killed_files(dir
);
334 if (show_cached
|| show_stage
) {
335 for (i
= 0; i
< active_nr
; i
++) {
336 const struct cache_entry
*ce
= active_cache
[i
];
337 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
338 !ce_excluded(dir
, ce
))
340 if (show_unmerged
&& !ce_stage(ce
))
342 if (ce
->ce_flags
& CE_UPDATE
)
344 show_ce_entry(ce_stage(ce
) ? tag_unmerged
:
345 (ce_skip_worktree(ce
) ? tag_skip_worktree
: tag_cached
), ce
);
348 if (show_deleted
|| show_modified
) {
349 for (i
= 0; i
< active_nr
; i
++) {
350 const struct cache_entry
*ce
= active_cache
[i
];
353 if ((dir
->flags
& DIR_SHOW_IGNORED
) &&
354 !ce_excluded(dir
, ce
))
356 if (ce
->ce_flags
& CE_UPDATE
)
358 if (ce_skip_worktree(ce
))
360 err
= lstat(ce
->name
, &st
);
361 if (show_deleted
&& err
)
362 show_ce_entry(tag_removed
, ce
);
363 if (show_modified
&& ce_modified(ce
, &st
, 0))
364 show_ce_entry(tag_modified
, ce
);
370 * Prune the index to only contain stuff starting with "prefix"
372 static void prune_cache(const char *prefix
, size_t prefixlen
)
375 unsigned int first
, last
;
379 pos
= cache_name_pos(prefix
, prefixlen
);
384 while (last
> first
) {
385 int next
= (last
+ first
) >> 1;
386 const struct cache_entry
*ce
= active_cache
[next
];
387 if (!strncmp(ce
->name
, prefix
, prefixlen
)) {
393 memmove(active_cache
, active_cache
+ pos
,
394 (last
- pos
) * sizeof(struct cache_entry
*));
395 active_nr
= last
- pos
;
399 * Read the tree specified with --with-tree option
400 * (typically, HEAD) into stage #1 and then
401 * squash them down to stage #0. This is used for
402 * --error-unmatch to list and check the path patterns
403 * that were given from the command line. We are not
404 * going to write this index out.
406 void overlay_tree_on_cache(const char *tree_name
, const char *prefix
)
409 unsigned char sha1
[20];
410 struct pathspec pathspec
;
411 struct cache_entry
*last_stage0
= NULL
;
414 if (get_sha1(tree_name
, sha1
))
415 die("tree-ish %s not found.", tree_name
);
416 tree
= parse_tree_indirect(sha1
);
418 die("bad tree-ish %s", tree_name
);
420 /* Hoist the unmerged entries up to stage #3 to make room */
421 for (i
= 0; i
< active_nr
; i
++) {
422 struct cache_entry
*ce
= active_cache
[i
];
425 ce
->ce_flags
|= CE_STAGEMASK
;
429 static const char *(matchbuf
[1]);
431 parse_pathspec(&pathspec
, PATHSPEC_ALL_MAGIC
,
432 PATHSPEC_PREFER_CWD
, prefix
, matchbuf
);
434 memset(&pathspec
, 0, sizeof(pathspec
));
435 if (read_tree(tree
, 1, &pathspec
))
436 die("unable to read tree entries %s", tree_name
);
438 for (i
= 0; i
< active_nr
; i
++) {
439 struct cache_entry
*ce
= active_cache
[i
];
440 switch (ce_stage(ce
)) {
448 * If there is stage #0 entry for this, we do not
449 * need to show it. We use CE_UPDATE bit to mark
453 !strcmp(last_stage0
->name
, ce
->name
))
454 ce
->ce_flags
|= CE_UPDATE
;
459 static const char * const ls_files_usage
[] = {
460 N_("git ls-files [<options>] [<file>...]"),
464 static int option_parse_exclude(const struct option
*opt
,
465 const char *arg
, int unset
)
467 struct string_list
*exclude_list
= opt
->value
;
470 string_list_append(exclude_list
, arg
);
475 static int option_parse_exclude_from(const struct option
*opt
,
476 const char *arg
, int unset
)
478 struct dir_struct
*dir
= opt
->value
;
481 add_excludes_from_file(dir
, arg
);
486 static int option_parse_exclude_standard(const struct option
*opt
,
487 const char *arg
, int unset
)
489 struct dir_struct
*dir
= opt
->value
;
492 setup_standard_excludes(dir
);
497 int cmd_ls_files(int argc
, const char **argv
, const char *cmd_prefix
)
499 int require_work_tree
= 0, show_tag
= 0, i
;
500 const char *max_prefix
;
501 struct dir_struct dir
;
502 struct exclude_list
*el
;
503 struct string_list exclude_list
= STRING_LIST_INIT_NODUP
;
504 struct option builtin_ls_files_options
[] = {
505 /* Think twice before adding "--nul" synonym to this */
506 OPT_SET_INT('z', NULL
, &line_terminator
,
507 N_("paths are separated with NUL character"), '\0'),
508 OPT_BOOL('t', NULL
, &show_tag
,
509 N_("identify the file status with tags")),
510 OPT_BOOL('v', NULL
, &show_valid_bit
,
511 N_("use lowercase letters for 'assume unchanged' files")),
512 OPT_BOOL('c', "cached", &show_cached
,
513 N_("show cached files in the output (default)")),
514 OPT_BOOL('d', "deleted", &show_deleted
,
515 N_("show deleted files in the output")),
516 OPT_BOOL('m', "modified", &show_modified
,
517 N_("show modified files in the output")),
518 OPT_BOOL('o', "others", &show_others
,
519 N_("show other files in the output")),
520 OPT_BIT('i', "ignored", &dir
.flags
,
521 N_("show ignored files in the output"),
523 OPT_BOOL('s', "stage", &show_stage
,
524 N_("show staged contents' object name in the output")),
525 OPT_BOOL('k', "killed", &show_killed
,
526 N_("show files on the filesystem that need to be removed")),
527 OPT_BIT(0, "directory", &dir
.flags
,
528 N_("show 'other' directories' names only"),
529 DIR_SHOW_OTHER_DIRECTORIES
),
530 OPT_BOOL(0, "eol", &show_eol
, N_("show line endings of files")),
531 OPT_NEGBIT(0, "empty-directory", &dir
.flags
,
532 N_("don't show empty directories"),
533 DIR_HIDE_EMPTY_DIRECTORIES
),
534 OPT_BOOL('u', "unmerged", &show_unmerged
,
535 N_("show unmerged files in the output")),
536 OPT_BOOL(0, "resolve-undo", &show_resolve_undo
,
537 N_("show resolve-undo information")),
538 { OPTION_CALLBACK
, 'x', "exclude", &exclude_list
, N_("pattern"),
539 N_("skip files matching pattern"),
540 0, option_parse_exclude
},
541 { OPTION_CALLBACK
, 'X', "exclude-from", &dir
, N_("file"),
542 N_("exclude patterns are read from <file>"),
543 0, option_parse_exclude_from
},
544 OPT_STRING(0, "exclude-per-directory", &dir
.exclude_per_dir
, N_("file"),
545 N_("read additional per-directory exclude patterns in <file>")),
546 { OPTION_CALLBACK
, 0, "exclude-standard", &dir
, NULL
,
547 N_("add the standard git exclusions"),
548 PARSE_OPT_NOARG
, option_parse_exclude_standard
},
549 { OPTION_SET_INT
, 0, "full-name", &prefix_len
, NULL
,
550 N_("make the output relative to the project top directory"),
551 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
},
552 OPT_BOOL(0, "recurse-submodules", &recurse_submodules
,
553 N_("recurse through submodules")),
554 OPT_BOOL(0, "error-unmatch", &error_unmatch
,
555 N_("if any <file> is not in the index, treat this as an error")),
556 OPT_STRING(0, "with-tree", &with_tree
, N_("tree-ish"),
557 N_("pretend that paths removed since <tree-ish> are still present")),
558 OPT__ABBREV(&abbrev
),
559 OPT_BOOL(0, "debug", &debug_mode
, N_("show debugging data")),
563 if (argc
== 2 && !strcmp(argv
[1], "-h"))
564 usage_with_options(ls_files_usage
, builtin_ls_files_options
);
566 memset(&dir
, 0, sizeof(dir
));
569 prefix_len
= strlen(prefix
);
570 super_prefix
= get_super_prefix();
571 git_config(git_default_config
, NULL
);
573 if (read_cache() < 0)
574 die("index file corrupt");
576 argc
= parse_options(argc
, argv
, prefix
, builtin_ls_files_options
,
578 el
= add_exclude_list(&dir
, EXC_CMDL
, "--exclude option");
579 for (i
= 0; i
< exclude_list
.nr
; i
++) {
580 add_exclude(exclude_list
.items
[i
].string
, "", 0, el
, --exclude_args
);
582 if (show_tag
|| show_valid_bit
) {
589 tag_skip_worktree
= "S ";
590 tag_resolve_undo
= "U ";
592 if (show_modified
|| show_others
|| show_deleted
|| (dir
.flags
& DIR_SHOW_IGNORED
) || show_killed
)
593 require_work_tree
= 1;
596 * There's no point in showing unmerged unless
597 * you also show the stage information.
600 if (dir
.exclude_per_dir
)
603 if (require_work_tree
&& !is_inside_work_tree())
606 if (recurse_submodules
)
607 compile_submodule_options(&dir
, show_tag
);
609 if (recurse_submodules
&&
610 (show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
611 show_killed
|| show_modified
|| show_resolve_undo
|| with_tree
))
612 die("ls-files --recurse-submodules unsupported mode");
614 if (recurse_submodules
&& error_unmatch
)
615 die("ls-files --recurse-submodules does not support "
618 parse_pathspec(&pathspec
, 0,
619 PATHSPEC_PREFER_CWD
|
620 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
,
624 * Find common prefix for all pathspec's
625 * This is used as a performance optimization which unfortunately cannot
626 * be done when recursing into submodules
628 if (recurse_submodules
)
631 max_prefix
= common_prefix(&pathspec
);
632 max_prefix_len
= max_prefix
? strlen(max_prefix
) : 0;
634 /* Treat unmatching pathspec elements as errors */
635 if (pathspec
.nr
&& error_unmatch
)
636 ps_matched
= xcalloc(pathspec
.nr
, 1);
638 if ((dir
.flags
& DIR_SHOW_IGNORED
) && !exc_given
)
639 die("ls-files --ignored needs some exclude pattern");
641 /* With no flags, we default to showing the cached files */
642 if (!(show_stage
|| show_deleted
|| show_others
|| show_unmerged
||
643 show_killed
|| show_modified
|| show_resolve_undo
))
646 prune_cache(max_prefix
, max_prefix_len
);
649 * Basic sanity check; show-stages and show-unmerged
650 * would not make any sense with this option.
652 if (show_stage
|| show_unmerged
)
653 die("ls-files --with-tree is incompatible with -s or -u");
654 overlay_tree_on_cache(with_tree
, max_prefix
);
657 if (show_resolve_undo
)
662 bad
= report_path_error(ps_matched
, &pathspec
, prefix
);
664 fprintf(stderr
, "Did you forget to 'git add'?\n");