2 * "git clean" builtin command
4 * Copyright (C) 2007 Shawn Bohrer
6 * Based on git-clean.sh by Pavel Roskin
12 #include "parse-options.h"
14 #include "string-list.h"
18 static int force = -1; /* unset */
20 static const char *const builtin_clean_usage[] = {
21 N_("git clean [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>..."),
25 static const char *msg_remove = N_("Removing %s\n");
26 static const char *msg_would_remove = N_("Would remove %s\n");
27 static const char *msg_skip_git_dir = N_("Skipping repository %s\n");
28 static const char *msg_would_skip_git_dir = N_("Would skip repository %s\n");
29 static const char *msg_warn_remove_failed = N_("failed to remove %s");
31 static int git_clean_config(const char *var, const char *value, void *cb)
33 if (!strcmp(var, "clean.requireforce"))
34 force = !git_config_bool(var, value);
35 return git_default_config(var, value, cb);
38 static int exclude_cb(const struct option *opt, const char *arg, int unset)
40 struct string_list *exclude_list = opt->value;
41 string_list_append(exclude_list, arg);
45 static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
46 int dry_run, int quiet, int *dir_gone)
49 struct strbuf quoted = STRBUF_INIT;
51 int res = 0, ret = 0, gone = 1, original_len = path->len, len, i;
52 unsigned char submodule_head[20];
53 struct string_list dels = STRING_LIST_INIT_DUP;
57 if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
58 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
60 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
61 printf(dry_run ? _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
69 dir = opendir(path->buf);
71 /* an empty dir could be removed even if it is unreadble */
72 res = dry_run ? 0 : rmdir(path->buf);
74 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
75 warning(_(msg_warn_remove_failed), quoted.buf);
81 if (path->buf[original_len - 1] != '/')
82 strbuf_addch(path, '/');
85 while ((e = readdir(dir)) != NULL) {
87 if (is_dot_or_dotdot(e->d_name))
90 strbuf_setlen(path, len);
91 strbuf_addstr(path, e->d_name);
92 if (lstat(path->buf, &st))
94 else if (S_ISDIR(st.st_mode)) {
95 if (remove_dirs(path, prefix, force_flag, dry_run, quiet, &gone))
98 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
99 string_list_append(&dels, quoted.buf);
104 res = dry_run ? 0 : unlink(path->buf);
106 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
107 string_list_append(&dels, quoted.buf);
109 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
110 warning(_(msg_warn_remove_failed), quoted.buf);
117 /* path too long, stat fails, or non-directory still exists */
124 strbuf_setlen(path, original_len);
127 res = dry_run ? 0 : rmdir(path->buf);
131 quote_path_relative(path->buf, strlen(path->buf), "ed, prefix);
132 warning(_(msg_warn_remove_failed), quoted.buf);
138 if (!*dir_gone && !quiet) {
139 for (i = 0; i < dels.nr; i++)
140 printf(dry_run ? _(msg_would_remove) : _(msg_remove), dels.items[i].string);
142 string_list_clear(&dels, 0);
146 int cmd_clean(int argc, const char **argv, const char *prefix)
149 int dry_run = 0, remove_directories = 0, quiet = 0, ignored = 0;
150 int ignored_only = 0, config_set = 0, errors = 0, gone = 1;
151 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
152 struct strbuf directory = STRBUF_INIT;
153 struct dir_struct dir;
154 struct pathspec pathspec;
155 struct strbuf buf = STRBUF_INIT;
156 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
157 struct exclude_list *el;
159 struct option options[] = {
160 OPT__QUIET(&quiet, N_("do not print names of files removed")),
161 OPT__DRY_RUN(&dry_run, N_("dry run")),
162 OPT__FORCE(&force, N_("force")),
163 OPT_BOOLEAN('d', NULL, &remove_directories,
164 N_("remove whole directories")),
165 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, N_("pattern"),
166 N_("add <pattern> to ignore rules"), PARSE_OPT_NONEG, exclude_cb },
167 OPT_BOOLEAN('x', NULL, &ignored, N_("remove ignored files, too")),
168 OPT_BOOLEAN('X', NULL, &ignored_only,
169 N_("remove only ignored files")),
173 git_config(git_clean_config, NULL);
179 argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
182 memset(&dir, 0, sizeof(dir));
184 dir.flags |= DIR_SHOW_IGNORED;
186 if (ignored && ignored_only)
187 die(_("-x and -X cannot be used together"));
189 if (!dry_run && !force) {
191 die(_("clean.requireForce set to true and neither -n nor -f given; "
192 "refusing to clean"));
194 die(_("clean.requireForce defaults to true and neither -n nor -f given; "
195 "refusing to clean"));
201 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
203 if (read_cache() < 0)
204 die(_("index file corrupt"));
207 setup_standard_excludes(&dir);
209 el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
210 for (i = 0; i < exclude_list.nr; i++)
211 add_exclude(exclude_list.items[i].string, "", 0, el, -(i+1));
213 parse_pathspec(&pathspec, 0,
217 fill_directory(&dir, &pathspec);
219 for (i = 0; i < dir.nr; i++) {
220 struct dir_entry *ent = dir.entries[i];
223 struct cache_entry *ce;
227 * Remove the '/' at the end that directory
228 * walking adds for directory entries.
231 if (len && ent->name[len-1] == '/')
233 pos = cache_name_pos(ent->name, len);
235 continue; /* exact match */
237 if (pos < active_nr) {
238 ce = active_cache[pos];
239 if (ce_namelen(ce) == len &&
240 !memcmp(ce->name, ent->name, len))
241 continue; /* Yup, this one exists unmerged */
245 * we might have removed this as part of earlier
246 * recursive directory removal, so lstat() here could
249 if (lstat(ent->name, &st))
253 matches = match_pathspec_depth(&pathspec, ent->name,
256 if (S_ISDIR(st.st_mode)) {
257 strbuf_addstr(&directory, ent->name);
258 if (remove_directories || (matches == MATCHED_EXACTLY)) {
259 if (remove_dirs(&directory, prefix, rm_flags, dry_run, quiet, &gone))
261 if (gone && !quiet) {
262 qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
263 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
266 strbuf_reset(&directory);
268 if (pathspec.nr && !matches)
270 res = dry_run ? 0 : unlink(ent->name);
272 qname = quote_path_relative(ent->name, -1, &buf, prefix);
273 warning(_(msg_warn_remove_failed), qname);
276 qname = quote_path_relative(ent->name, -1, &buf, prefix);
277 printf(dry_run ? _(msg_would_remove) : _(msg_remove), qname);
282 strbuf_release(&directory);
283 string_list_clear(&exclude_list, 0);
284 return (errors != 0);