]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/ls-files.c
Start the 2.46 cycle
[thirdparty/git.git] / builtin / ls-files.c
CommitLineData
8695c8bf
LT
1/*
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.
5 *
6 * Copyright (C) Linus Torvalds, 2005
7 */
bc5c5ec0 8#include "builtin.h"
188dce13 9#include "repository.h"
b2141fc1 10#include "config.h"
73359a9b 11#include "convert.h"
22ddf719 12#include "quote.h"
453ec4bd 13#include "dir.h"
f394e093 14#include "gettext.h"
dabab1d6 15#include "object-name.h"
ce74de93 16#include "strbuf.h"
ce8e8804 17#include "parse-options.h"
9d9a2f4a
JH
18#include "resolve-undo.h"
19#include "string-list.h"
c339932b 20#include "path.h"
64acde94 21#include "pathspec.h"
08c46a49 22#include "read-cache.h"
e38da487 23#include "setup.h"
baf889c2 24#include "sparse-index.h"
2e5d6503 25#include "submodule.h"
4d28c4f7
ZH
26#include "object-store.h"
27#include "hex.h"
28
8695c8bf 29
96f1e58f
DR
30static int abbrev;
31static int show_deleted;
32static int show_cached;
33static int show_others;
34static int show_stage;
35static int show_unmerged;
9d9a2f4a 36static int show_resolve_undo;
96f1e58f
DR
37static int show_modified;
38static int show_killed;
39static int show_valid_bit;
d8c71db8 40static int show_fsmonitor_bit;
b83c8345 41static int line_terminator = '\n';
84974217 42static int debug_mode;
a7630bd4 43static int show_eol;
e77aa336 44static int recurse_submodules;
93a7d983 45static int skipping_duplicates;
78087097 46static int show_sparse_dirs;
8695c8bf 47
efad1a56
CB
48static const char *prefix;
49static int max_prefix_len;
96f1e58f 50static int prefix_len;
9e06d6ed 51static struct pathspec pathspec;
96f1e58f
DR
52static int error_unmatch;
53static char *ps_matched;
64586e75 54static const char *with_tree;
ce8e8804 55static int exc_given;
c04318e4 56static int exclude_args;
ce74de93 57static const char *format;
5be4efbe 58
20d37ef6
PB
59static const char *tag_cached = "";
60static const char *tag_unmerged = "";
61static const char *tag_removed = "";
62static const char *tag_other = "";
6ca45943 63static const char *tag_killed = "";
b0391890 64static const char *tag_modified = "";
44a36913 65static const char *tag_skip_worktree = "";
9d9a2f4a 66static const char *tag_resolve_undo = "";
20d37ef6 67
847a9e5d 68static void write_eolinfo(struct index_state *istate,
1985fd68 69 const struct cache_entry *ce, const char *path)
a7630bd4 70{
1985fd68 71 if (show_eol) {
a7630bd4
TB
72 struct stat st;
73 const char *i_txt = "";
74 const char *w_txt = "";
a52b321d 75 const char *a_txt = get_convert_attr_ascii(istate, path);
a7630bd4 76 if (ce && S_ISREG(ce->ce_mode))
1985fd68 77 i_txt = get_cached_convert_stats_ascii(istate,
a7609c54 78 ce->name);
a7630bd4
TB
79 if (!lstat(path, &st) && S_ISREG(st.st_mode))
80 w_txt = get_wt_convert_stats_ascii(path);
81 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
82 }
83}
84
e9a820ce 85static void write_name(const char *name)
efad1a56 86{
ad66df2d 87 /*
e9a820ce
JX
88 * With "--full-name", prefix_len=0; this caller needs to pass
89 * an empty string in that case (a NULL is good for "").
ad66df2d 90 */
e9a820ce
JX
91 write_name_quoted_relative(name, prefix_len ? prefix : NULL,
92 stdout, line_terminator);
efad1a56
CB
93}
94
ce74de93
ZH
95static void write_name_to_buf(struct strbuf *sb, const char *name)
96{
cfb62dd0
AJ
97 struct strbuf buf = STRBUF_INIT;
98 const char *rel = relative_path(name, prefix_len ? prefix : NULL, &buf);
ce74de93
ZH
99
100 if (line_terminator)
101 quote_c_style(rel, sb, NULL, 0);
102 else
103 strbuf_addstr(sb, rel);
cfb62dd0
AJ
104
105 strbuf_release(&buf);
ce74de93
ZH
106}
107
a84f3e59
BW
108static const char *get_tag(const struct cache_entry *ce, const char *tag)
109{
110 static char alttag[4];
111
d8c71db8
BP
112 if (tag && *tag && ((show_valid_bit && (ce->ce_flags & CE_VALID)) ||
113 (show_fsmonitor_bit && (ce->ce_flags & CE_FSMONITOR_VALID)))) {
a84f3e59
BW
114 memcpy(alttag, tag, 3);
115
116 if (isalpha(tag[0])) {
117 alttag[0] = tolower(tag[0]);
118 } else if (tag[0] == '?') {
119 alttag[0] = '!';
120 } else {
121 alttag[0] = 'v';
122 alttag[1] = tag[0];
123 alttag[2] = ' ';
124 alttag[3] = 0;
125 }
126
127 tag = alttag;
128 }
129
130 return tag;
131}
132
5306ccf9
BW
133static void print_debug(const struct cache_entry *ce)
134{
135 if (debug_mode) {
136 const struct stat_data *sd = &ce->ce_stat_data;
137
7cb7283a
TG
138 printf(" ctime: %u:%u\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
139 printf(" mtime: %u:%u\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
140 printf(" dev: %u\tino: %u\n", sd->sd_dev, sd->sd_ino);
141 printf(" uid: %u\tgid: %u\n", sd->sd_uid, sd->sd_gid);
142 printf(" size: %u\tflags: %x\n", sd->sd_size, ce->ce_flags);
5306ccf9
BW
143 }
144}
145
847a9e5d 146static void show_dir_entry(struct index_state *istate,
a52b321d 147 const char *tag, struct dir_entry *ent)
5be4efbe 148{
efad1a56 149 int len = max_prefix_len;
5be4efbe 150
cbca060e 151 if (len > ent->len)
7e44c935 152 die("git ls-files: internal error - directory entry not superset of prefix");
5be4efbe 153
95c11ecc
EN
154 /* If ps_matches is non-NULL, figure out which pathspec(s) match. */
155 if (ps_matched)
156 dir_path_match(istate, ent, &pathspec, len, ps_matched);
5be4efbe 157
22ddf719 158 fputs(tag, stdout);
a52b321d 159 write_eolinfo(istate, NULL, ent->name);
e9a820ce 160 write_name(ent->name);
5be4efbe
LT
161}
162
847a9e5d 163static void show_other_files(struct index_state *istate,
23d6846b 164 const struct dir_struct *dir)
fcbc3083
JH
165{
166 int i;
5698454e 167
453ec4bd 168 for (i = 0; i < dir->nr; i++) {
453ec4bd 169 struct dir_entry *ent = dir->entries[i];
23d6846b 170 if (!index_name_is_other(istate, ent->name, ent->len))
98fa4738 171 continue;
a52b321d 172 show_dir_entry(istate, tag_other, ent);
fcbc3083
JH
173 }
174}
175
847a9e5d 176static void show_killed_files(struct index_state *istate,
23d6236a 177 const struct dir_struct *dir)
6ca45943
JH
178{
179 int i;
453ec4bd
LT
180 for (i = 0; i < dir->nr; i++) {
181 struct dir_entry *ent = dir->entries[i];
6ca45943
JH
182 char *cp, *sp;
183 int pos, len, killed = 0;
184
185 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
186 sp = strchr(cp, '/');
187 if (!sp) {
188 /* If ent->name is prefix of an entry in the
189 * cache, it will be killed.
190 */
23d6236a 191 pos = index_name_pos(istate, ent->name, ent->len);
6ca45943 192 if (0 <= pos)
033abf97 193 BUG("killed-file %.*s not found",
ef1177d1 194 ent->len, ent->name);
6ca45943 195 pos = -pos - 1;
23d6236a
BW
196 while (pos < istate->cache_nr &&
197 ce_stage(istate->cache[pos]))
6ca45943 198 pos++; /* skip unmerged */
23d6236a 199 if (istate->cache_nr <= pos)
6ca45943
JH
200 break;
201 /* pos points at a name immediately after
202 * ent->name in the cache. Does it expect
203 * ent->name to be a directory?
204 */
23d6236a 205 len = ce_namelen(istate->cache[pos]);
6ca45943 206 if ((ent->len < len) &&
23d6236a 207 !strncmp(istate->cache[pos]->name,
6ca45943 208 ent->name, ent->len) &&
23d6236a 209 istate->cache[pos]->name[ent->len] == '/')
6ca45943
JH
210 killed = 1;
211 break;
212 }
23d6236a 213 if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
6ca45943
JH
214 /* If any of the leading directories in
215 * ent->name is registered in the cache,
216 * ent->name will be killed.
217 */
218 killed = 1;
219 break;
220 }
221 }
222 if (killed)
a52b321d 223 show_dir_entry(istate, tag_killed, dir->entries[i]);
6ca45943 224 }
8695c8bf
LT
225}
226
188dce13 227static void show_files(struct repository *repo, struct dir_struct *dir);
07c01b9f 228
188dce13
BW
229static void show_submodule(struct repository *superproject,
230 struct dir_struct *dir, const char *path)
e77aa336 231{
d5498e08 232 struct repository subrepo;
188dce13 233
8eb8dcf9 234 if (repo_submodule_init(&subrepo, superproject, path, null_oid()))
188dce13
BW
235 return;
236
d5498e08 237 if (repo_read_index(&subrepo) < 0)
188dce13
BW
238 die("index file corrupt");
239
d5498e08 240 show_files(&subrepo, dir);
188dce13 241
d5498e08 242 repo_clear(&subrepo);
e77aa336
BW
243}
244
4d28c4f7
ZH
245static void expand_objectsize(struct strbuf *line, const struct object_id *oid,
246 const enum object_type type, unsigned int padded)
247{
248 if (type == OBJ_BLOB) {
249 unsigned long size;
250 if (oid_object_info(the_repository, oid, &size) < 0)
251 die(_("could not get object info about '%s'"),
252 oid_to_hex(oid));
253 if (padded)
254 strbuf_addf(line, "%7"PRIuMAX, (uintmax_t)size);
255 else
256 strbuf_addf(line, "%"PRIuMAX, (uintmax_t)size);
257 } else if (padded) {
258 strbuf_addf(line, "%7s", "-");
259 } else {
260 strbuf_addstr(line, "-");
261 }
262}
ce74de93
ZH
263
264static void show_ce_fmt(struct repository *repo, const struct cache_entry *ce,
265 const char *format, const char *fullname) {
ce74de93
ZH
266 struct strbuf sb = STRBUF_INIT;
267
6f1e2d52 268 while (strbuf_expand_step(&sb, &format)) {
6f1e2d52
RS
269 size_t len;
270 struct stat st;
271
272 if (skip_prefix(format, "%", &format))
273 strbuf_addch(&sb, '%');
4416b86c 274 else if ((len = strbuf_expand_literal(&sb, format)))
6f1e2d52 275 format += len;
6f1e2d52
RS
276 else if (skip_prefix(format, "(objectmode)", &format))
277 strbuf_addf(&sb, "%06o", ce->ce_mode);
278 else if (skip_prefix(format, "(objectname)", &format))
279 strbuf_add_unique_abbrev(&sb, &ce->oid, abbrev);
280 else if (skip_prefix(format, "(objecttype)", &format))
281 strbuf_addstr(&sb, type_name(object_type(ce->ce_mode)));
282 else if (skip_prefix(format, "(objectsize:padded)", &format))
283 expand_objectsize(&sb, &ce->oid,
284 object_type(ce->ce_mode), 1);
285 else if (skip_prefix(format, "(objectsize)", &format))
286 expand_objectsize(&sb, &ce->oid,
287 object_type(ce->ce_mode), 0);
288 else if (skip_prefix(format, "(stage)", &format))
289 strbuf_addf(&sb, "%d", ce_stage(ce));
290 else if (skip_prefix(format, "(eolinfo:index)", &format))
291 strbuf_addstr(&sb, S_ISREG(ce->ce_mode) ?
292 get_cached_convert_stats_ascii(repo->index,
293 ce->name) : "");
294 else if (skip_prefix(format, "(eolinfo:worktree)", &format))
295 strbuf_addstr(&sb, !lstat(fullname, &st) &&
296 S_ISREG(st.st_mode) ?
297 get_wt_convert_stats_ascii(fullname) : "");
298 else if (skip_prefix(format, "(eolattr)", &format))
299 strbuf_addstr(&sb, get_convert_attr_ascii(repo->index,
300 fullname));
301 else if (skip_prefix(format, "(path)", &format))
302 write_name_to_buf(&sb, fullname);
303 else
e36091aa 304 strbuf_expand_bad_format(format, "ls-files");
6f1e2d52 305 }
ce74de93
ZH
306 strbuf_addch(&sb, line_terminator);
307 fwrite(sb.buf, sb.len, 1, stdout);
308 strbuf_release(&sb);
309}
310
188dce13
BW
311static void show_ce(struct repository *repo, struct dir_struct *dir,
312 const struct cache_entry *ce, const char *fullname,
313 const char *tag)
5be4efbe 314{
188dce13 315 if (max_prefix_len > strlen(fullname))
7e44c935 316 die("git ls-files: internal error - cache entry not superset of prefix");
5be4efbe 317
75a6315f 318 if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
188dce13
BW
319 is_submodule_active(repo, ce->name)) {
320 show_submodule(repo, dir, ce->name);
a52b321d 321 } else if (match_pathspec(repo->index, &pathspec, fullname, strlen(fullname),
188dce13 322 max_prefix_len, ps_matched,
e77aa336
BW
323 S_ISDIR(ce->ce_mode) ||
324 S_ISGITLINK(ce->ce_mode))) {
ce74de93
ZH
325 if (format) {
326 show_ce_fmt(repo, ce, format, fullname);
327 print_debug(ce);
328 return;
329 }
330
a84f3e59 331 tag = get_tag(ce, tag);
5be4efbe 332
e77aa336
BW
333 if (!show_stage) {
334 fputs(tag, stdout);
335 } else {
336 printf("%s%06o %s %d\t",
337 tag,
338 ce->ce_mode,
290eada0 339 repo_find_unique_abbrev(repo, &ce->oid, abbrev),
e77aa336
BW
340 ce_stage(ce));
341 }
188dce13
BW
342 write_eolinfo(repo->index, ce, fullname);
343 write_name(fullname);
5306ccf9 344 print_debug(ce);
2bcab240 345 }
5be4efbe
LT
346}
347
847a9e5d 348static void show_ru_info(struct index_state *istate)
9d9a2f4a 349{
8a57c6e9
AR
350 struct string_list_item *item;
351
2d407e2d 352 if (!istate->resolve_undo)
9d9a2f4a 353 return;
8a57c6e9 354
2d407e2d 355 for_each_string_list_item(item, istate->resolve_undo) {
8a57c6e9
AR
356 const char *path = item->string;
357 struct resolve_undo_info *ui = item->util;
358 int i, len;
359
360 len = strlen(path);
361 if (len < max_prefix_len)
362 continue; /* outside of the prefix */
a52b321d 363 if (!match_pathspec(istate, &pathspec, path, len,
ae8d0824 364 max_prefix_len, ps_matched, 0))
8a57c6e9
AR
365 continue; /* uninterested */
366 for (i = 0; i < 3; i++) {
367 if (!ui->mode[i])
368 continue;
369 printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
d850b7a5 370 repo_find_unique_abbrev(the_repository, &ui->oid[i], abbrev),
8a57c6e9 371 i + 1);
e9a820ce 372 write_name(path);
8a57c6e9
AR
373 }
374 }
9d9a2f4a
JH
375}
376
1d35e3bf 377static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
188dce13 378 const char *fullname, const struct cache_entry *ce)
782cd4c0
JH
379{
380 int dtype = ce_to_dtype(ce);
188dce13
BW
381 return is_excluded(dir, istate, fullname, &dtype);
382}
383
384static void construct_fullname(struct strbuf *out, const struct repository *repo,
385 const struct cache_entry *ce)
386{
387 strbuf_reset(out);
388 if (repo->submodule_prefix)
389 strbuf_addstr(out, repo->submodule_prefix);
390 strbuf_addstr(out, ce->name);
782cd4c0
JH
391}
392
188dce13 393static void show_files(struct repository *repo, struct dir_struct *dir)
8695c8bf
LT
394{
395 int i;
188dce13 396 struct strbuf fullname = STRBUF_INIT;
8695c8bf
LT
397
398 /* For cached/deleted files we don't need to even do the readdir */
6ca45943 399 if (show_others || show_killed) {
2eac2a4c
JH
400 if (!show_others)
401 dir->flags |= DIR_COLLECT_KILLED_ONLY;
188dce13 402 fill_directory(dir, repo->index, &pathspec);
6ca45943 403 if (show_others)
188dce13 404 show_other_files(repo->index, dir);
6ca45943 405 if (show_killed)
188dce13 406 show_killed_files(repo->index, dir);
8695c8bf 407 }
188dce13 408
ed644d16
ZH
409 if (!(show_cached || show_stage || show_deleted || show_modified))
410 return;
78087097
DS
411
412 if (!show_sparse_dirs)
413 ensure_full_index(repo->index);
414
ed644d16
ZH
415 for (i = 0; i < repo->index->cache_nr; i++) {
416 const struct cache_entry *ce = repo->index->cache[i];
417 struct stat st;
418 int stat_err;
188dce13 419
ed644d16
ZH
420 construct_fullname(&fullname, repo, ce);
421
422 if ((dir->flags & DIR_SHOW_IGNORED) &&
423 !ce_excluded(dir, repo->index, fullname.buf, ce))
424 continue;
425 if (ce->ce_flags & CE_UPDATE)
426 continue;
427 if ((show_cached || show_stage) &&
93a7d983 428 (!show_unmerged || ce_stage(ce))) {
188dce13
BW
429 show_ce(repo, dir, ce, fullname.buf,
430 ce_stage(ce) ? tag_unmerged :
431 (ce_skip_worktree(ce) ? tag_skip_worktree :
432 tag_cached));
93a7d983
ZH
433 if (skipping_duplicates)
434 goto skip_to_next_name;
435 }
188dce13 436
ed644d16
ZH
437 if (!(show_deleted || show_modified))
438 continue;
439 if (ce_skip_worktree(ce))
440 continue;
441 stat_err = lstat(fullname.buf, &st);
442 if (stat_err && (errno != ENOENT && errno != ENOTDIR))
443 error_errno("cannot lstat '%s'", fullname.buf);
93a7d983 444 if (stat_err && show_deleted) {
ed644d16 445 show_ce(repo, dir, ce, fullname.buf, tag_removed);
93a7d983
ZH
446 if (skipping_duplicates)
447 goto skip_to_next_name;
448 }
ed644d16 449 if (show_modified &&
93a7d983 450 (stat_err || ie_modified(repo->index, ce, &st, 0))) {
ed644d16 451 show_ce(repo, dir, ce, fullname.buf, tag_modified);
93a7d983
ZH
452 if (skipping_duplicates)
453 goto skip_to_next_name;
454 }
455 continue;
456
457skip_to_next_name:
458 {
459 int j;
460 struct cache_entry **cache = repo->index->cache;
461 for (j = i + 1; j < repo->index->cache_nr; j++)
462 if (strcmp(ce->name, cache[j]->name))
463 break;
464 i = j - 1; /* compensate for the for loop */
465 }
5be4efbe 466 }
188dce13
BW
467
468 strbuf_release(&fullname);
5be4efbe
LT
469}
470
471/*
472 * Prune the index to only contain stuff starting with "prefix"
473 */
6510ae17
BW
474static void prune_index(struct index_state *istate,
475 const char *prefix, size_t prefixlen)
5be4efbe 476{
7b4158a8 477 int pos;
5be4efbe
LT
478 unsigned int first, last;
479
168e6355 480 if (!prefix || !istate->cache_nr)
7b4158a8 481 return;
6510ae17 482 pos = index_name_pos(istate, prefix, prefixlen);
5be4efbe
LT
483 if (pos < 0)
484 pos = -pos-1;
96f6d3f6 485 first = pos;
6510ae17 486 last = istate->cache_nr;
5be4efbe 487 while (last > first) {
568a05c5 488 int next = first + ((last - first) >> 1);
6510ae17 489 const struct cache_entry *ce = istate->cache[next];
7b4158a8 490 if (!strncmp(ce->name, prefix, prefixlen)) {
5be4efbe
LT
491 first = next+1;
492 continue;
8695c8bf 493 }
5be4efbe
LT
494 last = next;
495 }
f331ab9d 496 MOVE_ARRAY(istate->cache, istate->cache + pos, last - pos);
6510ae17 497 istate->cache_nr = last - pos;
5be4efbe
LT
498}
499
cbca060e
BW
500static int get_common_prefix_len(const char *common_prefix)
501{
502 int common_prefix_len;
503
504 if (!common_prefix)
505 return 0;
506
507 common_prefix_len = strlen(common_prefix);
508
509 /*
510 * If the prefix has a trailing slash, strip it so that submodules wont
511 * be pruned from the index.
512 */
513 if (common_prefix[common_prefix_len - 1] == '/')
514 common_prefix_len--;
515
516 return common_prefix_len;
517}
518
ce8e8804 519static const char * const ls_files_usage[] = {
9c9b4f2f 520 N_("git ls-files [<options>] [<file>...]"),
ce8e8804
MV
521 NULL
522};
523
ce8e8804
MV
524static int option_parse_exclude(const struct option *opt,
525 const char *arg, int unset)
526{
72aeb187 527 struct string_list *exclude_list = opt->value;
ce8e8804 528
517fe807
JK
529 BUG_ON_OPT_NEG(unset);
530
ce8e8804 531 exc_given = 1;
72aeb187 532 string_list_append(exclude_list, arg);
ce8e8804
MV
533
534 return 0;
535}
536
537static int option_parse_exclude_from(const struct option *opt,
538 const char *arg, int unset)
539{
540 struct dir_struct *dir = opt->value;
541
517fe807
JK
542 BUG_ON_OPT_NEG(unset);
543
ce8e8804 544 exc_given = 1;
65edd96a 545 add_patterns_from_file(dir, arg);
ce8e8804
MV
546
547 return 0;
548}
549
550static int option_parse_exclude_standard(const struct option *opt,
551 const char *arg, int unset)
552{
553 struct dir_struct *dir = opt->value;
554
517fe807
JK
555 BUG_ON_OPT_NEG(unset);
556 BUG_ON_OPT_ARG(arg);
557
ce8e8804
MV
558 exc_given = 1;
559 setup_standard_excludes(dir);
560
561 return 0;
562}
cf9a113d 563
efad1a56 564int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
8695c8bf 565{
72aeb187 566 int require_work_tree = 0, show_tag = 0, i;
4c217a4c 567 char *max_prefix;
ce93a4c6 568 struct dir_struct dir = DIR_INIT;
caa3d554 569 struct pattern_list *pl;
72aeb187 570 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
ce8e8804 571 struct option builtin_ls_files_options[] = {
1f3c79a9
JK
572 /* Think twice before adding "--nul" synonym to this */
573 OPT_SET_INT('z', NULL, &line_terminator,
54b4d125 574 N_("separate paths with the NUL character"), '\0'),
d5d09d47 575 OPT_BOOL('t', NULL, &show_tag,
377adc3a 576 N_("identify the file status with tags")),
d5d09d47 577 OPT_BOOL('v', NULL, &show_valid_bit,
377adc3a 578 N_("use lowercase letters for 'assume unchanged' files")),
d8c71db8
BP
579 OPT_BOOL('f', NULL, &show_fsmonitor_bit,
580 N_("use lowercase letters for 'fsmonitor clean' files")),
d5d09d47 581 OPT_BOOL('c', "cached", &show_cached,
377adc3a 582 N_("show cached files in the output (default)")),
d5d09d47 583 OPT_BOOL('d', "deleted", &show_deleted,
377adc3a 584 N_("show deleted files in the output")),
d5d09d47 585 OPT_BOOL('m', "modified", &show_modified,
377adc3a 586 N_("show modified files in the output")),
d5d09d47 587 OPT_BOOL('o', "others", &show_others,
377adc3a 588 N_("show other files in the output")),
ce8e8804 589 OPT_BIT('i', "ignored", &dir.flags,
377adc3a 590 N_("show ignored files in the output"),
ce8e8804 591 DIR_SHOW_IGNORED),
d5d09d47 592 OPT_BOOL('s', "stage", &show_stage,
377adc3a 593 N_("show staged contents' object name in the output")),
d5d09d47 594 OPT_BOOL('k', "killed", &show_killed,
377adc3a 595 N_("show files on the filesystem that need to be removed")),
ce8e8804 596 OPT_BIT(0, "directory", &dir.flags,
ad5fe377 597 N_("show 'other' directories' names only"),
ce8e8804 598 DIR_SHOW_OTHER_DIRECTORIES),
a7630bd4 599 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
e9008b9a 600 OPT_NEGBIT(0, "empty-directory", &dir.flags,
377adc3a 601 N_("don't show empty directories"),
ce8e8804 602 DIR_HIDE_EMPTY_DIRECTORIES),
d5d09d47 603 OPT_BOOL('u', "unmerged", &show_unmerged,
377adc3a 604 N_("show unmerged files in the output")),
d5d09d47 605 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
377adc3a 606 N_("show resolve-undo information")),
203c8533 607 OPT_CALLBACK_F('x', "exclude", &exclude_list, N_("pattern"),
377adc3a 608 N_("skip files matching pattern"),
203c8533
DL
609 PARSE_OPT_NONEG, option_parse_exclude),
610 OPT_CALLBACK_F('X', "exclude-from", &dir, N_("file"),
54b4d125 611 N_("read exclude patterns from <file>"),
203c8533 612 PARSE_OPT_NONEG, option_parse_exclude_from),
377adc3a
NTND
613 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
614 N_("read additional per-directory exclude patterns in <file>")),
203c8533 615 OPT_CALLBACK_F(0, "exclude-standard", &dir, NULL,
377adc3a 616 N_("add the standard git exclusions"),
ccf659e8 617 PARSE_OPT_NOARG | PARSE_OPT_NONEG,
203c8533 618 option_parse_exclude_standard),
3e4a67b4
NTND
619 OPT_SET_INT_F(0, "full-name", &prefix_len,
620 N_("make the output relative to the project top directory"),
621 0, PARSE_OPT_NONEG),
e77aa336
BW
622 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
623 N_("recurse through submodules")),
d5d09d47 624 OPT_BOOL(0, "error-unmatch", &error_unmatch,
377adc3a
NTND
625 N_("if any <file> is not in the index, treat this as an error")),
626 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
627 N_("pretend that paths removed since <tree-ish> are still present")),
ce8e8804 628 OPT__ABBREV(&abbrev),
d5d09d47 629 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
93a7d983
ZH
630 OPT_BOOL(0, "deduplicate", &skipping_duplicates,
631 N_("suppress duplicate entries")),
78087097
DS
632 OPT_BOOL(0, "sparse", &show_sparse_dirs,
633 N_("show sparse directories in the presence of a sparse index")),
ce74de93
ZH
634 OPT_STRING_F(0, "format", &format, N_("format"),
635 N_("format to use for the output"),
636 PARSE_OPT_NONEG),
ce8e8804
MV
637 OPT_END()
638 };
eab4ac6a 639 int ret = 0;
8695c8bf 640
cbb3167e
NTND
641 if (argc == 2 && !strcmp(argv[1], "-h"))
642 usage_with_options(ls_files_usage, builtin_ls_files_options);
643
78087097
DS
644 prepare_repo_settings(the_repository);
645 the_repository->settings.command_requires_full_index = 0;
646
efad1a56 647 prefix = cmd_prefix;
5be4efbe 648 if (prefix)
efad1a56 649 prefix_len = strlen(prefix);
ef90d6d4 650 git_config(git_default_config, NULL);
5be4efbe 651
188dce13 652 if (repo_read_index(the_repository) < 0)
c28b3d6e
NTND
653 die("index file corrupt");
654
37782920 655 argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
ce8e8804 656 ls_files_usage, 0);
65edd96a 657 pl = add_pattern_list(&dir, EXC_CMDL, "--exclude option");
72aeb187 658 for (i = 0; i < exclude_list.nr; i++) {
65edd96a 659 add_pattern(exclude_list.items[i].string, "", 0, pl, --exclude_args);
72aeb187 660 }
ce74de93
ZH
661
662 if (format && (show_stage || show_others || show_killed ||
663 show_resolve_undo || skipping_duplicates || show_eol || show_tag))
664 usage_msg_opt(_("--format cannot be used with -s, -o, -k, -t, "
665 "--resolve-undo, --deduplicate, --eol"),
666 ls_files_usage, builtin_ls_files_options);
667
d8c71db8 668 if (show_tag || show_valid_bit || show_fsmonitor_bit) {
ce8e8804
MV
669 tag_cached = "H ";
670 tag_unmerged = "M ";
671 tag_removed = "R ";
672 tag_modified = "C ";
673 tag_other = "? ";
674 tag_killed = "K ";
44a36913 675 tag_skip_worktree = "S ";
9d9a2f4a 676 tag_resolve_undo = "U ";
9ff768e9 677 }
de2e3b04 678 if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
ce8e8804
MV
679 require_work_tree = 1;
680 if (show_unmerged)
681 /*
682 * There's no point in showing unmerged unless
683 * you also show the stage information.
684 */
685 show_stage = 1;
93a7d983
ZH
686 if (show_tag || show_stage)
687 skipping_duplicates = 0;
ce8e8804
MV
688 if (dir.exclude_per_dir)
689 exc_given = 1;
9ff768e9 690
7d8ae932
MH
691 if (require_work_tree && !is_inside_work_tree())
692 setup_work_tree();
6d9ba67b 693
e77aa336 694 if (recurse_submodules &&
290eada0 695 (show_deleted || show_others || show_unmerged ||
07c01b9f 696 show_killed || show_modified || show_resolve_undo || with_tree))
e77aa336
BW
697 die("ls-files --recurse-submodules unsupported mode");
698
699 if (recurse_submodules && error_unmatch)
700 die("ls-files --recurse-submodules does not support "
701 "--error-unmatch");
702
9e06d6ed 703 parse_pathspec(&pathspec, 0,
cbca060e 704 PATHSPEC_PREFER_CWD,
9e06d6ed 705 prefix, argv);
f3670a57 706
75a6315f
BW
707 /*
708 * Find common prefix for all pathspec's
709 * This is used as a performance optimization which unfortunately cannot
188dce13
BW
710 * be done when recursing into submodules because when a pathspec is
711 * given which spans repository boundaries you can't simply remove the
712 * submodule entry because the pathspec may match something inside the
713 * submodule.
75a6315f
BW
714 */
715 if (recurse_submodules)
716 max_prefix = NULL;
717 else
718 max_prefix = common_prefix(&pathspec);
cbca060e
BW
719 max_prefix_len = get_common_prefix_len(max_prefix);
720
188dce13 721 prune_index(the_repository->index, max_prefix, max_prefix_len);
5be4efbe 722
bba319b5 723 /* Treat unmatching pathspec elements as errors */
9e06d6ed 724 if (pathspec.nr && error_unmatch)
8b54c234 725 ps_matched = xcalloc(pathspec.nr, 1);
bba319b5 726
b338e9f6
EN
727 if ((dir.flags & DIR_SHOW_IGNORED) && !show_others && !show_cached)
728 die("ls-files -i must be used with either -o or -c");
729
ac78b009
BW
730 if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
731 die("ls-files --ignored needs some exclude pattern");
8695c8bf
LT
732
733 /* With no flags, we default to showing the cached files */
0b437a18
RS
734 if (!(show_stage || show_deleted || show_others || show_unmerged ||
735 show_killed || show_modified || show_resolve_undo))
8695c8bf
LT
736 show_cached = 1;
737
64586e75
JH
738 if (with_tree) {
739 /*
740 * Basic sanity check; show-stages and show-unmerged
741 * would not make any sense with this option.
742 */
743 if (show_stage || show_unmerged)
12909b6b 744 die(_("options '%s' and '%s' cannot be used together"), "ls-files --with-tree", "-s/-u");
188dce13 745 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
64586e75 746 }
188dce13
BW
747
748 show_files(the_repository, &dir);
749
9d9a2f4a 750 if (show_resolve_undo)
188dce13 751 show_ru_info(the_repository->index);
bba319b5 752
eab4ac6a
ÆAB
753 if (ps_matched && report_path_error(ps_matched, &pathspec)) {
754 fprintf(stderr, "Did you forget to 'git add'?\n");
755 ret = 1;
bba319b5
JH
756 }
757
272f0a57 758 string_list_clear(&exclude_list, 0);
eceba532 759 dir_clear(&dir);
4c217a4c 760 free(max_prefix);
eab4ac6a 761 return ret;
8695c8bf 762}