git-submodule - possibly use branch name to describe a module
[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[] = {
18 "git-clean [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...",
19 NULL
20};
21
22static int git_clean_config(const char *var, const char *value)
23{
24 if (!strcmp(var, "clean.requireforce"))
25 force = !git_config_bool(var, value);
1617adc7 26 return git_default_config(var, value);
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;
113f10f2
SB
34 struct strbuf directory;
35 struct dir_struct dir;
36 const char *path, *base;
37 static const char **pathspec;
1fb32894
DP
38 struct strbuf buf;
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
53 git_config(git_clean_config);
625db1b7
JH
54 if (force < 0)
55 force = 0;
56 else
57 config_set = 1;
58
113f10f2
SB
59 argc = parse_options(argc, argv, options, builtin_clean_usage, 0);
60
1fb32894 61 strbuf_init(&buf, 0);
113f10f2 62 memset(&dir, 0, sizeof(dir));
1617adc7
SB
63 if (ignored_only)
64 dir.show_ignored = 1;
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
SB
72
73 dir.show_other_directories = 1;
74
1617adc7
SB
75 if (!ignored)
76 setup_standard_excludes(&dir);
113f10f2
SB
77
78 pathspec = get_pathspec(prefix, argv);
79 read_cache();
80
81 /*
82 * Calculate common prefix for the pathspec, and
83 * use that to optimize the directory walk
84 */
85 baselen = common_prefix(pathspec);
86 path = ".";
87 base = "";
88 if (baselen)
89 path = base = xmemdupz(*pathspec, baselen);
90 read_directory(&dir, path, base, baselen, pathspec);
91 strbuf_init(&directory, 0);
92
d871c869 93 if (pathspec)
a8db80c2 94 seen = xmalloc(argc > 0 ? argc : 1);
d871c869
JH
95
96 for (i = 0; i < dir.nr; i++) {
97 struct dir_entry *ent = dir.entries[i];
98 int len, pos, matches;
113f10f2
SB
99 struct cache_entry *ce;
100 struct stat st;
113f10f2
SB
101
102 /*
103 * Remove the '/' at the end that directory
104 * walking adds for directory entries.
105 */
106 len = ent->len;
107 if (len && ent->name[len-1] == '/')
108 len--;
109 pos = cache_name_pos(ent->name, len);
110 if (0 <= pos)
111 continue; /* exact match */
112 pos = -pos - 1;
113 if (pos < active_nr) {
114 ce = active_cache[pos];
115 if (ce_namelen(ce) == len &&
116 !memcmp(ce->name, ent->name, len))
117 continue; /* Yup, this one exists unmerged */
118 }
119
d871c869
JH
120 /*
121 * we might have removed this as part of earlier
122 * recursive directory removal, so lstat() here could
123 * fail with ENOENT.
124 */
125 if (lstat(ent->name, &st))
126 continue;
127
128 if (pathspec) {
a8db80c2 129 memset(seen, 0, argc > 0 ? argc : 1);
d871c869
JH
130 matches = match_pathspec(pathspec, ent->name, ent->len,
131 baselen, seen);
132 } else {
133 matches = 0;
134 }
135
136 if (S_ISDIR(st.st_mode)) {
113f10f2 137 strbuf_addstr(&directory, ent->name);
1fb32894 138 qname = quote_path_relative(directory.buf, directory.len, &buf, prefix);
d871c869 139 if (show_only && (remove_directories || matches)) {
1fb32894 140 printf("Would remove %s\n", qname);
d871c869 141 } else if (remove_directories || matches) {
aa9c83c2 142 if (!quiet)
1fb32894 143 printf("Removing %s\n", qname);
aa9c83c2 144 if (remove_dir_recursively(&directory, 0) != 0) {
1fb32894 145 warning("failed to remove '%s'", qname);
aa9c83c2
MV
146 errors++;
147 }
113f10f2 148 } else if (show_only) {
1fb32894 149 printf("Would not remove %s\n", qname);
113f10f2 150 } else {
1fb32894 151 printf("Not removing %s\n", qname);
113f10f2
SB
152 }
153 strbuf_reset(&directory);
154 } else {
d871c869
JH
155 if (pathspec && !matches)
156 continue;
1fb32894 157 qname = quote_path_relative(ent->name, -1, &buf, prefix);
113f10f2 158 if (show_only) {
1fb32894 159 printf("Would remove %s\n", qname);
113f10f2
SB
160 continue;
161 } else if (!quiet) {
1fb32894 162 printf("Removing %s\n", qname);
113f10f2 163 }
aa9c83c2 164 if (unlink(ent->name) != 0) {
1fb32894 165 warning("failed to remove '%s'", qname);
aa9c83c2
MV
166 errors++;
167 }
113f10f2
SB
168 }
169 }
d871c869 170 free(seen);
113f10f2
SB
171
172 strbuf_release(&directory);
aa9c83c2 173 return (errors != 0);
113f10f2 174}