add OPT__FORCE
[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"
07de4eba 13#include "string-list.h"
1fb32894 14#include "quote.h"
113f10f2 15
625db1b7 16static int force = -1; /* unset */
113f10f2
SB
17
18static const char *const builtin_clean_usage[] = {
07de4eba 19 "git clean [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <paths>...",
113f10f2
SB
20 NULL
21};
22
ef90d6d4 23static int git_clean_config(const char *var, const char *value, void *cb)
113f10f2
SB
24{
25 if (!strcmp(var, "clean.requireforce"))
26 force = !git_config_bool(var, value);
ef90d6d4 27 return git_default_config(var, value, cb);
113f10f2
SB
28}
29
07de4eba
JH
30static int exclude_cb(const struct option *opt, const char *arg, int unset)
31{
32 struct string_list *exclude_list = opt->value;
33 string_list_append(exclude_list, arg);
34 return 0;
35}
36
113f10f2
SB
37int cmd_clean(int argc, const char **argv, const char *prefix)
38{
d871c869 39 int i;
113f10f2 40 int show_only = 0, remove_directories = 0, quiet = 0, ignored = 0;
aa9c83c2 41 int ignored_only = 0, baselen = 0, config_set = 0, errors = 0;
a0f4afbe 42 int rm_flags = REMOVE_DIR_KEEP_NESTED_GIT;
f285a2d7 43 struct strbuf directory = STRBUF_INIT;
113f10f2 44 struct dir_struct dir;
113f10f2 45 static const char **pathspec;
f285a2d7 46 struct strbuf buf = STRBUF_INIT;
bdab6a59 47 struct string_list exclude_list = STRING_LIST_INIT_NODUP;
1fb32894 48 const char *qname;
d871c869 49 char *seen = NULL;
113f10f2 50 struct option options[] = {
d52ee6e6 51 OPT__QUIET(&quiet, "be quiet"),
e21adb8c 52 OPT__DRY_RUN(&show_only, "dry run"),
76946b76 53 OPT__FORCE(&force, "force"),
113f10f2
SB
54 OPT_BOOLEAN('d', NULL, &remove_directories,
55 "remove whole directories"),
07de4eba
JH
56 { OPTION_CALLBACK, 'e', "exclude", &exclude_list, "pattern",
57 "exclude <pattern>", PARSE_OPT_NONEG, exclude_cb },
113f10f2
SB
58 OPT_BOOLEAN('x', NULL, &ignored, "remove ignored files, too"),
59 OPT_BOOLEAN('X', NULL, &ignored_only,
60 "remove only ignored files"),
61 OPT_END()
62 };
63
ef90d6d4 64 git_config(git_clean_config, NULL);
625db1b7
JH
65 if (force < 0)
66 force = 0;
67 else
68 config_set = 1;
69
37782920
SB
70 argc = parse_options(argc, argv, prefix, options, builtin_clean_usage,
71 0);
113f10f2
SB
72
73 memset(&dir, 0, sizeof(dir));
1617adc7 74 if (ignored_only)
7c4c97c0 75 dir.flags |= DIR_SHOW_IGNORED;
113f10f2
SB
76
77 if (ignored && ignored_only)
78 die("-x and -X cannot be used together");
79
80 if (!show_only && !force)
89c38500
MG
81 die("clean.requireForce %s to true and neither -n nor -f given; "
82 "refusing to clean", config_set ? "set" : "defaults");
113f10f2 83
a0f4afbe
JH
84 if (force > 1)
85 rm_flags = 0;
86
7c4c97c0 87 dir.flags |= DIR_SHOW_OTHER_DIRECTORIES;
113f10f2 88
c28b3d6e
NTND
89 if (read_cache() < 0)
90 die("index file corrupt");
91
1617adc7
SB
92 if (!ignored)
93 setup_standard_excludes(&dir);
113f10f2 94
07de4eba
JH
95 for (i = 0; i < exclude_list.nr; i++)
96 add_exclude(exclude_list.items[i].string, "", 0, dir.exclude_list);
97
113f10f2 98 pathspec = get_pathspec(prefix, argv);
113f10f2 99
1d8842d9 100 fill_directory(&dir, pathspec);
113f10f2 101
d871c869 102 if (pathspec)
a8db80c2 103 seen = xmalloc(argc > 0 ? argc : 1);
d871c869
JH
104
105 for (i = 0; i < dir.nr; i++) {
106 struct dir_entry *ent = dir.entries[i];
f2d0df71
SB
107 int len, pos;
108 int matches = 0;
113f10f2
SB
109 struct cache_entry *ce;
110 struct stat st;
113f10f2
SB
111
112 /*
113 * Remove the '/' at the end that directory
114 * walking adds for directory entries.
115 */
116 len = ent->len;
117 if (len && ent->name[len-1] == '/')
118 len--;
119 pos = cache_name_pos(ent->name, len);
120 if (0 <= pos)
121 continue; /* exact match */
122 pos = -pos - 1;
123 if (pos < active_nr) {
124 ce = active_cache[pos];
125 if (ce_namelen(ce) == len &&
126 !memcmp(ce->name, ent->name, len))
127 continue; /* Yup, this one exists unmerged */
128 }
129
d871c869
JH
130 /*
131 * we might have removed this as part of earlier
132 * recursive directory removal, so lstat() here could
133 * fail with ENOENT.
134 */
135 if (lstat(ent->name, &st))
136 continue;
137
138 if (pathspec) {
a8db80c2 139 memset(seen, 0, argc > 0 ? argc : 1);
f2d0df71 140 matches = match_pathspec(pathspec, ent->name, len,
d871c869 141 baselen, seen);
d871c869
JH
142 }
143
144 if (S_ISDIR(st.st_mode)) {
113f10f2 145 strbuf_addstr(&directory, ent->name);
1fb32894 146 qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
f2d0df71
SB
147 if (show_only && (remove_directories ||
148 (matches == MATCHED_EXACTLY))) {
1fb32894 149 printf("Would remove %s\n", qname);
f2d0df71
SB
150 } else if (remove_directories ||
151 (matches == MATCHED_EXACTLY)) {
aa9c83c2 152 if (!quiet)
1fb32894 153 printf("Removing %s\n", qname);
a0f4afbe
JH
154 if (remove_dir_recursively(&directory,
155 rm_flags) != 0) {
1fb32894 156 warning("failed to remove '%s'", qname);
aa9c83c2
MV
157 errors++;
158 }
113f10f2 159 } else if (show_only) {
1fb32894 160 printf("Would not remove %s\n", qname);
113f10f2 161 } else {
1fb32894 162 printf("Not removing %s\n", qname);
113f10f2
SB
163 }
164 strbuf_reset(&directory);
165 } else {
d871c869
JH
166 if (pathspec && !matches)
167 continue;
1fb32894 168 qname = quote_path_relative(ent->name, -1, &buf, prefix);
113f10f2 169 if (show_only) {
1fb32894 170 printf("Would remove %s\n", qname);
113f10f2
SB
171 continue;
172 } else if (!quiet) {
1fb32894 173 printf("Removing %s\n", qname);
113f10f2 174 }
aa9c83c2 175 if (unlink(ent->name) != 0) {
1fb32894 176 warning("failed to remove '%s'", qname);
aa9c83c2
MV
177 errors++;
178 }
113f10f2
SB
179 }
180 }
d871c869 181 free(seen);
113f10f2
SB
182
183 strbuf_release(&directory);
07de4eba 184 string_list_clear(&exclude_list, 0);
aa9c83c2 185 return (errors != 0);
113f10f2 186}