]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/rm.c
blame: remove obsolete comment
[thirdparty/git.git] / builtin / rm.c
CommitLineData
d9b814cc
LT
1/*
2 * "git rm" builtin command
3 *
4 * Copyright (C) Linus Torvalds 2006
5 */
d9b814cc 6#include "builtin.h"
697cc8ef 7#include "lockfile.h"
d9b814cc 8#include "dir.h"
3fb3cc69 9#include "cache-tree.h"
9f95069b 10#include "tree-walk.h"
f09985c2 11#include "parse-options.h"
914dc028 12#include "string-list.h"
293ab15e 13#include "submodule.h"
29211a93 14#include "pathspec.h"
d9b814cc 15
f09985c2 16static const char * const builtin_rm_usage[] = {
9c9b4f2f 17 N_("git rm [<options>] [--] <file>..."),
f09985c2
PH
18 NULL
19};
d9b814cc
LT
20
21static struct {
22 int nr, alloc;
293ab15e
JL
23 struct {
24 const char *name;
25 char is_submodule;
26 } *entry;
d9b814cc
LT
27} list;
28
293ab15e
JL
29static int get_ours_cache_pos(const char *path, int pos)
30{
31 int i = -pos - 1;
32
33 while ((i < active_nr) && !strcmp(active_cache[i]->name, path)) {
34 if (ce_stage(active_cache[i]) == 2)
35 return i;
36 i++;
37 }
38 return -1;
39}
40
914dc028
MLM
41static void print_error_files(struct string_list *files_list,
42 const char *main_msg,
43 const char *hints_msg,
44 int *errs)
45{
46 if (files_list->nr) {
47 int i;
48 struct strbuf err_msg = STRBUF_INIT;
49
50 strbuf_addstr(&err_msg, main_msg);
51 for (i = 0; i < files_list->nr; i++)
52 strbuf_addf(&err_msg,
53 "\n %s",
54 files_list->items[i].string);
7e309446
MLM
55 if (advice_rm_hints)
56 strbuf_addstr(&err_msg, hints_msg);
914dc028
MLM
57 *errs = error("%s", err_msg.buf);
58 strbuf_release(&err_msg);
59 }
60}
61
658ff473
JH
62static void error_removing_concrete_submodules(struct string_list *files, int *errs)
63{
64 print_error_files(files,
65 Q_("the following submodule (or one of its nested "
66 "submodules)\n"
67 "uses a .git directory:",
ad5fe377 68 "the following submodules (or one of their nested "
658ff473
JH
69 "submodules)\n"
70 "use a .git directory:", files->nr),
71 _("\n(use 'rm -rf' if you really want to remove "
72 "it including all of its history)"),
73 errs);
74 string_list_clear(files, 0);
75}
76
293ab15e
JL
77static int check_submodules_use_gitfiles(void)
78{
79 int i;
80 int errs = 0;
914dc028 81 struct string_list files = STRING_LIST_INIT_NODUP;
293ab15e
JL
82
83 for (i = 0; i < list.nr; i++) {
84 const char *name = list.entry[i].name;
85 int pos;
9c5e6c80 86 const struct cache_entry *ce;
293ab15e
JL
87 struct stat st;
88
89 pos = cache_name_pos(name, strlen(name));
90 if (pos < 0) {
91 pos = get_ours_cache_pos(name, pos);
92 if (pos < 0)
93 continue;
94 }
95 ce = active_cache[pos];
96
97 if (!S_ISGITLINK(ce->ce_mode) ||
98 (lstat(ce->name, &st) < 0) ||
99 is_empty_dir(name))
100 continue;
101
102 if (!submodule_uses_gitfile(name))
914dc028 103 string_list_append(&files, name);
293ab15e 104 }
658ff473
JH
105
106 error_removing_concrete_submodules(&files, &errs);
293ab15e
JL
107
108 return errs;
109}
110
bdecd9d4 111static int check_local_mod(unsigned char *head, int index_only)
9f95069b 112{
69530cb0
JH
113 /*
114 * Items in list are already sorted in the cache order,
9f95069b
JH
115 * so we could do this a lot more efficiently by using
116 * tree_desc based traversal if we wanted to, but I am
117 * lazy, and who cares if removal of files is a tad
118 * slower than the theoretical maximum speed?
119 */
120 int i, no_head;
121 int errs = 0;
914dc028
MLM
122 struct string_list files_staged = STRING_LIST_INIT_NODUP;
123 struct string_list files_cached = STRING_LIST_INIT_NODUP;
124 struct string_list files_submodule = STRING_LIST_INIT_NODUP;
125 struct string_list files_local = STRING_LIST_INIT_NODUP;
9f95069b
JH
126
127 no_head = is_null_sha1(head);
128 for (i = 0; i < list.nr; i++) {
129 struct stat st;
130 int pos;
9c5e6c80 131 const struct cache_entry *ce;
293ab15e 132 const char *name = list.entry[i].name;
9f95069b
JH
133 unsigned char sha1[20];
134 unsigned mode;
bdecd9d4
MM
135 int local_changes = 0;
136 int staged_changes = 0;
9f95069b
JH
137
138 pos = cache_name_pos(name, strlen(name));
293ab15e
JL
139 if (pos < 0) {
140 /*
141 * Skip unmerged entries except for populated submodules
142 * that could lose history when removed.
143 */
144 pos = get_ours_cache_pos(name, pos);
145 if (pos < 0)
146 continue;
147
148 if (!S_ISGITLINK(active_cache[pos]->ce_mode) ||
149 is_empty_dir(name))
150 continue;
151 }
9f95069b
JH
152 ce = active_cache[pos];
153
154 if (lstat(ce->name, &st) < 0) {
9a6728d4 155 if (errno != ENOENT && errno != ENOTDIR)
c36d785d 156 warning("'%s': %s", ce->name, strerror(errno));
9f95069b
JH
157 /* It already vanished from the working tree */
158 continue;
159 }
160 else if (S_ISDIR(st.st_mode)) {
161 /* if a file was removed and it is now a
162 * directory, that is the same as ENOENT as
163 * far as git is concerned; we do not track
293ab15e 164 * directories unless they are submodules.
9f95069b 165 */
293ab15e
JL
166 if (!S_ISGITLINK(ce->ce_mode))
167 continue;
9f95069b 168 }
69530cb0
JH
169
170 /*
171 * "rm" of a path that has changes need to be treated
172 * carefully not to allow losing local changes
173 * accidentally. A local change could be (1) file in
174 * work tree is different since the index; and/or (2)
175 * the user staged a content that is different from
176 * the current commit in the index.
177 *
178 * In such a case, you would need to --force the
179 * removal. However, "rm --cached" (remove only from
180 * the index) is safe if the index matches the file in
181 * the work tree or the HEAD commit, as it means that
182 * the content being removed is available elsewhere.
183 */
184
185 /*
186 * Is the index different from the file in the work tree?
293ab15e 187 * If it's a submodule, is its work tree modified?
69530cb0 188 */
293ab15e
JL
189 if (ce_match_stat(ce, &st, 0) ||
190 (S_ISGITLINK(ce->ce_mode) &&
191 !ok_to_remove_submodule(ce->name)))
bdecd9d4 192 local_changes = 1;
69530cb0
JH
193
194 /*
195 * Is the index different from the HEAD commit? By
196 * definition, before the very initial commit,
197 * anything staged in the index is treated by the same
198 * way as changed from the HEAD.
199 */
e4d9516b
JK
200 if (no_head
201 || get_tree_entry(head, name, sha1, &mode)
202 || ce->ce_mode != create_ce_mode(mode)
203 || hashcmp(ce->sha1, sha1))
bdecd9d4
MM
204 staged_changes = 1;
205
69530cb0
JH
206 /*
207 * If the index does not match the file in the work
208 * tree and if it does not match the HEAD commit
209 * either, (1) "git rm" without --cached definitely
210 * will lose information; (2) "git rm --cached" will
211 * lose information unless it is about removing an
212 * "intent to add" entry.
213 */
214 if (local_changes && staged_changes) {
388b2acd 215 if (!index_only || !(ce->ce_flags & CE_INTENT_TO_ADD))
914dc028 216 string_list_append(&files_staged, name);
69530cb0 217 }
bdecd9d4 218 else if (!index_only) {
bdecd9d4 219 if (staged_changes)
914dc028 220 string_list_append(&files_cached, name);
293ab15e
JL
221 if (local_changes) {
222 if (S_ISGITLINK(ce->ce_mode) &&
914dc028
MLM
223 !submodule_uses_gitfile(name))
224 string_list_append(&files_submodule, name);
225 else
226 string_list_append(&files_local, name);
293ab15e 227 }
bdecd9d4 228 }
9f95069b 229 }
914dc028
MLM
230 print_error_files(&files_staged,
231 Q_("the following file has staged content different "
232 "from both the\nfile and the HEAD:",
233 "the following files have staged content different"
234 " from both the\nfile and the HEAD:",
235 files_staged.nr),
236 _("\n(use -f to force removal)"),
237 &errs);
238 string_list_clear(&files_staged, 0);
239 print_error_files(&files_cached,
240 Q_("the following file has changes "
241 "staged in the index:",
242 "the following files have changes "
243 "staged in the index:", files_cached.nr),
244 _("\n(use --cached to keep the file,"
245 " or -f to force removal)"),
246 &errs);
247 string_list_clear(&files_cached, 0);
658ff473
JH
248
249 error_removing_concrete_submodules(&files_submodule, &errs);
250
914dc028
MLM
251 print_error_files(&files_local,
252 Q_("the following file has local modifications:",
253 "the following files have local modifications:",
254 files_local.nr),
255 _("\n(use --cached to keep the file,"
256 " or -f to force removal)"),
257 &errs);
258 string_list_clear(&files_local, 0);
259
9f95069b
JH
260 return errs;
261}
262
021b6e45 263static struct lock_file lock_file;
d9b814cc 264
f09985c2
PH
265static int show_only = 0, force = 0, index_only = 0, recursive = 0, quiet = 0;
266static int ignore_unmatch = 0;
267
268static struct option builtin_rm_options[] = {
72bba2a6
NTND
269 OPT__DRY_RUN(&show_only, N_("dry run")),
270 OPT__QUIET(&quiet, N_("do not list removed files")),
d5d09d47 271 OPT_BOOL( 0 , "cached", &index_only, N_("only remove from the index")),
72bba2a6 272 OPT__FORCE(&force, N_("override the up-to-date check")),
d5d09d47
SB
273 OPT_BOOL('r', NULL, &recursive, N_("allow recursive removal")),
274 OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch,
72bba2a6 275 N_("exit with a zero status even if nothing matched")),
f09985c2
PH
276 OPT_END(),
277};
278
a633fca0 279int cmd_rm(int argc, const char **argv, const char *prefix)
d9b814cc 280{
03b86647 281 int i;
29211a93 282 struct pathspec pathspec;
d9b814cc
LT
283 char *seen;
284
95c16418 285 gitmodules_config();
ef90d6d4 286 git_config(git_default_config, NULL);
d9b814cc 287
37782920
SB
288 argc = parse_options(argc, argv, prefix, builtin_rm_options,
289 builtin_rm_usage, 0);
f09985c2
PH
290 if (!argc)
291 usage_with_options(builtin_rm_usage, builtin_rm_options);
d9b814cc 292
271bb087
MH
293 if (!index_only)
294 setup_work_tree();
295
03b86647 296 hold_locked_index(&lock_file, 1);
4d264672
OM
297
298 if (read_cache() < 0)
b9b537f7 299 die(_("index file corrupt"));
4d264672 300
f8bc2ac3
JK
301 parse_pathspec(&pathspec, 0,
302 PATHSPEC_PREFER_CWD |
303 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
304 prefix, argv);
9b2d6149 305 refresh_index(&the_index, REFRESH_QUIET, &pathspec, NULL, NULL);
4e1a7baa 306
29211a93 307 seen = xcalloc(pathspec.nr, 1);
d9b814cc
LT
308
309 for (i = 0; i < active_nr; i++) {
9c5e6c80 310 const struct cache_entry *ce = active_cache[i];
429bb40a 311 if (!ce_path_match(ce, &pathspec, seen))
d9b814cc 312 continue;
293ab15e 313 ALLOC_GROW(list.entry, list.nr + 1, list.alloc);
5699d17e 314 list.entry[list.nr].name = xstrdup(ce->name);
95c16418
JL
315 list.entry[list.nr].is_submodule = S_ISGITLINK(ce->ce_mode);
316 if (list.entry[list.nr++].is_submodule &&
317 !is_staging_gitmodules_ok())
318 die (_("Please, stage your changes to .gitmodules or stash them to proceed"));
d9b814cc
LT
319 }
320
29211a93
NTND
321 if (pathspec.nr) {
322 const char *original;
bb1faf0d 323 int seen_any = 0;
29211a93
NTND
324 for (i = 0; i < pathspec.nr; i++) {
325 original = pathspec.items[i].original;
bb1faf0d
SG
326 if (!seen[i]) {
327 if (!ignore_unmatch) {
b9b537f7 328 die(_("pathspec '%s' did not match any files"),
29211a93 329 original);
bb1faf0d 330 }
bb1faf0d 331 }
bb1faf0d
SG
332 else {
333 seen_any = 1;
334 }
9f95069b 335 if (!recursive && seen[i] == MATCHED_RECURSIVELY)
b9b537f7 336 die(_("not removing '%s' recursively without -r"),
29211a93 337 *original ? original : ".");
d9b814cc 338 }
bb1faf0d 339
b02f5aed 340 if (!seen_any)
bb1faf0d 341 exit(0);
d9b814cc
LT
342 }
343
9f95069b
JH
344 /*
345 * If not forced, the file, the index and the HEAD (if exists)
346 * must match; but the file can already been removed, since
347 * this sequence is a natural "novice" way:
348 *
9474eda6 349 * rm F; git rm F
9f95069b
JH
350 *
351 * Further, if HEAD commit exists, "diff-index --cached" must
352 * report no changes unless forced.
353 */
354 if (!force) {
355 unsigned char sha1[20];
356 if (get_sha1("HEAD", sha1))
357 hashclr(sha1);
bdecd9d4 358 if (check_local_mod(sha1, index_only))
9f95069b 359 exit(1);
293ab15e
JL
360 } else if (!index_only) {
361 if (check_submodules_use_gitfiles())
362 exit(1);
9f95069b
JH
363 }
364
d9b814cc
LT
365 /*
366 * First remove the names from the index: we won't commit
9f95069b 367 * the index unless all of them succeed.
d9b814cc
LT
368 */
369 for (i = 0; i < list.nr; i++) {
293ab15e 370 const char *path = list.entry[i].name;
b48caa20
SG
371 if (!quiet)
372 printf("rm '%s'\n", path);
d9b814cc
LT
373
374 if (remove_file_from_cache(path))
b9b537f7 375 die(_("git rm: unable to remove %s"), path);
d9b814cc
LT
376 }
377
7612a1ef
JH
378 if (show_only)
379 return 0;
380
d9b814cc 381 /*
646ac22b 382 * Then, unless we used "--cached", remove the filenames from
9f95069b 383 * the workspace. If we fail to remove the first one, we
d9b814cc
LT
384 * abort the "git rm" (but once we've successfully removed
385 * any file at all, we'll go ahead and commit to it all:
82e5a82f 386 * by then we've already committed ourselves and can't fail
d9b814cc
LT
387 * in the middle)
388 */
9f95069b 389 if (!index_only) {
95c16418 390 int removed = 0, gitmodules_modified = 0;
d9b814cc 391 for (i = 0; i < list.nr; i++) {
293ab15e
JL
392 const char *path = list.entry[i].name;
393 if (list.entry[i].is_submodule) {
394 if (is_empty_dir(path)) {
395 if (!rmdir(path)) {
396 removed = 1;
95c16418
JL
397 if (!remove_path_from_gitmodules(path))
398 gitmodules_modified = 1;
293ab15e
JL
399 continue;
400 }
401 } else {
402 struct strbuf buf = STRBUF_INIT;
403 strbuf_addstr(&buf, path);
404 if (!remove_dir_recursively(&buf, 0)) {
405 removed = 1;
95c16418
JL
406 if (!remove_path_from_gitmodules(path))
407 gitmodules_modified = 1;
293ab15e
JL
408 strbuf_release(&buf);
409 continue;
95c16418
JL
410 } else if (!file_exists(path))
411 /* Submodule was removed by user */
412 if (!remove_path_from_gitmodules(path))
413 gitmodules_modified = 1;
293ab15e
JL
414 strbuf_release(&buf);
415 /* Fallthrough and let remove_path() fail. */
416 }
417 }
175a4948 418 if (!remove_path(path)) {
d9b814cc
LT
419 removed = 1;
420 continue;
421 }
422 if (!removed)
d824cbba 423 die_errno("git rm: '%s'", path);
d9b814cc 424 }
95c16418
JL
425 if (gitmodules_modified)
426 stage_updated_gitmodules();
d9b814cc
LT
427 }
428
429 if (active_cache_changed) {
03b86647 430 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
b9b537f7 431 die(_("Unable to write new index file"));
d9b814cc
LT
432 }
433
434 return 0;
435}