git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v8 11/11] cherry-pick/revert: add scissors line on merge conflict

From
Denton Liu <liu.denton@gmail.com>
Date
Mar 17, 2019, 10:16 UTC
Message-ID
<5685ff80b582ab1d6daf4f2d0fcb93344b9069f5.1552817044.git.liu.denton@gmail.com>
In-Reply-To
<cover.1552817044.git.liu.denton@gmail.com>

Fix a bug where the scissors line is placed after the Conflicts: section, in the case where a merge conflict occurs and commit.cleanup = scissors.

Reviewed-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
 Documentation/git-cherry-pick.txt |  7 +++
 Documentation/git-revert.txt      |  7 +++
 builtin/merge.c                   |  9 +---
 builtin/rebase--interactive.c     |  2 +-
 builtin/revert.c                  |  5 ++
 sequencer.c                       | 22 +++++---
 sequencer.h                       |  3 +-
 t/t3507-cherry-pick-conflict.sh   | 86 +++++++++++++++++++++++++++++++
 8 files changed, 123 insertions(+), 18 deletions(-)
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index b8cfeec67e..2601e1868e 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -57,6 +57,13 @@ OPTIONS
 	With this option, 'git cherry-pick' will let you edit the commit
 	message prior to committing.
 
+--cleanup=<mode>::
+	This option determines how the commit message will be cleaned up before
+	being passed on. See linkgit:git-commit[1] for more details. In
+	particular, if the '<mode>' is given a value of `scissors`, scissors
+	will be appended to `MERGE_MSG` before being passed on to the commit
+	machinery in the case of a conflict.
+
 -x::
 	When recording the commit, append a line that says
 	"(cherry picked from commit ...)" to the original commit
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 837707a8fd..cabeb9df2c 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -66,6 +66,13 @@ more details.
 	With this option, 'git revert' will not start the commit
 	message editor.
 
+--cleanup=<mode>::
+	This option determines how the commit message will be cleaned up before
+	being passed on. See linkgit:git-commit[1] for more details. In
+	particular, if the '<mode>' is given a value of `scissors`, scissors
+	will be appended to `MERGE_MSG` before being passed on to the commit
+	machinery in the case of a conflict.
+
 -n::
 --no-commit::
 	Usually the command automatically creates some commits with
diff --git a/builtin/merge.c b/builtin/merge.c
index 86c54bff76..90c64346e9 100644
--- a/builtin/merge.c
+++ b/builtin/merge.c
@@ -923,14 +923,7 @@ static int suggest_conflicts(void)
 	 * Thus, we will get the cleanup mode which is returned when we _are_ using
 	 * an editor.
 	 */
-	if (get_cleanup_mode(cleanup_arg, 1, 1) == COMMIT_MSG_CLEANUP_SCISSORS) {
-	    fputc('\n', fp);
-	    wt_status_add_cut_line(fp);
-	    /* comments out the newline from append_conflicts_hint */
-	    fputc(comment_line_char, fp);
-	}
-
-	append_conflicts_hint(&the_index, &msgbuf);
+	append_conflicts_hint(&the_index, &msgbuf, get_cleanup_mode(cleanup_arg, 1, 1));
 	fputs(msgbuf.buf, fp);
 	strbuf_release(&msgbuf);
 	fclose(fp);
diff --git a/builtin/rebase--interactive.c b/builtin/rebase--interactive.c
index 888390f911..cf2151b271 100644
--- a/builtin/rebase--interactive.c
+++ b/builtin/rebase--interactive.c
@@ -199,10 +199,10 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 		OPT_END()
 	};
 
+	opts.action = REPLAY_INTERACTIVE_REBASE;
 	sequencer_init_config(&opts);
 	git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
 
-	opts.action = REPLAY_INTERACTIVE_REBASE;
 	opts.allow_ff = 1;
 	opts.allow_empty = 1;
 
diff --git a/builtin/revert.c b/builtin/revert.c
index a47b53ceaf..41e7392c24 100644
--- a/builtin/revert.c
+++ b/builtin/revert.c
@@ -96,11 +96,13 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
 {
 	const char * const * usage_str = revert_or_cherry_pick_usage(opts);
 	const char *me = action_name(opts);
+	const char *cleanup_arg = NULL;
 	int cmd = 0;
 	struct option base_options[] = {
 		OPT_CMDMODE(0, "quit", &cmd, N_("end revert or cherry-pick sequence"), 'q'),
 		OPT_CMDMODE(0, "continue", &cmd, N_("resume revert or cherry-pick sequence"), 'c'),
 		OPT_CMDMODE(0, "abort", &cmd, N_("cancel revert or cherry-pick sequence"), 'a'),
+		OPT_CLEANUP(&cleanup_arg),
 		OPT_BOOL('n', "no-commit", &opts->no_commit, N_("don't automatically commit")),
 		OPT_BOOL('e', "edit", &opts->edit, N_("edit the commit message")),
 		OPT_NOOP_NOARG('r', NULL),
@@ -137,6 +139,9 @@ static int run_sequencer(int argc, const char **argv, struct replay_opts *opts)
 	if (opts->keep_redundant_commits)
 		opts->allow_empty = 1;
 
+	if (cleanup_arg)
+		opts->default_msg_cleanup = get_cleanup_mode(cleanup_arg, 1, 1);
+
 	/* Check for incompatible command line arguments */
 	if (cmd) {
 		char *this_operation;
diff --git a/sequencer.c b/sequencer.c
index f782e8bab2..ea4687c3da 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -176,6 +176,11 @@ static struct cleanup_config_mapping cleanup_config_mapping[] = {
 	{ NULL, 0, 0 }
 };
 
+static inline int is_rebase_i(const struct replay_opts *opts)
+{
+	return opts->action == REPLAY_INTERACTIVE_REBASE;
+}
+
 static int git_sequencer_config(const char *k, const char *v, void *cb)
 {
 	struct replay_opts *opts = cb;
@@ -188,7 +193,7 @@ static int git_sequencer_config(const char *k, const char *v, void *cb)
 		if (status)
 			return status;
 
-		opts->default_msg_cleanup = get_cleanup_mode(s, 0, 0);
+		opts->default_msg_cleanup = get_cleanup_mode(s, !is_rebase_i(opts), 0);
 
 		free((char *)s);
 		return status;
@@ -212,11 +217,6 @@ void sequencer_init_config(struct replay_opts *opts)
 	git_config(git_sequencer_config, opts);
 }
 
-static inline int is_rebase_i(const struct replay_opts *opts)
-{
-	return opts->action == REPLAY_INTERACTIVE_REBASE;
-}
-
 static const char *get_dir(const struct replay_opts *opts)
 {
 	if (is_rebase_i(opts))
@@ -552,10 +552,16 @@ static const char *describe_cleanup_mode(enum commit_msg_cleanup_mode cleanup_mo
 }
 
 void append_conflicts_hint(struct index_state *istate,
-			   struct strbuf *msgbuf)
+		struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
 {
 	int i;
 
+	if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
+		strbuf_addch(msgbuf, '\n');
+		wt_status_append_cut_line(msgbuf);
+		strbuf_addch(msgbuf, comment_line_char);
+	}
+
 	strbuf_addch(msgbuf, '\n');
 	strbuf_commented_addf(msgbuf, "Conflicts:\n");
 	for (i = 0; i < istate->cache_nr;) {
@@ -623,7 +629,7 @@ static int do_recursive_merge(struct repository *r,
 			_(action_name(opts)));
 
 	if (!clean)
-		append_conflicts_hint(r->index, msgbuf);
+		append_conflicts_hint(r->index, msgbuf, opts->default_msg_cleanup);
 
 	return !clean;
 }
diff --git a/sequencer.h b/sequencer.h
index e7908f558e..830d8232f6 100644
--- a/sequencer.h
+++ b/sequencer.h
@@ -115,7 +115,8 @@ int rearrange_squash(struct repository *r);
  */
 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
 
-void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
+void append_conflicts_hint(struct index_state *istate,
+		struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
 	int use_editor, int die_on_error);
 
diff --git a/t/t3507-cherry-pick-conflict.sh b/t/t3507-cherry-pick-conflict.sh
index 74ff925526..c3894ca9d6 100755
--- a/t/t3507-cherry-pick-conflict.sh
+++ b/t/t3507-cherry-pick-conflict.sh
@@ -189,6 +189,46 @@ test_expect_success 'failed cherry-pick registers participants in index' '
 	test_cmp expected actual
 '
 
+test_expect_success \
+	'cherry-pick conflict, ensure commit.cleanup = scissors places scissors line properly' '
+	pristine_detach initial &&
+	git config commit.cleanup scissors &&
+	cat <<-EOF >expected &&
+		picked
+
+		# ------------------------ >8 ------------------------
+		# Do not modify or remove the line above.
+		# Everything below it will be ignored.
+		#
+		# Conflicts:
+		#	foo
+		EOF
+
+	test_must_fail git cherry-pick picked &&
+
+	test_i18ncmp expected .git/MERGE_MSG
+'
+
+test_expect_success \
+	'cherry-pick conflict, ensure cleanup=scissors places scissors line properly' '
+	pristine_detach initial &&
+	git config --unset commit.cleanup &&
+	cat <<-EOF >expected &&
+		picked
+
+		# ------------------------ >8 ------------------------
+		# Do not modify or remove the line above.
+		# Everything below it will be ignored.
+		#
+		# Conflicts:
+		#	foo
+		EOF
+
+	test_must_fail git cherry-pick --cleanup=scissors picked &&
+
+	test_i18ncmp expected .git/MERGE_MSG
+'
+
 test_expect_success 'failed cherry-pick describes conflict in work tree' '
 	pristine_detach initial &&
 	cat <<-EOF >expected &&
@@ -335,6 +375,52 @@ test_expect_success 'revert conflict, diff3 -m style' '
 	test_cmp expected actual
 '
 
+test_expect_success \
+	'revert conflict, ensure commit.cleanup = scissors places scissors line properly' '
+	pristine_detach initial &&
+	git config commit.cleanup scissors &&
+	cat >expected <<-EOF &&
+		Revert "picked"
+
+		This reverts commit OBJID.
+
+		# ------------------------ >8 ------------------------
+		# Do not modify or remove the line above.
+		# Everything below it will be ignored.
+		#
+		# Conflicts:
+		#	foo
+		EOF
+
+	test_must_fail git revert picked &&
+
+	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
+	test_i18ncmp expected actual
+'
+
+test_expect_success \
+	'revert conflict, ensure cleanup=scissors places scissors line properly' '
+	pristine_detach initial &&
+	git config --unset commit.cleanup &&
+	cat >expected <<-EOF &&
+		Revert "picked"
+
+		This reverts commit OBJID.
+
+		# ------------------------ >8 ------------------------
+		# Do not modify or remove the line above.
+		# Everything below it will be ignored.
+		#
+		# Conflicts:
+		#	foo
+		EOF
+
+	test_must_fail git revert --cleanup=scissors picked &&
+
+	sed "s/$OID_REGEX/OBJID/" .git/MERGE_MSG >actual &&
+	test_i18ncmp expected actual
+'
+
 test_expect_success 'failed cherry-pick does not forget -s' '
 	pristine_detach initial &&
 	test_must_fail git cherry-pick -s picked &&

-- 
2.21.0.512.g57bf1b23e1
Previous: Ramsay JonesNext: SZEDER Gábor
Message 69 of 105 in “Fix scissors bug during merge conflict”
  1. 0/2 Fix scissors bug during merge conflictDenton Liu, Nov 14, 2018
  2. 1/2 commit: don't add scissors line if one existsDenton Liu, Nov 14, 2018
  3. Junio C HamanoNov 14, 2018
  4. Denton LiuNov 14, 2018
  5. Junio C HamanoNov 16, 2018
  6. 2/2 merge: add scissors line on merge conflictDenton Liu, Nov 14, 2018
  7. Junio C HamanoNov 14, 2018
  8. Denton LiuNov 14, 2018
  9. 0/2 Fix scissors bug during merge conflictDenton Liu, Nov 16, 2018
  10. 2/2 merge: add scissors line on merge conflictDenton Liu, Nov 16, 2018
  11. 0/1 Fix scissors bug during merge conflictDenton Liu, Nov 17, 2018
  12. 1/1 merge: add scissors line on merge conflictDenton Liu, Nov 17, 2018
  13. SZEDER GáborNov 18, 2018
  14. Junio C HamanoNov 18, 2018
  15. 0/2 Fix scissors bug during merge conflictDenton Liu, Nov 21, 2018
  16. 1/2 t7600: clean up 'merge --squash c3 with c7' testDenton Liu, Nov 21, 2018
  17. 2/2 merge: add scissors line on merge conflictDenton Liu, Nov 21, 2018
  18. Junio C HamanoNov 21, 2018
  19. Denton LiuNov 22, 2018
  20. Junio C HamanoNov 24, 2018
  21. 0/4 Add git-merge --cleanup supportDenton Liu, Dec 25, 2018
  22. 1/4 commit: extract cleanup_mode functions to sequencerDenton Liu, Dec 25, 2018
  23. 2/4 t7600: clean up 'merge --squash c3 with c7' testDenton Liu, Dec 25, 2018
  24. 3/4 merge: cleanup messages like commitDenton Liu, Dec 25, 2018
  25. 4/4 merge: add scissors line on merge conflictDenton Liu, Dec 25, 2018
  26. 0/4 Add git-merge --cleanup supportDenton Liu, Jan 23, 2019
  27. 1/4 commit: extract cleanup_mode functions to sequencerDenton Liu, Jan 23, 2019
  28. 2/4 t7600: clean up 'merge --squash c3 with c7' testDenton Liu, Jan 23, 2019
  29. 3/4 merge: cleanup messages like commitDenton Liu, Jan 23, 2019
  30. 4/4 merge: add scissors line on merge conflictDenton Liu, Jan 23, 2019
  31. 0/8 Fix scissors bug during conflictDenton Liu, Mar 11, 2019
  32. 1/8 t7600: clean up 'merge --squash c3 with c7' testDenton Liu, Mar 11, 2019
  33. Junio C HamanoMar 12, 2019
  34. 2/8 t3507: cleanup space after redirection operatorsDenton Liu, Mar 11, 2019
  35. 3/8 commit: extract cleanup_mode functions to sequencerDenton Liu, Mar 11, 2019
  36. 4/8 sequencer.c: remove duplicate codeDenton Liu, Mar 11, 2019
  37. Phillip WoodMar 11, 2019
  38. 5/8 merge: cleanup messages like commitDenton Liu, Mar 11, 2019
  39. Eric SunshineMar 11, 2019
  40. Phillip WoodMar 11, 2019
  41. Eric SunshineMar 11, 2019
  42. Phillip WoodMar 11, 2019
  43. Junio C HamanoMar 12, 2019
  44. 6/8 merge: add scissors line on merge conflictDenton Liu, Mar 11, 2019
  45. Eric SunshineMar 11, 2019
  46. 7/8 sequencer.c: define get_config_from_cleanupDenton Liu, Mar 11, 2019
  47. Eric SunshineMar 11, 2019
  48. Junio C HamanoMar 12, 2019
  49. 8/8 cherry-pick/revert: add scissors line on merge conflictDenton Liu, Mar 11, 2019
  50. Phillip WoodMar 12, 2019
  51. Junio C HamanoMar 11, 2019
  52. 00/11 Fix scissors bug during conflictDenton Liu, Mar 17, 2019
  53. 01/11 t7600: clean up styleDenton Liu, Mar 17, 2019
  54. 02/11 t3507: cleanup space after redirection operatorsDenton Liu, Mar 17, 2019
  55. 03/11 t7604: refactor out Git commands upstream of pipeDenton Liu, Mar 17, 2019
  56. 04/11 t7502: clean up test styleDenton Liu, Mar 17, 2019
  57. 05/11 commit: extract cleanup_mode functions to sequencerDenton Liu, Mar 17, 2019
  58. 06/11 parse-options.h: extract common --cleanup optionDenton Liu, Mar 17, 2019
  59. 07/11 sequencer.c: remove duplicate codeDenton Liu, Mar 17, 2019
  60. 08/11 merge: cleanup messages like commitDenton Liu, Mar 17, 2019
  61. Phillip WoodMar 19, 2019
  62. Denton LiuMar 20, 2019
  63. 09/11 merge: add scissors line on merge conflictDenton Liu, Mar 17, 2019
  64. 10/11 sequencer.c: define describe_cleanup_modeDenton Liu, Mar 17, 2019
  65. Eric SunshineMar 18, 2019
  66. Denton LiuMar 18, 2019
  67. Eric SunshineMar 18, 2019
  68. Ramsay JonesMar 19, 2019
  69. 11/11 cherry-pick/revert: add scissors line on merge conflictDenton Liu, Mar 17, 2019
  70. SZEDER GáborMar 17, 2019
  71. Denton LiuMar 18, 2019
  72. Junio C HamanoMar 18, 2019
  73. Denton LiuMar 18, 2019
  74. Junio C HamanoMar 18, 2019
  75. 00/11 Fix scissors bug during conflictDenton Liu, Mar 21, 2019
  76. 01/11 t7600: clean up styleDenton Liu, Mar 21, 2019
  77. 02/11 t3507: clean up styleDenton Liu, Mar 21, 2019
  78. 03/11 t7604: clean up styleDenton Liu, Mar 21, 2019
  79. 04/11 t7502: clean up styleDenton Liu, Mar 21, 2019
  80. 05/11 commit: extract cleanup_mode functions to sequencerDenton Liu, Mar 21, 2019
  81. 06/11 parse-options.h: extract common --cleanup optionDenton Liu, Mar 21, 2019
  82. 07/11 sequencer.c: remove duplicate codeDenton Liu, Mar 21, 2019
  83. Phillip WoodMar 26, 2019
  84. 08/11 merge: cleanup messages like commitDenton Liu, Mar 21, 2019
  85. 09/11 merge: add scissors line on merge conflictDenton Liu, Mar 21, 2019
  86. 10/11 sequencer.c: define describe_cleanup_modeDenton Liu, Mar 21, 2019
  87. 11/11 cherry-pick/revert: add scissors line on merge conflictDenton Liu, Mar 21, 2019
  88. 00/10 Fix scissors bug during conflictPhillip Wood, Apr 17, 2019
  89. 01/10 t7600: clean up stylePhillip Wood, Apr 17, 2019
  90. 04/10 t7502: clean up stylePhillip Wood, Apr 17, 2019
  91. 03/10 t7604: clean up stylePhillip Wood, Apr 17, 2019
  92. 02/10 t3507: clean up stylePhillip Wood, Apr 17, 2019
  93. 05/10 commit: extract cleanup_mode functions to sequencerPhillip Wood, Apr 17, 2019
  94. 06/10 parse-options.h: extract common --cleanup optionPhillip Wood, Apr 17, 2019
  95. 07/10 merge: cleanup messages like commitPhillip Wood, Apr 17, 2019
  96. 08/10 merge: add scissors line on merge conflictPhillip Wood, Apr 17, 2019
  97. 09/10 sequencer.c: save and restore cleanup modePhillip Wood, Apr 17, 2019
  98. Denton LiuApr 17, 2019
  99. Phillip WoodApr 17, 2019
  100. Denton LiuApr 18, 2019
  101. 10/10 cherry-pick/revert: add scissors line on merge conflictPhillip Wood, Apr 17, 2019
  102. Junio C HamanoApr 18, 2019
  103. Phillip WoodApr 18, 2019
  104. 1/2 commit: don't add scissors line if one exists in MERGE_MSGDenton Liu, Nov 16, 2018
  105. Junio C HamanoNov 17, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.