Documentation: user-manual: add information about "git help" at the beginning
[git/mjg.git] / builtin-rm.c
blobb7126e3e25d4f52ae8c4a120d524a24c11129785
1 /*
2 * "git rm" builtin command
4 * Copyright (C) Linus Torvalds 2006
5 */
6 #include "cache.h"
7 #include "builtin.h"
8 #include "dir.h"
9 #include "cache-tree.h"
10 #include "tree-walk.h"
11 #include "parse-options.h"
13 static const char * const builtin_rm_usage[] = {
14 "git rm [options] [--] <file>...",
15 NULL
18 static struct {
19 int nr, alloc;
20 const char **name;
21 } list;
23 static void add_list(const char *name)
25 if (list.nr >= list.alloc) {
26 list.alloc = alloc_nr(list.alloc);
27 list.name = xrealloc(list.name, list.alloc * sizeof(const char *));
29 list.name[list.nr++] = name;
32 static int check_local_mod(unsigned char *head, int index_only)
34 /* items in list are already sorted in the cache order,
35 * so we could do this a lot more efficiently by using
36 * tree_desc based traversal if we wanted to, but I am
37 * lazy, and who cares if removal of files is a tad
38 * slower than the theoretical maximum speed?
40 int i, no_head;
41 int errs = 0;
43 no_head = is_null_sha1(head);
44 for (i = 0; i < list.nr; i++) {
45 struct stat st;
46 int pos;
47 struct cache_entry *ce;
48 const char *name = list.name[i];
49 unsigned char sha1[20];
50 unsigned mode;
51 int local_changes = 0;
52 int staged_changes = 0;
54 pos = cache_name_pos(name, strlen(name));
55 if (pos < 0)
56 continue; /* removing unmerged entry */
57 ce = active_cache[pos];
59 if (lstat(ce->name, &st) < 0) {
60 if (errno != ENOENT)
61 fprintf(stderr, "warning: '%s': %s",
62 ce->name, strerror(errno));
63 /* It already vanished from the working tree */
64 continue;
66 else if (S_ISDIR(st.st_mode)) {
67 /* if a file was removed and it is now a
68 * directory, that is the same as ENOENT as
69 * far as git is concerned; we do not track
70 * directories.
72 continue;
74 if (ce_match_stat(ce, &st, 0))
75 local_changes = 1;
76 if (no_head
77 || get_tree_entry(head, name, sha1, &mode)
78 || ce->ce_mode != create_ce_mode(mode)
79 || hashcmp(ce->sha1, sha1))
80 staged_changes = 1;
82 if (local_changes && staged_changes &&
83 !(index_only && is_empty_blob_sha1(ce->sha1)))
84 errs = error("'%s' has staged content different "
85 "from both the file and the HEAD\n"
86 "(use -f to force removal)", name);
87 else if (!index_only) {
88 /* It's not dangerous to "git rm --cached" a
89 * file if the index matches the file or the
90 * HEAD, since it means the deleted content is
91 * still available somewhere.
93 if (staged_changes)
94 errs = error("'%s' has changes staged in the index\n"
95 "(use --cached to keep the file, "
96 "or -f to force removal)", name);
97 if (local_changes)
98 errs = error("'%s' has local modifications\n"
99 "(use --cached to keep the file, "
100 "or -f to force removal)", name);
103 return errs;
106 static struct lock_file lock_file;
108 static int show_only = 0, force = 0, index_only = 0, recursive = 0, quiet = 0;
109 static int ignore_unmatch = 0;
111 static struct option builtin_rm_options[] = {
112 OPT__DRY_RUN(&show_only),
113 OPT__QUIET(&quiet),
114 OPT_BOOLEAN( 0 , "cached", &index_only, "only remove from the index"),
115 OPT_BOOLEAN('f', "force", &force, "override the up-to-date check"),
116 OPT_BOOLEAN('r', NULL, &recursive, "allow recursive removal"),
117 OPT_BOOLEAN( 0 , "ignore-unmatch", &ignore_unmatch,
118 "exit with a zero status even if nothing matched"),
119 OPT_END(),
122 int cmd_rm(int argc, const char **argv, const char *prefix)
124 int i, newfd;
125 const char **pathspec;
126 char *seen;
128 git_config(git_default_config, NULL);
130 argc = parse_options(argc, argv, builtin_rm_options, builtin_rm_usage, 0);
131 if (!argc)
132 usage_with_options(builtin_rm_usage, builtin_rm_options);
134 if (!index_only)
135 setup_work_tree();
137 newfd = hold_locked_index(&lock_file, 1);
139 if (read_cache() < 0)
140 die("index file corrupt");
141 refresh_cache(REFRESH_QUIET);
143 pathspec = get_pathspec(prefix, argv);
144 seen = NULL;
145 for (i = 0; pathspec[i] ; i++)
146 /* nothing */;
147 seen = xcalloc(i, 1);
149 for (i = 0; i < active_nr; i++) {
150 struct cache_entry *ce = active_cache[i];
151 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), 0, seen))
152 continue;
153 add_list(ce->name);
156 if (pathspec) {
157 const char *match;
158 int seen_any = 0;
159 for (i = 0; (match = pathspec[i]) != NULL ; i++) {
160 if (!seen[i]) {
161 if (!ignore_unmatch) {
162 die("pathspec '%s' did not match any files",
163 match);
166 else {
167 seen_any = 1;
169 if (!recursive && seen[i] == MATCHED_RECURSIVELY)
170 die("not removing '%s' recursively without -r",
171 *match ? match : ".");
174 if (! seen_any)
175 exit(0);
179 * If not forced, the file, the index and the HEAD (if exists)
180 * must match; but the file can already been removed, since
181 * this sequence is a natural "novice" way:
183 * rm F; git rm F
185 * Further, if HEAD commit exists, "diff-index --cached" must
186 * report no changes unless forced.
188 if (!force) {
189 unsigned char sha1[20];
190 if (get_sha1("HEAD", sha1))
191 hashclr(sha1);
192 if (check_local_mod(sha1, index_only))
193 exit(1);
197 * First remove the names from the index: we won't commit
198 * the index unless all of them succeed.
200 for (i = 0; i < list.nr; i++) {
201 const char *path = list.name[i];
202 if (!quiet)
203 printf("rm '%s'\n", path);
205 if (remove_file_from_cache(path))
206 die("git rm: unable to remove %s", path);
209 if (show_only)
210 return 0;
213 * Then, unless we used "--cached", remove the filenames from
214 * the workspace. If we fail to remove the first one, we
215 * abort the "git rm" (but once we've successfully removed
216 * any file at all, we'll go ahead and commit to it all:
217 * by then we've already committed ourselves and can't fail
218 * in the middle)
220 if (!index_only) {
221 int removed = 0;
222 for (i = 0; i < list.nr; i++) {
223 const char *path = list.name[i];
224 if (!remove_path(path)) {
225 removed = 1;
226 continue;
228 if (!removed)
229 die("git rm: %s: %s", path, strerror(errno));
233 if (active_cache_changed) {
234 if (write_cache(newfd, active_cache, active_nr) ||
235 commit_locked_index(&lock_file))
236 die("Unable to write new index file");
239 return 0;