2 * "git rm" builtin command
4 * Copyright (C) Linus Torvalds 2006
9 #include "cache-tree.h"
10 #include "tree-walk.h"
11 #include "parse-options.h"
12 #include "string-list.h"
13 #include "submodule.h"
16 static const char * const builtin_rm_usage
[] = {
17 N_("git rm [options] [--] <file>..."),
29 static int get_ours_cache_pos(const char *path
, int pos
)
33 while ((i
< active_nr
) && !strcmp(active_cache
[i
]->name
, path
)) {
34 if (ce_stage(active_cache
[i
]) == 2)
41 static void print_error_files(struct string_list
*files_list
,
43 const char *hints_msg
,
48 struct strbuf err_msg
= STRBUF_INIT
;
50 strbuf_addstr(&err_msg
, main_msg
);
51 for (i
= 0; i
< files_list
->nr
; i
++)
54 files_list
->items
[i
].string
);
56 strbuf_addstr(&err_msg
, hints_msg
);
57 *errs
= error("%s", err_msg
.buf
);
58 strbuf_release(&err_msg
);
62 static void error_removing_concrete_submodules(struct string_list
*files
, int *errs
)
64 print_error_files(files
,
65 Q_("the following submodule (or one of its nested "
67 "uses a .git directory:",
68 "the following submodules (or one of its nested "
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)"),
74 string_list_clear(files
, 0);
77 static int check_submodules_use_gitfiles(void)
81 struct string_list files
= STRING_LIST_INIT_NODUP
;
83 for (i
= 0; i
< list
.nr
; i
++) {
84 const char *name
= list
.entry
[i
].name
;
86 const struct cache_entry
*ce
;
89 pos
= cache_name_pos(name
, strlen(name
));
91 pos
= get_ours_cache_pos(name
, pos
);
95 ce
= active_cache
[pos
];
97 if (!S_ISGITLINK(ce
->ce_mode
) ||
98 (lstat(ce
->name
, &st
) < 0) ||
102 if (!submodule_uses_gitfile(name
))
103 string_list_append(&files
, name
);
106 error_removing_concrete_submodules(&files
, &errs
);
111 static int check_local_mod(unsigned char *head
, int index_only
)
114 * Items in list are already sorted in the cache order,
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?
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
;
127 no_head
= is_null_sha1(head
);
128 for (i
= 0; i
< list
.nr
; i
++) {
131 const struct cache_entry
*ce
;
132 const char *name
= list
.entry
[i
].name
;
133 unsigned char sha1
[20];
135 int local_changes
= 0;
136 int staged_changes
= 0;
138 pos
= cache_name_pos(name
, strlen(name
));
141 * Skip unmerged entries except for populated submodules
142 * that could lose history when removed.
144 pos
= get_ours_cache_pos(name
, pos
);
148 if (!S_ISGITLINK(active_cache
[pos
]->ce_mode
) ||
152 ce
= active_cache
[pos
];
154 if (lstat(ce
->name
, &st
) < 0) {
155 if (errno
!= ENOENT
&& errno
!= ENOTDIR
)
156 warning("'%s': %s", ce
->name
, strerror(errno
));
157 /* It already vanished from the working tree */
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
164 * directories unless they are submodules.
166 if (!S_ISGITLINK(ce
->ce_mode
))
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.
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.
186 * Is the index different from the file in the work tree?
187 * If it's a submodule, is its work tree modified?
189 if (ce_match_stat(ce
, &st
, 0) ||
190 (S_ISGITLINK(ce
->ce_mode
) &&
191 !ok_to_remove_submodule(ce
->name
)))
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.
201 || get_tree_entry(head
, name
, sha1
, &mode
)
202 || ce
->ce_mode
!= create_ce_mode(mode
)
203 || hashcmp(ce
->sha1
, sha1
))
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.
214 if (local_changes
&& staged_changes
) {
215 if (!index_only
|| !(ce
->ce_flags
& CE_INTENT_TO_ADD
))
216 string_list_append(&files_staged
, name
);
218 else if (!index_only
) {
220 string_list_append(&files_cached
, name
);
222 if (S_ISGITLINK(ce
->ce_mode
) &&
223 !submodule_uses_gitfile(name
))
224 string_list_append(&files_submodule
, name
);
226 string_list_append(&files_local
, name
);
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:",
236 _("\n(use -f to force removal)"),
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)"),
247 string_list_clear(&files_cached
, 0);
249 error_removing_concrete_submodules(&files_submodule
, &errs
);
251 print_error_files(&files_local
,
252 Q_("the following file has local modifications:",
253 "the following files have local modifications:",
255 _("\n(use --cached to keep the file,"
256 " or -f to force removal)"),
258 string_list_clear(&files_local
, 0);
263 static struct lock_file lock_file
;
265 static int show_only
= 0, force
= 0, index_only
= 0, recursive
= 0, quiet
= 0;
266 static int ignore_unmatch
= 0;
268 static struct option builtin_rm_options
[] = {
269 OPT__DRY_RUN(&show_only
, N_("dry run")),
270 OPT__QUIET(&quiet
, N_("do not list removed files")),
271 OPT_BOOL( 0 , "cached", &index_only
, N_("only remove from the index")),
272 OPT__FORCE(&force
, N_("override the up-to-date check")),
273 OPT_BOOL('r', NULL
, &recursive
, N_("allow recursive removal")),
274 OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch
,
275 N_("exit with a zero status even if nothing matched")),
279 int cmd_rm(int argc
, const char **argv
, const char *prefix
)
282 struct pathspec pathspec
;
286 git_config(git_default_config
, NULL
);
288 argc
= parse_options(argc
, argv
, prefix
, builtin_rm_options
,
289 builtin_rm_usage
, 0);
291 usage_with_options(builtin_rm_usage
, builtin_rm_options
);
296 newfd
= hold_locked_index(&lock_file
, 1);
298 if (read_cache() < 0)
299 die(_("index file corrupt"));
301 parse_pathspec(&pathspec
, 0,
302 PATHSPEC_PREFER_CWD
|
303 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP
,
305 refresh_index(&the_index
, REFRESH_QUIET
, &pathspec
, NULL
, NULL
);
307 seen
= xcalloc(pathspec
.nr
, 1);
309 for (i
= 0; i
< active_nr
; i
++) {
310 const struct cache_entry
*ce
= active_cache
[i
];
311 if (!match_pathspec_depth(&pathspec
, ce
->name
, ce_namelen(ce
), 0, seen
))
313 ALLOC_GROW(list
.entry
, list
.nr
+ 1, list
.alloc
);
314 list
.entry
[list
.nr
].name
= ce
->name
;
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"));
322 const char *original
;
324 for (i
= 0; i
< pathspec
.nr
; i
++) {
325 original
= pathspec
.items
[i
].original
;
327 if (!ignore_unmatch
) {
328 die(_("pathspec '%s' did not match any files"),
335 if (!recursive
&& seen
[i
] == MATCHED_RECURSIVELY
)
336 die(_("not removing '%s' recursively without -r"),
337 *original
? original
: ".");
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:
351 * Further, if HEAD commit exists, "diff-index --cached" must
352 * report no changes unless forced.
355 unsigned char sha1
[20];
356 if (get_sha1("HEAD", sha1
))
358 if (check_local_mod(sha1
, index_only
))
360 } else if (!index_only
) {
361 if (check_submodules_use_gitfiles())
366 * First remove the names from the index: we won't commit
367 * the index unless all of them succeed.
369 for (i
= 0; i
< list
.nr
; i
++) {
370 const char *path
= list
.entry
[i
].name
;
372 printf("rm '%s'\n", path
);
374 if (remove_file_from_cache(path
))
375 die(_("git rm: unable to remove %s"), path
);
382 * Then, unless we used "--cached", remove the filenames from
383 * the workspace. If we fail to remove the first one, we
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:
386 * by then we've already committed ourselves and can't fail
390 int removed
= 0, gitmodules_modified
= 0;
391 for (i
= 0; i
< list
.nr
; i
++) {
392 const char *path
= list
.entry
[i
].name
;
393 if (list
.entry
[i
].is_submodule
) {
394 if (is_empty_dir(path
)) {
397 if (!remove_path_from_gitmodules(path
))
398 gitmodules_modified
= 1;
402 struct strbuf buf
= STRBUF_INIT
;
403 strbuf_addstr(&buf
, path
);
404 if (!remove_dir_recursively(&buf
, 0)) {
406 if (!remove_path_from_gitmodules(path
))
407 gitmodules_modified
= 1;
408 strbuf_release(&buf
);
410 } else if (!file_exists(path
))
411 /* Submodule was removed by user */
412 if (!remove_path_from_gitmodules(path
))
413 gitmodules_modified
= 1;
414 strbuf_release(&buf
);
415 /* Fallthrough and let remove_path() fail. */
418 if (!remove_path(path
)) {
423 die_errno("git rm: '%s'", path
);
425 if (gitmodules_modified
)
426 stage_updated_gitmodules();
429 if (active_cache_changed
) {
430 if (write_cache(newfd
, active_cache
, active_nr
) ||
431 commit_locked_index(&lock_file
))
432 die(_("Unable to write new index file"));