Fix some documentation typos.
[git/peff.git] / builtin-clean.c
blobae30d4e76c3e758689464f41a63dda0605d60e9f
1 /*
2 * "git clean" builtin command
4 * Copyright (C) 2007 Shawn Bohrer
6 * Based on git-clean.sh by Pavel Roskin
7 */
9 #include "builtin.h"
10 #include "cache.h"
11 #include "dir.h"
12 #include "parse-options.h"
14 static int force = -1; /* unset */
16 static const char *const builtin_clean_usage[] = {
17 "git-clean [-d] [-f] [-n] [-q] [-x | -X] [--] <paths>...",
18 NULL
21 static int git_clean_config(const char *var, const char *value)
23 if (!strcmp(var, "clean.requireforce"))
24 force = !git_config_bool(var, value);
25 return git_default_config(var, value);
28 int cmd_clean(int argc, const char **argv, const char *prefix)
30 int i;
31 int show_only = 0, remove_directories = 0, quiet = 0, ignored = 0;
32 int ignored_only = 0, baselen = 0, config_set = 0;
33 struct strbuf directory;
34 struct dir_struct dir;
35 const char *path, *base;
36 static const char **pathspec;
37 char *seen = NULL;
38 struct option options[] = {
39 OPT__QUIET(&quiet),
40 OPT__DRY_RUN(&show_only),
41 OPT_BOOLEAN('f', NULL, &force, "force"),
42 OPT_BOOLEAN('d', NULL, &remove_directories,
43 "remove whole directories"),
44 OPT_BOOLEAN('x', NULL, &ignored, "remove ignored files, too"),
45 OPT_BOOLEAN('X', NULL, &ignored_only,
46 "remove only ignored files"),
47 OPT_END()
50 git_config(git_clean_config);
51 if (force < 0)
52 force = 0;
53 else
54 config_set = 1;
56 argc = parse_options(argc, argv, options, builtin_clean_usage, 0);
58 memset(&dir, 0, sizeof(dir));
59 if (ignored_only)
60 dir.show_ignored = 1;
62 if (ignored && ignored_only)
63 die("-x and -X cannot be used together");
65 if (!show_only && !force)
66 die("clean.requireForce%s set and -n or -f not given; "
67 "refusing to clean", config_set ? "" : " not");
69 dir.show_other_directories = 1;
71 if (!ignored)
72 setup_standard_excludes(&dir);
74 pathspec = get_pathspec(prefix, argv);
75 read_cache();
78 * Calculate common prefix for the pathspec, and
79 * use that to optimize the directory walk
81 baselen = common_prefix(pathspec);
82 path = ".";
83 base = "";
84 if (baselen)
85 path = base = xmemdupz(*pathspec, baselen);
86 read_directory(&dir, path, base, baselen, pathspec);
87 strbuf_init(&directory, 0);
89 if (pathspec)
90 seen = xmalloc(argc);
92 for (i = 0; i < dir.nr; i++) {
93 struct dir_entry *ent = dir.entries[i];
94 int len, pos, matches;
95 struct cache_entry *ce;
96 struct stat st;
99 * Remove the '/' at the end that directory
100 * walking adds for directory entries.
102 len = ent->len;
103 if (len && ent->name[len-1] == '/')
104 len--;
105 pos = cache_name_pos(ent->name, len);
106 if (0 <= pos)
107 continue; /* exact match */
108 pos = -pos - 1;
109 if (pos < active_nr) {
110 ce = active_cache[pos];
111 if (ce_namelen(ce) == len &&
112 !memcmp(ce->name, ent->name, len))
113 continue; /* Yup, this one exists unmerged */
117 * we might have removed this as part of earlier
118 * recursive directory removal, so lstat() here could
119 * fail with ENOENT.
121 if (lstat(ent->name, &st))
122 continue;
124 if (pathspec) {
125 memset(seen, 0, argc);
126 matches = match_pathspec(pathspec, ent->name, ent->len,
127 baselen, seen);
128 } else {
129 matches = 0;
132 if (S_ISDIR(st.st_mode)) {
133 strbuf_addstr(&directory, ent->name);
134 if (show_only && (remove_directories || matches)) {
135 printf("Would remove %s\n", directory.buf);
136 } else if (quiet && (remove_directories || matches)) {
137 remove_dir_recursively(&directory, 0);
138 } else if (remove_directories || matches) {
139 printf("Removing %s\n", directory.buf);
140 remove_dir_recursively(&directory, 0);
141 } else if (show_only) {
142 printf("Would not remove %s\n", directory.buf);
143 } else {
144 printf("Not removing %s\n", directory.buf);
146 strbuf_reset(&directory);
147 } else {
148 if (pathspec && !matches)
149 continue;
150 if (show_only) {
151 printf("Would remove %s\n", ent->name);
152 continue;
153 } else if (!quiet) {
154 printf("Removing %s\n", ent->name);
156 unlink(ent->name);
159 free(seen);
161 strbuf_release(&directory);
162 return 0;