2 * "git rm" builtin command
4 * Copyright (C) Linus Torvalds 2006
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
12 #include "cache-tree.h"
13 #include "tree-walk.h"
14 #include "parse-options.h"
15 #include "string-list.h"
16 #include "submodule.h"
19 static const char * const builtin_rm_usage
[] = {
20 N_("git rm [<options>] [--] <file>..."),
32 static int get_ours_cache_pos(const char *path
, int pos
)
36 while ((i
< active_nr
) && !strcmp(active_cache
[i
]->name
, path
)) {
37 if (ce_stage(active_cache
[i
]) == 2)
44 static void print_error_files(struct string_list
*files_list
,
46 const char *hints_msg
,
51 struct strbuf err_msg
= STRBUF_INIT
;
53 strbuf_addstr(&err_msg
, main_msg
);
54 for (i
= 0; i
< files_list
->nr
; i
++)
57 files_list
->items
[i
].string
);
58 if (advice_enabled(ADVICE_RM_HINTS
))
59 strbuf_addstr(&err_msg
, hints_msg
);
60 *errs
= error("%s", err_msg
.buf
);
61 strbuf_release(&err_msg
);
65 static void submodules_absorb_gitdir_if_needed(void)
68 for (i
= 0; i
< list
.nr
; i
++) {
69 const char *name
= list
.entry
[i
].name
;
71 const struct cache_entry
*ce
;
73 pos
= cache_name_pos(name
, strlen(name
));
75 pos
= get_ours_cache_pos(name
, pos
);
79 ce
= active_cache
[pos
];
81 if (!S_ISGITLINK(ce
->ce_mode
) ||
82 !file_exists(ce
->name
) ||
86 if (!submodule_uses_gitfile(name
))
87 absorb_git_dir_into_superproject(name
,
88 ABSORB_GITDIR_RECURSE_SUBMODULES
);
92 static int check_local_mod(struct object_id
*head
, int index_only
)
95 * Items in list are already sorted in the cache order,
96 * so we could do this a lot more efficiently by using
97 * tree_desc based traversal if we wanted to, but I am
98 * lazy, and who cares if removal of files is a tad
99 * slower than the theoretical maximum speed?
103 struct string_list files_staged
= STRING_LIST_INIT_NODUP
;
104 struct string_list files_cached
= STRING_LIST_INIT_NODUP
;
105 struct string_list files_local
= STRING_LIST_INIT_NODUP
;
107 no_head
= is_null_oid(head
);
108 for (i
= 0; i
< list
.nr
; i
++) {
111 const struct cache_entry
*ce
;
112 const char *name
= list
.entry
[i
].name
;
113 struct object_id oid
;
115 int local_changes
= 0;
116 int staged_changes
= 0;
118 pos
= cache_name_pos(name
, strlen(name
));
121 * Skip unmerged entries except for populated submodules
122 * that could lose history when removed.
124 pos
= get_ours_cache_pos(name
, pos
);
128 if (!S_ISGITLINK(active_cache
[pos
]->ce_mode
) ||
132 ce
= active_cache
[pos
];
134 if (lstat(ce
->name
, &st
) < 0) {
135 if (!is_missing_file_error(errno
))
136 warning_errno(_("failed to stat '%s'"), ce
->name
);
137 /* It already vanished from the working tree */
140 else if (S_ISDIR(st
.st_mode
)) {
141 /* if a file was removed and it is now a
142 * directory, that is the same as ENOENT as
143 * far as git is concerned; we do not track
144 * directories unless they are submodules.
146 if (!S_ISGITLINK(ce
->ce_mode
))
151 * "rm" of a path that has changes need to be treated
152 * carefully not to allow losing local changes
153 * accidentally. A local change could be (1) file in
154 * work tree is different since the index; and/or (2)
155 * the user staged a content that is different from
156 * the current commit in the index.
158 * In such a case, you would need to --force the
159 * removal. However, "rm --cached" (remove only from
160 * the index) is safe if the index matches the file in
161 * the work tree or the HEAD commit, as it means that
162 * the content being removed is available elsewhere.
166 * Is the index different from the file in the work tree?
167 * If it's a submodule, is its work tree modified?
169 if (ce_match_stat(ce
, &st
, 0) ||
170 (S_ISGITLINK(ce
->ce_mode
) &&
171 bad_to_remove_submodule(ce
->name
,
172 SUBMODULE_REMOVAL_DIE_ON_ERROR
|
173 SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
)))
177 * Is the index different from the HEAD commit? By
178 * definition, before the very initial commit,
179 * anything staged in the index is treated by the same
180 * way as changed from the HEAD.
183 || get_tree_entry(the_repository
, head
, name
, &oid
, &mode
)
184 || ce
->ce_mode
!= create_ce_mode(mode
)
185 || !oideq(&ce
->oid
, &oid
))
189 * If the index does not match the file in the work
190 * tree and if it does not match the HEAD commit
191 * either, (1) "git rm" without --cached definitely
192 * will lose information; (2) "git rm --cached" will
193 * lose information unless it is about removing an
194 * "intent to add" entry.
196 if (local_changes
&& staged_changes
) {
197 if (!index_only
|| !ce_intent_to_add(ce
))
198 string_list_append(&files_staged
, name
);
200 else if (!index_only
) {
202 string_list_append(&files_cached
, name
);
204 string_list_append(&files_local
, name
);
207 print_error_files(&files_staged
,
208 Q_("the following file has staged content different "
209 "from both the\nfile and the HEAD:",
210 "the following files have staged content different"
211 " from both the\nfile and the HEAD:",
213 _("\n(use -f to force removal)"),
215 string_list_clear(&files_staged
, 0);
216 print_error_files(&files_cached
,
217 Q_("the following file has changes "
218 "staged in the index:",
219 "the following files have changes "
220 "staged in the index:", files_cached
.nr
),
221 _("\n(use --cached to keep the file,"
222 " or -f to force removal)"),
224 string_list_clear(&files_cached
, 0);
226 print_error_files(&files_local
,
227 Q_("the following file has local modifications:",
228 "the following files have local modifications:",
230 _("\n(use --cached to keep the file,"
231 " or -f to force removal)"),
233 string_list_clear(&files_local
, 0);
238 static int show_only
= 0, force
= 0, index_only
= 0, recursive
= 0, quiet
= 0;
239 static int ignore_unmatch
= 0, pathspec_file_nul
;
240 static int include_sparse
;
241 static char *pathspec_from_file
;
243 static struct option builtin_rm_options
[] = {
244 OPT__DRY_RUN(&show_only
, N_("dry run")),
245 OPT__QUIET(&quiet
, N_("do not list removed files")),
246 OPT_BOOL( 0 , "cached", &index_only
, N_("only remove from the index")),
247 OPT__FORCE(&force
, N_("override the up-to-date check"), PARSE_OPT_NOCOMPLETE
),
248 OPT_BOOL('r', NULL
, &recursive
, N_("allow recursive removal")),
249 OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch
,
250 N_("exit with a zero status even if nothing matched")),
251 OPT_BOOL(0, "sparse", &include_sparse
, N_("allow updating entries outside of the sparse-checkout cone")),
252 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file
),
253 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul
),
257 int cmd_rm(int argc
, const char **argv
, const char *prefix
)
259 struct lock_file lock_file
= LOCK_INIT
;
261 struct pathspec pathspec
;
264 git_config(git_default_config
, NULL
);
266 argc
= parse_options(argc
, argv
, prefix
, builtin_rm_options
,
267 builtin_rm_usage
, 0);
269 parse_pathspec(&pathspec
, 0,
273 if (pathspec_from_file
) {
275 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
277 parse_pathspec_file(&pathspec
, 0,
279 prefix
, pathspec_from_file
, pathspec_file_nul
);
280 } else if (pathspec_file_nul
) {
281 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
285 die(_("No pathspec was given. Which files should I remove?"));
290 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
292 if (read_cache() < 0)
293 die(_("index file corrupt"));
295 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
, &pathspec
, NULL
, NULL
);
297 seen
= xcalloc(pathspec
.nr
, 1);
299 /* TODO: audit for interaction with sparse-index. */
300 ensure_full_index(&the_index
);
301 for (i
= 0; i
< active_nr
; i
++) {
302 const struct cache_entry
*ce
= active_cache
[i
];
304 if (!include_sparse
&&
305 (ce_skip_worktree(ce
) ||
306 !path_in_sparse_checkout(ce
->name
, &the_index
)))
308 if (!ce_path_match(&the_index
, ce
, &pathspec
, seen
))
310 ALLOC_GROW(list
.entry
, list
.nr
+ 1, list
.alloc
);
311 list
.entry
[list
.nr
].name
= xstrdup(ce
->name
);
312 list
.entry
[list
.nr
].is_submodule
= S_ISGITLINK(ce
->ce_mode
);
313 if (list
.entry
[list
.nr
++].is_submodule
&&
314 !is_staging_gitmodules_ok(&the_index
))
315 die(_("please stage your changes to .gitmodules or stash them to proceed"));
319 const char *original
;
321 char *skip_worktree_seen
= NULL
;
322 struct string_list only_match_skip_worktree
= STRING_LIST_INIT_NODUP
;
324 for (i
= 0; i
< pathspec
.nr
; i
++) {
325 original
= pathspec
.items
[i
].original
;
328 else if (ignore_unmatch
)
330 else if (!include_sparse
&&
331 matches_skip_worktree(&pathspec
, i
, &skip_worktree_seen
))
332 string_list_append(&only_match_skip_worktree
, original
);
334 die(_("pathspec '%s' did not match any files"), original
);
336 if (!recursive
&& seen
[i
] == MATCHED_RECURSIVELY
)
337 die(_("not removing '%s' recursively without -r"),
338 *original
? original
: ".");
341 if (only_match_skip_worktree
.nr
) {
342 advise_on_updating_sparse_paths(&only_match_skip_worktree
);
345 free(skip_worktree_seen
);
346 string_list_clear(&only_match_skip_worktree
, 0);
351 clear_pathspec(&pathspec
);
355 submodules_absorb_gitdir_if_needed();
358 * If not forced, the file, the index and the HEAD (if exists)
359 * must match; but the file can already been removed, since
360 * this sequence is a natural "novice" way:
364 * Further, if HEAD commit exists, "diff-index --cached" must
365 * report no changes unless forced.
368 struct object_id oid
;
369 if (get_oid("HEAD", &oid
))
371 if (check_local_mod(&oid
, index_only
))
376 * First remove the names from the index: we won't commit
377 * the index unless all of them succeed.
379 for (i
= 0; i
< list
.nr
; i
++) {
380 const char *path
= list
.entry
[i
].name
;
382 printf("rm '%s'\n", path
);
384 if (remove_file_from_cache(path
))
385 die(_("git rm: unable to remove %s"), path
);
392 * Then, unless we used "--cached", remove the filenames from
393 * the workspace. If we fail to remove the first one, we
394 * abort the "git rm" (but once we've successfully removed
395 * any file at all, we'll go ahead and commit to it all:
396 * by then we've already committed ourselves and can't fail
400 int removed
= 0, gitmodules_modified
= 0;
401 struct strbuf buf
= STRBUF_INIT
;
402 int flag
= force
? REMOVE_DIR_PURGE_ORIGINAL_CWD
: 0;
403 for (i
= 0; i
< list
.nr
; i
++) {
404 const char *path
= list
.entry
[i
].name
;
405 if (list
.entry
[i
].is_submodule
) {
407 strbuf_addstr(&buf
, path
);
408 if (remove_dir_recursively(&buf
, flag
))
409 die(_("could not remove '%s'"), path
);
412 if (!remove_path_from_gitmodules(path
))
413 gitmodules_modified
= 1;
416 if (!remove_path(path
)) {
421 die_errno("git rm: '%s'", path
);
423 strbuf_release(&buf
);
424 if (gitmodules_modified
)
425 stage_updated_gitmodules(&the_index
);
428 if (write_locked_index(&the_index
, &lock_file
,
429 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
430 die(_("Unable to write new index file"));