Skip to content

Commit

Permalink
rm: better error message on failure for multiple files
Browse files Browse the repository at this point in the history 
When 'git rm' fails, it now displays a single message
with the list of files involved, instead of displaying
a list of messages with one file each.

As an example, the old message:
	error: 'foo.txt' has changes staged in the index
	(use --cached to keep the file, or -f to force removal)
	error: 'bar.txt' has changes staged in the index
	(use --cached to keep the file, or -f to force removal)

would now be displayed as:
	error: the following files have changes staged in the index:
	    foo.txt
	    bar.txt
	(use --cached to keep the file, or -f to force removal)

Signed-off-by: Mathieu Lienard--Mayor <Mathieu.Lienard--Mayor@ensimag.imag.fr>
Signed-off-by: Jorge Juan Garcia Garcia <Jorge-Juan.Garcia-Garcia@ensimag.imag.fr>
Signed-off-by: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Mathieu Lienard--Mayor authored and Junio C Hamano committed Jun 12, 2013
1 parent edca415 commit 914dc02
Show file tree
Hide file tree
Showing 2 changed files with 148 additions and 19 deletions.
100 changes: 81 additions & 19 deletions builtin/rm.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include "cache-tree.h"
#include "tree-walk.h"
#include "parse-options.h"
#include "string-list.h"
#include "submodule.h"

static const char * const builtin_rm_usage[] = {
Expand Down Expand Up @@ -36,10 +37,31 @@ static int get_ours_cache_pos(const char *path, int pos)
return -1;
}

static void print_error_files(struct string_list *files_list,
const char *main_msg,
const char *hints_msg,
int *errs)
{
if (files_list->nr) {
int i;
struct strbuf err_msg = STRBUF_INIT;

strbuf_addstr(&err_msg, main_msg);
for (i = 0; i < files_list->nr; i++)
strbuf_addf(&err_msg,
"\n %s",
files_list->items[i].string);
strbuf_addstr(&err_msg, hints_msg);
*errs = error("%s", err_msg.buf);
strbuf_release(&err_msg);
}
}

static int check_submodules_use_gitfiles(void)
{
int i;
int errs = 0;
struct string_list files = STRING_LIST_INIT_NODUP;

for (i = 0; i < list.nr; i++) {
const char *name = list.entry[i].name;
Expand All @@ -61,11 +83,18 @@ static int check_submodules_use_gitfiles(void)
continue;

if (!submodule_uses_gitfile(name))
errs = error(_("submodule '%s' (or one of its nested "
"submodules) uses a .git directory\n"
"(use 'rm -rf' if you really want to remove "
"it including all of its history)"), name);
string_list_append(&files, name);
}
print_error_files(&files,
Q_("the following submodule (or one of its nested "
"submodules)\n uses a .git directory:",
"the following submodules (or one of its nested "
"submodules)\n use a .git directory:",
files.nr),
_("\n(use 'rm -rf' if you really want to remove "
"it including all of its history)"),
&errs);
string_list_clear(&files, 0);

return errs;
}
Expand All @@ -81,6 +110,10 @@ static int check_local_mod(unsigned char *head, int index_only)
*/
int i, no_head;
int errs = 0;
struct string_list files_staged = STRING_LIST_INIT_NODUP;
struct string_list files_cached = STRING_LIST_INIT_NODUP;
struct string_list files_submodule = STRING_LIST_INIT_NODUP;
struct string_list files_local = STRING_LIST_INIT_NODUP;

no_head = is_null_sha1(head);
for (i = 0; i < list.nr; i++) {
Expand Down Expand Up @@ -171,29 +204,58 @@ static int check_local_mod(unsigned char *head, int index_only)
*/
if (local_changes && staged_changes) {
if (!index_only || !(ce->ce_flags & CE_INTENT_TO_ADD))
errs = error(_("'%s' has staged content different "
"from both the file and the HEAD\n"
"(use -f to force removal)"), name);
string_list_append(&files_staged, name);
}
else if (!index_only) {
if (staged_changes)
errs = error(_("'%s' has changes staged in the index\n"
"(use --cached to keep the file, "
"or -f to force removal)"), name);
string_list_append(&files_cached, name);
if (local_changes) {
if (S_ISGITLINK(ce->ce_mode) &&
!submodule_uses_gitfile(name)) {
errs = error(_("submodule '%s' (or one of its nested "
"submodules) uses a .git directory\n"
"(use 'rm -rf' if you really want to remove "
"it including all of its history)"), name);
} else
errs = error(_("'%s' has local modifications\n"
"(use --cached to keep the file, "
"or -f to force removal)"), name);
!submodule_uses_gitfile(name))
string_list_append(&files_submodule, name);
else
string_list_append(&files_local, name);
}
}
}
print_error_files(&files_staged,
Q_("the following file has staged content different "
"from both the\nfile and the HEAD:",
"the following files have staged content different"
" from both the\nfile and the HEAD:",
files_staged.nr),
_("\n(use -f to force removal)"),
&errs);
string_list_clear(&files_staged, 0);
print_error_files(&files_cached,
Q_("the following file has changes "
"staged in the index:",
"the following files have changes "
"staged in the index:", files_cached.nr),
_("\n(use --cached to keep the file,"
" or -f to force removal)"),
&errs);
string_list_clear(&files_cached, 0);
print_error_files(&files_submodule,
Q_("the following submodule (or one of its nested "
"submodule)\nuses a .git directory:",
"the following submodules (or one of its nested "
"submodule)\nuse a .git directory:",
files_submodule.nr),
_("\n(use 'rm -rf' if you really "
"want to remove it including all "
"of its history)"),
&errs);
string_list_clear(&files_submodule, 0);
print_error_files(&files_local,
Q_("the following file has local modifications:",
"the following files have local modifications:",
files_local.nr),
_("\n(use --cached to keep the file,"
" or -f to force removal)"),
&errs);
string_list_clear(&files_local, 0);

return errs;
}

Expand Down
67 changes: 67 additions & 0 deletions t/t3600-rm.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -687,4 +687,71 @@ test_expect_failure SYMLINKS 'rm across a symlinked leading path (w/ index)' '
test_path_is_file e/f
'

test_expect_success 'setup for testing rm messages' '
>bar.txt &&
>foo.txt &&
git add bar.txt foo.txt
'

test_expect_success 'rm files with different staged content' '
cat >expect <<-\EOF &&
error: the following files have staged content different from both the
file and the HEAD:
bar.txt
foo.txt
(use -f to force removal)
EOF
echo content1 >foo.txt &&
echo content1 >bar.txt &&
test_must_fail git rm foo.txt bar.txt 2>actual &&
test_i18ncmp expect actual
'


test_expect_success 'rm file with local modification' '
cat >expect <<-\EOF &&
error: the following file has local modifications:
foo.txt
(use --cached to keep the file, or -f to force removal)
EOF
git commit -m "testing rm 3" &&
echo content3 >foo.txt &&
test_must_fail git rm foo.txt 2>actual &&
test_i18ncmp expect actual
'


test_expect_success 'rm file with changes in the index' '
cat >expect <<-\EOF &&
error: the following file has changes staged in the index:
foo.txt
(use --cached to keep the file, or -f to force removal)
EOF
git reset --hard &&
echo content5 >foo.txt &&
git add foo.txt &&
test_must_fail git rm foo.txt 2>actual &&
test_i18ncmp expect actual
'


test_expect_success 'rm files with two different errors' '
cat >expect <<-\EOF &&
error: the following file has staged content different from both the
file and the HEAD:
foo1.txt
(use -f to force removal)
error: the following file has changes staged in the index:
bar1.txt
(use --cached to keep the file, or -f to force removal)
EOF
echo content >foo1.txt &&
git add foo1.txt &&
echo content6 >foo1.txt &&
echo content6 >bar1.txt &&
git add bar1.txt &&
test_must_fail git rm bar1.txt foo1.txt 2>actual &&
test_i18ncmp expect actual
'

test_done

0 comments on commit 914dc02

Please sign in to comment.