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