2 * "git rm" builtin command
4 * Copyright (C) Linus Torvalds 2006
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "cache-tree.h"
12 #include "tree-walk.h"
13 #include "parse-options.h"
14 #include "string-list.h"
15 #include "submodule.h"
18 static const char * const builtin_rm_usage
[] = {
19 N_("git rm [<options>] [--] <file>..."),
31 static int get_ours_cache_pos(const char *path
, int pos
)
35 while ((i
< active_nr
) && !strcmp(active_cache
[i
]->name
, path
)) {
36 if (ce_stage(active_cache
[i
]) == 2)
43 static void print_error_files(struct string_list
*files_list
,
45 const char *hints_msg
,
50 struct strbuf err_msg
= STRBUF_INIT
;
52 strbuf_addstr(&err_msg
, main_msg
);
53 for (i
= 0; i
< files_list
->nr
; i
++)
56 files_list
->items
[i
].string
);
58 strbuf_addstr(&err_msg
, hints_msg
);
59 *errs
= error("%s", err_msg
.buf
);
60 strbuf_release(&err_msg
);
64 static void submodules_absorb_gitdir_if_needed(const char *prefix
)
67 for (i
= 0; i
< list
.nr
; i
++) {
68 const char *name
= list
.entry
[i
].name
;
70 const struct cache_entry
*ce
;
72 pos
= cache_name_pos(name
, strlen(name
));
74 pos
= get_ours_cache_pos(name
, pos
);
78 ce
= active_cache
[pos
];
80 if (!S_ISGITLINK(ce
->ce_mode
) ||
81 !file_exists(ce
->name
) ||
85 if (!submodule_uses_gitfile(name
))
86 absorb_git_dir_into_superproject(prefix
, name
,
87 ABSORB_GITDIR_RECURSE_SUBMODULES
);
91 static int check_local_mod(struct object_id
*head
, int index_only
)
94 * Items in list are already sorted in the cache order,
95 * so we could do this a lot more efficiently by using
96 * tree_desc based traversal if we wanted to, but I am
97 * lazy, and who cares if removal of files is a tad
98 * slower than the theoretical maximum speed?
102 struct string_list files_staged
= STRING_LIST_INIT_NODUP
;
103 struct string_list files_cached
= STRING_LIST_INIT_NODUP
;
104 struct string_list files_local
= STRING_LIST_INIT_NODUP
;
106 no_head
= is_null_oid(head
);
107 for (i
= 0; i
< list
.nr
; i
++) {
110 const struct cache_entry
*ce
;
111 const char *name
= list
.entry
[i
].name
;
112 struct object_id oid
;
114 int local_changes
= 0;
115 int staged_changes
= 0;
117 pos
= cache_name_pos(name
, strlen(name
));
120 * Skip unmerged entries except for populated submodules
121 * that could lose history when removed.
123 pos
= get_ours_cache_pos(name
, pos
);
127 if (!S_ISGITLINK(active_cache
[pos
]->ce_mode
) ||
131 ce
= active_cache
[pos
];
133 if (lstat(ce
->name
, &st
) < 0) {
134 if (!is_missing_file_error(errno
))
135 warning_errno(_("failed to stat '%s'"), ce
->name
);
136 /* It already vanished from the working tree */
139 else if (S_ISDIR(st
.st_mode
)) {
140 /* if a file was removed and it is now a
141 * directory, that is the same as ENOENT as
142 * far as git is concerned; we do not track
143 * directories unless they are submodules.
145 if (!S_ISGITLINK(ce
->ce_mode
))
150 * "rm" of a path that has changes need to be treated
151 * carefully not to allow losing local changes
152 * accidentally. A local change could be (1) file in
153 * work tree is different since the index; and/or (2)
154 * the user staged a content that is different from
155 * the current commit in the index.
157 * In such a case, you would need to --force the
158 * removal. However, "rm --cached" (remove only from
159 * the index) is safe if the index matches the file in
160 * the work tree or the HEAD commit, as it means that
161 * the content being removed is available elsewhere.
165 * Is the index different from the file in the work tree?
166 * If it's a submodule, is its work tree modified?
168 if (ce_match_stat(ce
, &st
, 0) ||
169 (S_ISGITLINK(ce
->ce_mode
) &&
170 bad_to_remove_submodule(ce
->name
,
171 SUBMODULE_REMOVAL_DIE_ON_ERROR
|
172 SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED
)))
176 * Is the index different from the HEAD commit? By
177 * definition, before the very initial commit,
178 * anything staged in the index is treated by the same
179 * way as changed from the HEAD.
182 || get_tree_entry(head
, name
, &oid
, &mode
)
183 || ce
->ce_mode
!= create_ce_mode(mode
)
184 || !oideq(&ce
->oid
, &oid
))
188 * If the index does not match the file in the work
189 * tree and if it does not match the HEAD commit
190 * either, (1) "git rm" without --cached definitely
191 * will lose information; (2) "git rm --cached" will
192 * lose information unless it is about removing an
193 * "intent to add" entry.
195 if (local_changes
&& staged_changes
) {
196 if (!index_only
|| !ce_intent_to_add(ce
))
197 string_list_append(&files_staged
, name
);
199 else if (!index_only
) {
201 string_list_append(&files_cached
, name
);
203 string_list_append(&files_local
, name
);
206 print_error_files(&files_staged
,
207 Q_("the following file has staged content different "
208 "from both the\nfile and the HEAD:",
209 "the following files have staged content different"
210 " from both the\nfile and the HEAD:",
212 _("\n(use -f to force removal)"),
214 string_list_clear(&files_staged
, 0);
215 print_error_files(&files_cached
,
216 Q_("the following file has changes "
217 "staged in the index:",
218 "the following files have changes "
219 "staged in the index:", files_cached
.nr
),
220 _("\n(use --cached to keep the file,"
221 " or -f to force removal)"),
223 string_list_clear(&files_cached
, 0);
225 print_error_files(&files_local
,
226 Q_("the following file has local modifications:",
227 "the following files have local modifications:",
229 _("\n(use --cached to keep the file,"
230 " or -f to force removal)"),
232 string_list_clear(&files_local
, 0);
237 static int show_only
= 0, force
= 0, index_only
= 0, recursive
= 0, quiet
= 0;
238 static int ignore_unmatch
= 0;
240 static struct option builtin_rm_options
[] = {
241 OPT__DRY_RUN(&show_only
, N_("dry run")),
242 OPT__QUIET(&quiet
, N_("do not list removed files")),
243 OPT_BOOL( 0 , "cached", &index_only
, N_("only remove from the index")),
244 OPT__FORCE(&force
, N_("override the up-to-date check"), PARSE_OPT_NOCOMPLETE
),
245 OPT_BOOL('r', NULL
, &recursive
, N_("allow recursive removal")),
246 OPT_BOOL( 0 , "ignore-unmatch", &ignore_unmatch
,
247 N_("exit with a zero status even if nothing matched")),
251 int cmd_rm(int argc
, const char **argv
, const char *prefix
)
253 struct lock_file lock_file
= LOCK_INIT
;
255 struct pathspec pathspec
;
258 git_config(git_default_config
, NULL
);
260 argc
= parse_options(argc
, argv
, prefix
, builtin_rm_options
,
261 builtin_rm_usage
, 0);
263 usage_with_options(builtin_rm_usage
, builtin_rm_options
);
268 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
270 if (read_cache() < 0)
271 die(_("index file corrupt"));
273 parse_pathspec(&pathspec
, 0,
276 refresh_index(&the_index
, REFRESH_QUIET
, &pathspec
, NULL
, NULL
);
278 seen
= xcalloc(pathspec
.nr
, 1);
280 for (i
= 0; i
< active_nr
; i
++) {
281 const struct cache_entry
*ce
= active_cache
[i
];
282 if (!ce_path_match(&the_index
, ce
, &pathspec
, seen
))
284 ALLOC_GROW(list
.entry
, list
.nr
+ 1, list
.alloc
);
285 list
.entry
[list
.nr
].name
= xstrdup(ce
->name
);
286 list
.entry
[list
.nr
].is_submodule
= S_ISGITLINK(ce
->ce_mode
);
287 if (list
.entry
[list
.nr
++].is_submodule
&&
288 !is_staging_gitmodules_ok(&the_index
))
289 die(_("please stage your changes to .gitmodules or stash them to proceed"));
293 const char *original
;
295 for (i
= 0; i
< pathspec
.nr
; i
++) {
296 original
= pathspec
.items
[i
].original
;
298 if (!ignore_unmatch
) {
299 die(_("pathspec '%s' did not match any files"),
306 if (!recursive
&& seen
[i
] == MATCHED_RECURSIVELY
)
307 die(_("not removing '%s' recursively without -r"),
308 *original
? original
: ".");
316 submodules_absorb_gitdir_if_needed(prefix
);
319 * If not forced, the file, the index and the HEAD (if exists)
320 * must match; but the file can already been removed, since
321 * this sequence is a natural "novice" way:
325 * Further, if HEAD commit exists, "diff-index --cached" must
326 * report no changes unless forced.
329 struct object_id oid
;
330 if (get_oid("HEAD", &oid
))
332 if (check_local_mod(&oid
, index_only
))
337 * First remove the names from the index: we won't commit
338 * the index unless all of them succeed.
340 for (i
= 0; i
< list
.nr
; i
++) {
341 const char *path
= list
.entry
[i
].name
;
343 printf("rm '%s'\n", path
);
345 if (remove_file_from_cache(path
))
346 die(_("git rm: unable to remove %s"), path
);
353 * Then, unless we used "--cached", remove the filenames from
354 * the workspace. If we fail to remove the first one, we
355 * abort the "git rm" (but once we've successfully removed
356 * any file at all, we'll go ahead and commit to it all:
357 * by then we've already committed ourselves and can't fail
361 int removed
= 0, gitmodules_modified
= 0;
362 struct strbuf buf
= STRBUF_INIT
;
363 for (i
= 0; i
< list
.nr
; i
++) {
364 const char *path
= list
.entry
[i
].name
;
365 if (list
.entry
[i
].is_submodule
) {
367 strbuf_addstr(&buf
, path
);
368 if (remove_dir_recursively(&buf
, 0))
369 die(_("could not remove '%s'"), path
);
372 if (!remove_path_from_gitmodules(path
))
373 gitmodules_modified
= 1;
376 if (!remove_path(path
)) {
381 die_errno("git rm: '%s'", path
);
383 strbuf_release(&buf
);
384 if (gitmodules_modified
)
385 stage_updated_gitmodules(&the_index
);
388 if (write_locked_index(&the_index
, &lock_file
,
389 COMMIT_LOCK
| SKIP_IF_UNCHANGED
))
390 die(_("Unable to write new index file"));