clean: require double -f options to nuke nested git repository and work tree
[git/git.git] / builtin-clean.c
CommitLineData
113f10f2
SB
1/*
2 * "git clean" builtin command
3 *
4 * Copyright (C) 2007 Shawn Bohrer
5 *
6 * Based on git-clean.sh by Pavel Roskin
7 */
8
9#include "builtin.h"
10#include "cache.h"
11#include "dir.h"
12#include "parse-options.h"
1fb32894 13#include "quote.h"
113f10f2 14
625db1b7 15static int force = -1; /* unset */
113f10f2
SB
16
17static const char *const builtin_clean_usage[] = {
1b1dd23f 18 "git clean [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...",
113f10f2
SB
19 NULL
20};
21
ef90d6d4 22static int git_clean_config(const char *var, const char *value, void *cb)
113f10f2
SB
23{
24 if (!strcmp(var, "clean.requireforce"))
25 force = !git_config_bool(var, value);
ef90d6d4 26 return git_default_config(var, value, cb);
113f10f2
SB
27}
28
29int cmd_clean(int argc, const char **argv, const char *prefix)
30{
d871c869 31 int i;
113f10f2 32 int show_only = 0, remove_directories = 0, quiet = 0, ignored = 0;
aa9c83c2 33 int ignored_only = 0, baselen = 0, config_set = 0, errors = 0;
a0f4afbe 34 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
f285a2d7 35 struct strbuf directory = STRBUF_INIT;
113f10f2 36 struct dir_struct dir;
113f10f2 37 static const char **pathspec;
f285a2d7 38 struct strbuf buf = STRBUF_INIT;
1fb32894 39 const char *qname;
d871c869 40 char *seen = NULL;
113f10f2
SB
41 struct option options[] = {
42 OPT__QUIET(&quiet),
43 OPT__DRY_RUN(&show_only),
44 OPT_BOOLEAN('f', NULL, &force, "force"),
45 OPT_BOOLEAN('d', NULL, &remove_directories,
46 "remove whole directories"),
47 OPT_BOOLEAN('x', NULL, &ignored, "remove ignored files, too"),
48 OPT_BOOLEAN('X', NULL, &ignored_only,
49 "remove only ignored files"),
50 OPT_END()
51 };
52
ef90d6d4 53 git_config(git_clean_config, NULL);
625db1b7
JH
54 if (force < 0)
55 force = 0;
56 else
57 config_set = 1;
58
37782920
SB
59 argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
60 0);
113f10f2
SB
61
62 memset(&dir, 0, sizeof(dir));
1617adc7 63 if (ignored_only)
7c4c97c0 64 dir.flags |= DIR_SHOW_IGNORED;
113f10f2
SB
65
66 if (ignored && ignored_only)
67 die("-x and -X cannot be used together");
68
69 if (!show_only && !force)
625db1b7
JH
70 die("clean.requireForce%s set and -n or -f not given; "
71 "refusing to clean", config_set ? "" : " not");
113f10f2 72
a0f4afbe
JH
73 if (force > 1)
74 rm_flags = 0;
75
7c4c97c0 76 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
113f10f2 77
1617adc7
SB
78 if (!ignored)
79 setup_standard_excludes(&dir);
113f10f2
SB
80
81 pathspec = get_pathspec(prefix, argv);
82 read_cache();
83
1d8842d9 84 fill_directory(&dir, pathspec);
113f10f2 85
d871c869 86 if (pathspec)
a8db80c2 87 seen = xmalloc(argc > 0 ? argc : 1);
d871c869
JH
88
89 for (i = 0; i < dir.nr; i++) {
90 struct dir_entry *ent = dir.entries[i];
f2d0df71
SB
91 int len, pos;
92 int matches = 0;
113f10f2
SB
93 struct cache_entry *ce;
94 struct stat st;
113f10f2
SB
95
96 /*
97 * Remove the '/' at the end that directory
98 * walking adds for directory entries.
99 */
100 len = ent->len;
101 if (len && ent->name[len-1] == '/')
102 len--;
103 pos = cache_name_pos(ent->name, len);
104 if (0 <= pos)
105 continue; /* exact match */
106 pos = -pos - 1;
107 if (pos < active_nr) {
108 ce = active_cache[pos];
109 if (ce_namelen(ce) == len &&
110 !memcmp(ce->name, ent->name, len))
111 continue; /* Yup, this one exists unmerged */
112 }
113
d871c869
JH
114 /*
115 * we might have removed this as part of earlier
116 * recursive directory removal, so lstat() here could
117 * fail with ENOENT.
118 */
119 if (lstat(ent->name, &st))
120 continue;
121
122 if (pathspec) {
a8db80c2 123 memset(seen, 0, argc > 0 ? argc : 1);
f2d0df71 124 matches = match_pathspec(pathspec, ent->name, len,
d871c869 125 baselen, seen);
d871c869
JH
126 }
127
128 if (S_ISDIR(st.st_mode)) {
113f10f2 129 strbuf_addstr(&directory, ent->name);
1fb32894 130 qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
f2d0df71
SB
131 if (show_only && (remove_directories ||
132 (matches == MATCHED_EXACTLY))) {
1fb32894 133 printf("Would remove %s\n", qname);
f2d0df71
SB
134 } else if (remove_directories ||
135 (matches == MATCHED_EXACTLY)) {
aa9c83c2 136 if (!quiet)
1fb32894 137 printf("Removing %s\n", qname);
a0f4afbe
JH
138 if (remove_dir_recursively(&directory,
139 rm_flags) != 0) {
1fb32894 140 warning("failed to remove '%s'", qname);
aa9c83c2
MV
141 errors++;
142 }
113f10f2 143 } else if (show_only) {
1fb32894 144 printf("Would not remove %s\n", qname);
113f10f2 145 } else {
1fb32894 146 printf("Not removing %s\n", qname);
113f10f2
SB
147 }
148 strbuf_reset(&directory);
149 } else {
d871c869
JH
150 if (pathspec && !matches)
151 continue;
1fb32894 152 qname = quote_path_relative(ent->name, -1, &buf, prefix);
113f10f2 153 if (show_only) {
1fb32894 154 printf("Would remove %s\n", qname);
113f10f2
SB
155 continue;
156 } else if (!quiet) {
1fb32894 157 printf("Removing %s\n", qname);
113f10f2 158 }
aa9c83c2 159 if (unlink(ent->name) != 0) {
1fb32894 160 warning("failed to remove '%s'", qname);
aa9c83c2
MV
161 errors++;
162 }
113f10f2
SB
163 }
164 }
d871c869 165 free(seen);
113f10f2
SB
166
167 strbuf_release(&directory);
aa9c83c2 168 return (errors != 0);
113f10f2 169}