[PATCH 2/2] rm: introduce advice.rmHints to shorten messages

[Mathieu Lienard--Mayor <Mathieu.Lienard--Mayor@ensimag.imag.fr>]

From: Mathieu Liénard--Mayor <Mathieu.Lienard--Mayor@ensimag.imag.fr>

Similarly to advice.*, advice.rmHints has been added
to the config variables. By default, it is set to false, in order to
keep the messages the same as before. When set to true,  advice
are no longer included in the error messages.

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=true:
	error: 'foo.txt' has changes staged in the index

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>
---
 Documentation/config.txt |    3 +++
 advice.c                 |    2 ++
 advice.h                 |    1 +
 builtin/rm.c             |   38 ++++++++++++++++++++++++++------------
 t/t3600-rm.sh            |   32 ++++++++++++++++++++++++++++++++
 5 files changed, 64 insertions(+), 12 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 5b2abd2..38ceb73 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;
@@ -200,21 +202,33 @@ static int check_local_mod(unsigned char *head, int index_only)
 
 	if (files_staged.len)
 		errs = error(_("the following files have staged content "
-			       "different from both the\nfileand the HEAD:%s\n"
-			       "(use -f to force removal)"), files_staged.buf);
+			       "different from both the\nfile and the HEAD:%s%s"
+			       ), files_staged.buf,
+			       advice_rm_hints
+			       ? "\n(use -f to force removal)"
+			       : "");
 	if (files_cached.len)
 		errs = error(_("the following files have changes staged "
-			       "in the index:%s\n(use --cached to keep the file, "
-			       "or -f to force removal)"), files_cached.buf);
+			       "in the index:%s%s"), files_cached.buf,
+			       advice_rm_hints
+			       ? "\n(use --cached to keep the file, "
+			       "or -f to force removal)"
+			       : "");
 	if (files_submodule.len)
 		errs = error(_("the following submodules (or one of its nested "
-			       "submodule) use a .git directory:%s\n"
-			       "(use 'rm -rf' if you really want to remove "
-			       "it including all of its history)"), files_submodule.buf);
+			       "submodule) use a .git directory:%s%s"),
+			       files_submodule.buf,
+			       advice_rm_hints
+			       ? "\n(use 'rm -rf' if you really want to remove "
+			       "it including all of its history)"
+			       : "");
 	if (files_local.len)
 		errs = error(_("the following files have local modifications:"
-			       "%s\n(use --cached to keep the file, or -f to "
-			       "force removal)"), files_local.buf);
+			       "%s%s"), files_local.buf,
+			       advice_rm_hints
+			       ? "\n(use --cached to keep the file, or -f to "
+			       "force removal)"
+			       : "");
 
 	return errs;
 }
diff --git a/t/t3600-rm.sh b/t/t3600-rm.sh
index e0f3166..ab10cc6 100755
--- a/t/t3600-rm.sh
+++ b/t/t3600-rm.sh
@@ -707,6 +707,19 @@ EOF
 	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:
@@ -719,6 +732,16 @@ EOF
 	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:
@@ -732,4 +755,13 @@ EOF
 	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
-- 
1.7.8