Introduce advice.rmHints to choose whether to display advice or not
when git rm fails. Defaults to true, in order to preserve current
behavior.
As an example, the message:
error: 'foo.txt' has changes staged in the index
(use --cached to keep the file, or -f to force removal)
would look like, with advice.rmHints=false:
error: 'foo.txt' has changes staged in the index
Signed-off-by: Mathieu Lienard--Mayor
<Mathieu.Lienard--Mayor@xxxxxxxxxxxxxxx>
Signed-off-by: Jorge Juan Garcia Garcia
<Jorge-Juan.Garcia-Garcia@xxxxxxxxxxxxxxx>
Signed-off-by: Matthieu Moy <Matthieu.Moy@xxxxxxxxxxxxxxx>
---
Documentation/config.txt | 3 ++
advice.c | 2 +
advice.h | 1 +
builtin/rm.c | 36 ++++++++++++---------
t/t3600-rm.sh | 77
++++++++++++++++++++++++++++++++++++++++++++++
5 files changed, 104 insertions(+), 15 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 6e53fc5..eb04479 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -199,6 +199,9 @@ advice.*::
amWorkDir::
Advice that shows the location of the patch file when
linkgit:git-am[1] fails to apply it.
+ rmHints::
+ In case of failure in the output of linkgit:git-rm[1],
+ show directions on how to proceed from the current state.
--
core.fileMode::
diff --git a/advice.c b/advice.c
index a8deee6..a4c169c 100644
--- a/advice.c
+++ b/advice.c
@@ -14,6 +14,7 @@ int advice_resolve_conflict = 1;
int advice_implicit_identity = 1;
int advice_detached_head = 1;
int advice_set_upstream_failure = 1;
+int advice_rm_hints = 1;
static struct {
const char *name;
@@ -33,6 +34,7 @@ static struct {
{ "implicitidentity", &advice_implicit_identity },
{ "detachedhead", &advice_detached_head },
{ "setupstreamfailure", &advice_set_upstream_failure },
+ { "rmhints", &advice_rm_hints },
/* make this an alias for backward compatibility */
{ "pushnonfastforward", &advice_push_update_rejected }
diff --git a/advice.h b/advice.h
index 94caa32..36104c4 100644
--- a/advice.h
+++ b/advice.h
@@ -17,6 +17,7 @@ extern int advice_resolve_conflict;
extern int advice_implicit_identity;
extern int advice_detached_head;
extern int advice_set_upstream_failure;
+extern int advice_rm_hints;
int git_default_advice_config(const char *var, const char *value);
void advise(const char *advice, ...);
diff --git a/builtin/rm.c b/builtin/rm.c
index 1bff656..c9081cd 100644
--- a/builtin/rm.c
+++ b/builtin/rm.c
@@ -62,9 +62,11 @@ static int check_submodules_use_gitfiles(void)
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);
+ "submodules) uses a .git directory%s"), name,
+ advice_rm_hints
+ ? "\n(use 'rm -rf' if you really want to remove "
+ "it including all of its history)"
+ : "");
}
return errs;
@@ -204,8 +206,9 @@ static int check_local_mod(unsigned char *head,
int index_only)
"\n %s",
files_staged.items[j].string);
}
- strbuf_addstr(&msg_staged,
- "\n(use -f to force removal)");
+ if (advice_rm_hints)
+ strbuf_addstr(&msg_staged,
+ "\n(use -f to force removal)");
errs = error(_("%s"), msg_staged.buf);
}
if (files_cached.nr) {
@@ -220,9 +223,10 @@ static int check_local_mod(unsigned char *head,
int index_only)
"\n %s",
files_cached.items[j].string);
}
- strbuf_addstr(&msg_cached,
- "\n(use --cached to keep the file, "
- "or -f to force removal)");
+ if (advice_rm_hints)
+ strbuf_addstr(&msg_cached,
+ "\n(use --cached to keep the file, "
+ "or -f to force removal)");
errs = error(_("%s"), msg_cached.buf);
}
if (files_submodule.nr) {
@@ -237,10 +241,11 @@ static int check_local_mod(unsigned char *head,
int index_only)
"\n %s",
files_submodule.items[j].string);
}
- strbuf_addstr(&msg_sub,
- "\n(use 'rm -rf' if you really want "
- "to remove i including all "
- "of its history)");
+ if (advice_rm_hints)
+ strbuf_addstr(&msg_sub,
+ "\n(use 'rm -rf' if you really want "
+ "to remove i including all "
+ "of its history)");
errs = error(_("%s"), msg_sub.buf);
}
if (files_local.nr) {
@@ -253,9 +258,10 @@ static int check_local_mod(unsigned char *head,
int index_only)
"\n %s",
files_local.items[j].string);
}
- strbuf_addstr(&msg_local,
- "\n(use --cached to keep the file, "
- "or -f to force removal)");
+ if (advice_rm_hints)
+ strbuf_addstr(&msg_local,
+ "\n(use --cached to keep the file, "
+ "or -f to force removal)");
errs = error(_("%s"), msg_local.buf);
}
diff --git a/t/t3600-rm.sh b/t/t3600-rm.sh
index 0c44e9f..ab10cc6 100755
--- a/t/t3600-rm.sh
+++ b/t/t3600-rm.sh
@@ -687,4 +687,81 @@ 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_cmp expect actual
+'
+
+test_expect_success 'rm files with different staged content without
hints' '
+ cat >expect << EOF &&
+error: the following files have staged content different from both
the
+file and the HEAD:
+ bar.txt
+ foo.txt
+EOF
+ echo content2 >foo.txt &&
+ echo content2 >bar.txt &&
+ test_must_fail git -c advice.rmhints=false rm foo.txt bar.txt
2>actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'rm file with local modification' '
+ cat >expect << EOF &&
+error: the following files have 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_cmp expect actual
+'
+
+test_expect_success 'rm file with local modification without hints'
'
+ cat >expect << EOF &&
+error: the following files have local modifications:
+ bar.txt
+EOF
+ echo content4 >bar.txt &&
+ test_must_fail git -c advice.rmhints=false rm bar.txt 2>actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'rm file with changes in the index' '
+ cat >expect << EOF &&
+error: the following files have 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_cmp expect actual
+'
+
+test_expect_success 'rm file with changes in the index without
hints' '
+ cat >expect << EOF &&
+error: the following files have changes staged in the index:
+ foo.txt
+EOF
+ test_must_fail git -c advice.rmhints=false rm foo.txt 2>actual &&
+ test_cmp expect actual
+'
+
test_done