Skip to content

Commit cdf40a8

Browse files
dschodscho
committed
Backport branch 'show-ignored-directory'
This branch introduces an experimental option allowing `git status` to list all untracked files individually, but show ignored directories' names only instead of all ignored files. This topic branch was originally accepted into Git for Windows v2.14.0 and is hereby backported to v2.13.1. Signed-off-by: Johannes Schindelin <[email protected]>
2 parents 035b737 + e5dabda commit cdf40a8

File tree

8 files changed

+216
-8
lines changed

8 files changed

+216
-8
lines changed

‎Documentation/git-status.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ configuration variable documented in linkgit:git-config[1].
9797
--ignored::
9898
Show ignored files as well.
9999

100+
--show-ignored-directory::
101+
(EXPERIMENTAL) Show directories that are ignored, instead of individual
102+
files. Does not recurse into excluded directories when listing all
103+
untracked files.
104+
100105
-z::
101106
Terminate entries with NUL, instead of LF. This implies
102107
the `--porcelain=v1` output format if no other format is given.

‎Documentation/technical/api-directory-listing.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ The notable options are:
3333
Similar to `DIR_SHOW_IGNORED`, but return ignored files in `ignored[]`
3434
in addition to untracked files in `entries[]`.
3535

36+
`DIR_SHOW_IGNORED_DIRECTORY`:::
37+
38+
(EXPERIMENTAL) If this is set, non-empty directories that match an
39+
ignore pattern are returned. The individual files contained in
40+
ignored directories are not included.
41+
3642
`DIR_COLLECT_IGNORED`:::
3743

3844
Special mode for git-add. Return ignored files in `ignored[]` and

‎builtin/commit.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1331,6 +1331,7 @@ static int git_status_config(const char *k, const char *v, void *cb)
13311331
int cmd_status(int argc, const char **argv, const char *prefix)
13321332
{
13331333
static int no_lock_index = 0;
1334+
static int show_ignored_directory = 0;
13341335
static struct wt_status s;
13351336
int fd;
13361337
struct object_id oid;
@@ -1360,6 +1361,8 @@ int cmd_status(int argc, const char **argv, const char *prefix)
13601361
OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
13611362
OPT_BOOL(0, "no-lock-index", &no_lock_index,
13621363
N_("do not lock the index")),
1364+
OPT_BOOL(0, "show-ignored-directory", &show_ignored_directory,
1365+
N_("(EXPERIMENTAL) Only show directories that match an ignore pattern name.")),
13631366
OPT_END(),
13641367
};
13651368

@@ -1398,6 +1401,7 @@ int cmd_status(int argc, const char **argv, const char *prefix)
13981401
s.ignore_submodule_arg = ignore_submodule_arg;
13991402
s.status_format = status_format;
14001403
s.verbose = verbose;
1404+
s.show_ignored_directory = show_ignored_directory;
14011405

14021406
wt_status_collect(&s);
14031407

‎dir.c

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ struct cached_dir {
4646

4747
static enum path_treatment read_directory_recursive(struct dir_struct *dir,
4848
const char *path, int len, struct untracked_cache_dir *untracked,
49-
int check_only, const struct pathspec *pathspec);
49+
int check_only, int stop_at_first_file,
50+
const struct pathspec *pathspec);
5051
static int get_dtype(struct dirent *de, const char *path, int len);
5152

5253
int fspathcmp(const char *a, const char *b)
@@ -1359,6 +1360,21 @@ static enum path_treatment treat_directory(struct dir_struct *dir,
13591360
case index_nonexistent:
13601361
if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
13611362
break;
1363+
if (exclude &&
1364+
(dir->flags & DIR_SHOW_IGNORED_TOO) &&
1365+
(dir->flags & DIR_SHOW_IGNORED_DIRECTORY)) {
1366+
1367+
/*
1368+
* This is an excluded directory, and we are only
1369+
* showing the name of a excluded directory.
1370+
* Check to see if there are any contained files
1371+
* to determine if the directory is empty or not.
1372+
*/
1373+
if (read_directory_recursive(dir, dirname, len,
1374+
untracked, 1, 1, pathspec) == path_excluded)
1375+
return path_excluded;
1376+
return path_none;
1377+
}
13621378
if (!(dir->flags & DIR_NO_GITLINKS)) {
13631379
unsigned char sha1[20];
13641380
if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
@@ -1368,16 +1384,16 @@ static enum path_treatment treat_directory(struct dir_struct *dir,
13681384
}
13691385

13701386
/* This is the "show_other_directories" case */
1371-
13721387
if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
13731388
return exclude ? path_excluded : path_untracked;
13741389

13751390
untracked = lookup_untracked(dir->untracked, untracked,
13761391
dirname + baselen, len - baselen);
13771392
return read_directory_recursive(dir, dirname, len,
1378-
untracked, 1, pathspec);
1393+
untracked, 1, 0, pathspec);
13791394
}
13801395

1396+
13811397
/*
13821398
* This is an inexact early pruning of any recursive directory
13831399
* reading - if the path cannot possibly be in the pathspec,
@@ -1599,7 +1615,7 @@ static enum path_treatment treat_path_fast(struct dir_struct *dir,
15991615
* with check_only set.
16001616
*/
16011617
return read_directory_recursive(dir, path->buf, path->len,
1602-
cdir->ucd, 1, pathspec);
1618+
cdir->ucd, 1, 0, pathspec);
16031619
/*
16041620
* We get path_recurse in the first run when
16051621
* directory_exists_in_index() returns index_nonexistent. We
@@ -1760,7 +1776,8 @@ static void close_cached_dir(struct cached_dir *cdir)
17601776
*/
17611777
static enum path_treatment read_directory_recursive(struct dir_struct *dir,
17621778
const char *base, int baselen,
1763-
struct untracked_cache_dir *untracked, int check_only,
1779+
struct untracked_cache_dir *untracked,
1780+
int check_only, int stop_at_first_file,
17641781
const struct pathspec *pathspec)
17651782
{
17661783
struct cached_dir cdir;
@@ -1792,12 +1809,32 @@ static enum path_treatment read_directory_recursive(struct dir_struct *dir,
17921809
subdir_state =
17931810
read_directory_recursive(dir, path.buf,
17941811
path.len, ud,
1795-
check_only, pathspec);
1812+
check_only, stop_at_first_file, pathspec);
17961813
if (subdir_state > dir_state)
17971814
dir_state = subdir_state;
17981815
}
17991816

18001817
if (check_only) {
1818+
if (stop_at_first_file) {
1819+
/*
1820+
* In general, if we are stopping at the first found file,
1821+
* We can only signal that a path of at least "excluded" was
1822+
* found. If the first file we find is "excluded" - there might
1823+
* be other untracked files later on that will not be searched.
1824+
*
1825+
* In current usage of this function, stop_at_first_file will
1826+
* only be set when called from a directory that matches the
1827+
* exclude pattern - there should be no untracked files -
1828+
* all contents should be marked as excluded.
1829+
*/
1830+
if (dir_state == path_excluded)
1831+
break;
1832+
else if (dir_state > path_excluded) {
1833+
dir_state = path_excluded;
1834+
break;
1835+
}
1836+
}
1837+
18011838
/* abort early if maximum state has been reached */
18021839
if (dir_state == path_untracked) {
18031840
if (cdir.fdir)
@@ -2059,9 +2096,10 @@ int read_directory(struct dir_struct *dir, const char *path,
20592096
*/
20602097
dir->untracked = NULL;
20612098
if (!len || treat_leading_path(dir, path, len, pathspec))
2062-
read_directory_recursive(dir, path, len, untracked, 0, pathspec);
2099+
read_directory_recursive(dir, path, len, untracked, 0, 0, pathspec);
20632100
QSORT(dir->entries, dir->nr, cmp_name);
20642101
QSORT(dir->ignored, dir->ignored_nr, cmp_name);
2102+
20652103
if (dir->untracked) {
20662104
static struct trace_key trace_untracked_stats = TRACE_KEY_INIT(UNTRACKED_STATS);
20672105
trace_printf_key(&trace_untracked_stats,

‎dir.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ struct dir_struct {
151151
DIR_NO_GITLINKS = 1<<3,
152152
DIR_COLLECT_IGNORED = 1<<4,
153153
DIR_SHOW_IGNORED_TOO = 1<<5,
154-
DIR_COLLECT_KILLED_ONLY = 1<<6
154+
DIR_COLLECT_KILLED_ONLY = 1<<6,
155+
DIR_SHOW_IGNORED_DIRECTORY = 1<<8
155156
} flags;
156157
struct dir_entry **entries;
157158
struct dir_entry **ignored;

‎t/t7519-status-show-ignored-directory.sh

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
#!/bin/sh
2+
#
3+
#
4+
5+
test_description='git status collapse ignored'
6+
7+
. ./test-lib.sh
8+
9+
10+
cat >.gitignore <<\EOF
11+
*.ign
12+
ignored_dir/
13+
!*.unignore
14+
EOF
15+
16+
# commit initial ignore file
17+
test_expect_success 'setup initial commit and ignore file' '
18+
git add . &&
19+
test_tick &&
20+
git commit -m "Initial commit"
21+
'
22+
23+
cat >expect <<\EOF
24+
? expect
25+
? output
26+
! dir/ignored/ignored_1.ign
27+
! dir/ignored/ignored_2.ign
28+
! ignored/ignored_1.ign
29+
! ignored/ignored_2.ign
30+
EOF
31+
32+
# Test status behavior on folder with ignored files
33+
test_expect_success 'setup folder with ignored files' '
34+
mkdir -p ignored dir/ignored &&
35+
touch ignored/ignored_1.ign ignored/ignored_2.ign \
36+
dir/ignored/ignored_1.ign dir/ignored/ignored_2.ign
37+
'
38+
39+
test_expect_success 'Verify behavior of status on folders with ignored files' '
40+
test_when_finished "git clean -fdx" &&
41+
git status --porcelain=v2 --ignored --untracked-files=all --show-ignored-directory >output &&
42+
test_i18ncmp expect output
43+
'
44+
45+
# Test status bahavior on folder with tracked and ignored files
46+
cat >expect <<\EOF
47+
? expect
48+
? output
49+
! dir/tracked_ignored/ignored_1.ign
50+
! dir/tracked_ignored/ignored_2.ign
51+
! tracked_ignored/ignored_1.ign
52+
! tracked_ignored/ignored_2.ign
53+
EOF
54+
55+
test_expect_success 'setup folder with tracked & ignored files' '
56+
mkdir -p tracked_ignored dir/tracked_ignored &&
57+
touch tracked_ignored/tracked_1 tracked_ignored/tracked_2 \
58+
tracked_ignored/ignored_1.ign tracked_ignored/ignored_2.ign \
59+
dir/tracked_ignored/tracked_1 dir/tracked_ignored/tracked_2 \
60+
dir/tracked_ignored/ignored_1.ign dir/tracked_ignored/ignored_2.ign &&
61+
62+
git add tracked_ignored/tracked_1 tracked_ignored/tracked_2 \
63+
dir/tracked_ignored/tracked_1 dir/tracked_ignored/tracked_2 &&
64+
test_tick &&
65+
git commit -m "commit tracked files"
66+
'
67+
68+
test_expect_success 'Verify status on folder with tracked & ignored files' '
69+
test_when_finished "git clean -fdx && git reset HEAD~1 --hard" &&
70+
git status --porcelain=v2 --ignored --untracked-files=all --show-ignored-directory >output &&
71+
test_i18ncmp expect output
72+
'
73+
74+
75+
# Test status behavior on folder with untracked and ignored files
76+
cat >expect <<\EOF
77+
? dir/untracked_ignored/untracked_1
78+
? dir/untracked_ignored/untracked_2
79+
? expect
80+
? output
81+
? untracked_ignored/untracked_1
82+
? untracked_ignored/untracked_2
83+
! dir/untracked_ignored/ignored_1.ign
84+
! dir/untracked_ignored/ignored_2.ign
85+
! untracked_ignored/ignored_1.ign
86+
! untracked_ignored/ignored_2.ign
87+
EOF
88+
89+
test_expect_success 'setup folder with tracked & ignored files' '
90+
mkdir -p untracked_ignored dir/untracked_ignored &&
91+
touch untracked_ignored/untracked_1 untracked_ignored/untracked_2 \
92+
untracked_ignored/ignored_1.ign untracked_ignored/ignored_2.ign \
93+
dir/untracked_ignored/untracked_1 dir/untracked_ignored/untracked_2 \
94+
dir/untracked_ignored/ignored_1.ign dir/untracked_ignored/ignored_2.ign
95+
'
96+
97+
test_expect_success 'Verify status on folder with tracked & ignored files' '
98+
test_when_finished "git clean -fdx" &&
99+
git status --porcelain=v2 --ignored --untracked-files=all --show-ignored-directory >output &&
100+
test_i18ncmp expect output
101+
'
102+
103+
# Test status behavior on ignored folder
104+
cat >expect <<\EOF
105+
? expect
106+
? output
107+
! ignored_dir/
108+
EOF
109+
110+
test_expect_success 'setup folder with tracked & ignored files' '
111+
mkdir ignored_dir &&
112+
touch ignored_dir/ignored_1 ignored_dir/ignored_2 \
113+
ignored_dir/ignored_1.ign ignored_dir/ignored_2.ign
114+
'
115+
116+
test_expect_success 'Verify status on folder with tracked & ignored files' '
117+
test_when_finished "git clean -fdx" &&
118+
git status --porcelain=v2 --ignored --untracked-files=all --show-ignored-directory >output &&
119+
test_i18ncmp expect output
120+
'
121+
122+
# Test status behavior on ignored folder with tracked file
123+
cat >expect <<\EOF
124+
? expect
125+
? output
126+
! ignored_dir/ignored_1
127+
! ignored_dir/ignored_1.ign
128+
! ignored_dir/ignored_2
129+
! ignored_dir/ignored_2.ign
130+
EOF
131+
132+
test_expect_success 'setup folder with tracked & ignored files' '
133+
mkdir ignored_dir &&
134+
touch ignored_dir/ignored_1 ignored_dir/ignored_2 \
135+
ignored_dir/ignored_1.ign ignored_dir/ignored_2.ign \
136+
ignored_dir/tracked &&
137+
git add -f ignored_dir/tracked &&
138+
test_tick &&
139+
git commit -m "Force add file in ignored directory"
140+
'
141+
142+
test_expect_success 'Verify status on folder with tracked & ignored files' '
143+
test_when_finished "git clean -fdx && git reset HEAD~1 --hard" &&
144+
git status --porcelain=v2 --ignored --untracked-files=all --show-ignored-directory >output &&
145+
test_i18ncmp expect output
146+
'
147+
148+
test_done
149+

‎wt-status.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,10 @@ static void wt_status_collect_untracked(struct wt_status *s)
663663
dir.flags |= DIR_SHOW_IGNORED_TOO;
664664
else
665665
dir.untracked = the_index.untracked;
666+
667+
if (s->show_ignored_directory)
668+
dir.flags |= DIR_SHOW_IGNORED_DIRECTORY;
669+
666670
setup_standard_excludes(&dir);
667671

668672
fill_directory(&dir, &s->pathspec);

‎wt-status.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ struct wt_status {
7272
int submodule_summary;
7373
int show_ignored_files;
7474
enum untracked_status_type show_untracked_files;
75+
int show_ignored_directory;
7576
const char *ignore_submodule_arg;
7677
char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
7778
unsigned colopts;

0 commit comments

Comments
 (0)