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

[PATCH 4/8] merge-tree: implement real merges

From
Elijah Newren via GitGitGadget <gitgitgadget@gmail.com>
Date
Dec 31, 2021, 05:04 UTC
Message-ID
<9fc71f4511b163bec53616d82e8fe5214facf060.1640927044.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1114.git.git.1640927044.gitgitgadget@gmail.com>
From: Elijah Newren <newren@gmail.com>

This adds the ability to perform real merges rather than just trivial merges (meaning handling three way content merges, recursive ancestor consolidation, renames, proper directory/file conflict handling, and so forth). However, unlike `git merge`, the working tree and index are left alone and no branch is updated.

The only output is:
  - the toplevel resulting tree printed on stdout
  - exit status of 0 (clean) or 1 (conflicts present)

This output is mean to be used by some higher level script, perhaps in a sequence of steps like this:

   NEWTREE=$(git merge-tree --real $BRANCH1 $BRANCH2)
   test $? -eq 0 || die "There were conflicts..."
   NEWCOMMIT=$(git commit-tree $NEWTREE -p $BRANCH1 $BRANCH2)
   git update-ref $BRANCH1 $NEWCOMMIT

Note that higher level scripts may also want to access the conflict/warning messages normally output during a merge, or have quick access to a list of files with conflicts. That is not available in this preliminary implementation, but subsequent commits will add that ability.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/git-merge-tree.txt | 28 +++++++----
 builtin/merge-tree.c             | 55 +++++++++++++++++++++-
 t/t4301-merge-tree-real.sh       | 81 ++++++++++++++++++++++++++++++++
 3 files changed, 153 insertions(+), 11 deletions(-)
 create mode 100755 t/t4301-merge-tree-real.sh
diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
index 58731c19422..5823938937f 100644
--- a/Documentation/git-merge-tree.txt
+++ b/Documentation/git-merge-tree.txt
@@ -3,26 +3,34 @@ git-merge-tree(1)
 
 NAME
 ----
-git-merge-tree - Show three-way merge without touching index
+git-merge-tree - Perform merge without touching index or working tree
 
 
 SYNOPSIS
 --------
 [verse]
+'git merge-tree' --real <branch1> <branch2>
 'git merge-tree' <base-tree> <branch1> <branch2>
 
 DESCRIPTION
 -----------
-Reads three tree-ish, and output trivial merge results and
-conflicting stages to the standard output.  This is similar to
-what three-way 'git read-tree -m' does, but instead of storing the
-results in the index, the command outputs the entries to the
-standard output.
+Performs a merge, but does not make any new commits and does not read
+from or write to either the working tree or index.
 
-This is meant to be used by higher level scripts to compute
-merge results outside of the index, and stuff the results back into the
-index.  For this reason, the output from the command omits
-entries that match the <branch1> tree.
+The first form will merge the two branches, doing a full recursive
+merge with rename detection.  If the merge is clean, the exit status
+will be `0`, and if the merge has conflicts, the exit status will be
+`1`.  The output will consist solely of the resulting toplevel tree
+(which may have files including conflict markers).
+
+The second form is meant for backward compatibility and will only do a
+trival merge.  It reads three tree-ish, and outputs trivial merge
+results and conflicting stages to the standard output in a semi-diff
+format.  Since this was designed for higher level scripts to consume
+and merge the results back into the index, it omits entries that match
+<branch1>.  The result of this second form is is similar to what
+three-way 'git read-tree -m' does, but instead of storing the results
+in the index, the command outputs the entries to the standard output.
 
 GIT
 ---
diff --git a/builtin/merge-tree.c b/builtin/merge-tree.c
index f04b1eaad0a..c5757bed5bb 100644
--- a/builtin/merge-tree.c
+++ b/builtin/merge-tree.c
@@ -2,6 +2,9 @@
 #include "builtin.h"
 #include "tree-walk.h"
 #include "xdiff-interface.h"
+#include "help.h"
+#include "commit-reach.h"
+#include "merge-ort.h"
 #include "object-store.h"
 #include "parse-options.h"
 #include "repository.h"
@@ -391,7 +394,57 @@ struct merge_tree_options {
 static int real_merge(struct merge_tree_options *o,
 		      const char *branch1, const char *branch2)
 {
-	die(_("real merges are not yet implemented"));
+	struct commit *parent1, *parent2;
+	struct commit_list *common;
+	struct commit_list *merge_bases = NULL;
+	struct commit_list *j;
+	struct merge_options opt;
+	struct merge_result result = { 0 };
+
+	parent1 = get_merge_parent(branch1);
+	if (!parent1)
+		help_unknown_ref(branch1, "merge",
+				 _("not something we can merge"));
+
+	parent2 = get_merge_parent(branch2);
+	if (!parent2)
+		help_unknown_ref(branch2, "merge",
+				 _("not something we can merge"));
+
+	init_merge_options(&opt, the_repository);
+	/*
+	 * TODO: Support subtree and other -X options?
+	if (use_strategies_nr == 1 &&
+	    !strcmp(use_strategies[0]->name, "subtree"))
+		opt.subtree_shift = "";
+	for (x = 0; x < xopts_nr; x++)
+		if (parse_merge_opt(&opt, xopts[x]))
+			die(_("Unknown strategy option: -X%s"), xopts[x]);
+	*/
+
+	opt.show_rename_progress = 0;
+
+	opt.branch1 = merge_remote_util(parent1)->name; /* or just branch1? */
+	opt.branch2 = merge_remote_util(parent2)->name; /* or just branch2? */
+
+	/*
+	 * Get the merge bases, in reverse order; see comment above
+	 * merge_incore_recursive in merge-ort.h
+	 */
+	common = get_merge_bases(parent1, parent2);
+	for (j = common; j; j = j->next)
+		commit_list_insert(j->item, &merge_bases);
+
+	/*
+	 * TODO: notify if merging unrelated histories?
+	if (!common)
+		fprintf(stderr, _("merging unrelated histories"));
+	 */
+
+	merge_incore_recursive(&opt, merge_bases, parent1, parent2, &result);
+	printf("%s\n", oid_to_hex(&result.tree->object.oid));
+	merge_switch_to_result(&opt, NULL, &result, 0, 0);
+	return result.clean ? 0 : 1;
 }
 
 int cmd_merge_tree(int argc, const char **argv, const char *prefix)
diff --git a/t/t4301-merge-tree-real.sh b/t/t4301-merge-tree-real.sh
new file mode 100755
index 00000000000..9fb617ccc7f
--- /dev/null
+++ b/t/t4301-merge-tree-real.sh
@@ -0,0 +1,81 @@
+#!/bin/sh
+
+test_description='git merge-tree --real'
+
+. ./test-lib.sh
+
+# This test is ort-specific
+GIT_TEST_MERGE_ALGORITHM=ort
+export GIT_TEST_MERGE_ALGORITHM
+
+test_expect_success setup '
+	test_write_lines 1 2 3 4 5 >numbers &&
+	echo hello >greeting &&
+	echo foo >whatever &&
+	git add numbers greeting whatever &&
+	git commit -m initial &&
+
+	git branch side1 &&
+	git branch side2 &&
+
+	git checkout side1 &&
+	test_write_lines 1 2 3 4 5 6 >numbers &&
+	echo hi >greeting &&
+	echo bar >whatever &&
+	git add numbers greeting whatever &&
+	git commit -m rename-and-modify &&
+
+	git checkout side2 &&
+	test_write_lines 0 1 2 3 4 5 >numbers &&
+	echo yo >greeting &&
+	git rm whatever &&
+	mkdir whatever &&
+	>whatever/empty &&
+	git add numbers greeting whatever/empty &&
+	git commit -m remove-and-rename
+'
+
+test_expect_success 'Content merge and a few conflicts' '
+	git checkout side1^0 &&
+	test_must_fail git merge side2 &&
+	cp .git/AUTO_MERGE EXPECT &&
+	E_TREE=$(cat EXPECT) &&
+
+	git reset --hard &&
+	test_must_fail git merge-tree --real side1 side2 >RESULT &&
+	R_TREE=$(cat RESULT) &&
+
+	# Due to differences of e.g. "HEAD" vs "side1", the results will not
+	# exactly match.  Dig into individual files.
+
+	# Numbers should have three-way merged cleanly
+	test_write_lines 0 1 2 3 4 5 6 >expect &&
+	git show ${R_TREE}:numbers >actual &&
+	test_cmp expect actual &&
+
+	# whatever and whatever~<branch> should have same HASHES
+	git rev-parse ${E_TREE}:whatever ${E_TREE}:whatever~HEAD >expect &&
+	git rev-parse ${R_TREE}:whatever ${R_TREE}:whatever~side1 >actual &&
+	test_cmp expect actual &&
+
+	# greeting should have a merge conflict
+	git show ${E_TREE}:greeting >tmp &&
+	cat tmp | sed -e s/HEAD/side1/ >expect &&
+	git show ${R_TREE}:greeting >actual &&
+	test_cmp expect actual
+'
+
+test_expect_success 'Barf on misspelled option' '
+	# Mis-spell with single "s" instead of double "s"
+	test_expect_code 129 git merge-tree --real --mesages FOOBAR side1 side2 2>expect &&
+
+	grep "error: unknown option.*mesages" expect
+'
+
+test_expect_success 'Barf on too many arguments' '
+	test_expect_code 129 git merge-tree --real side1 side2 side3 2>expect &&
+
+	grep "^usage: git merge-tree" expect
+'
+
+test_done
-- 
gitgitgadget
Previous: Elijah Newren via GitGitGadgetNext: Johannes Altmanninger
Message 7 of 57 in “RFC: Server side merges (no ref updating, no commit creating, no touching worktree or index)”
  1. 0/8 RFC: Server side merges (no ref updating, no commit creating, no touching worktree or index)Elijah Newren via GitGitGadget, Dec 31, 2021
  2. 1/8 merge-tree: rename merge_trees() to trivial_merge_trees()Elijah Newren via GitGitGadget, Dec 31, 2021
  3. 2/8 merge-tree: move logic for existing merge into new functionElijah Newren via GitGitGadget, Dec 31, 2021
  4. Johannes AltmanningerJan 1, 2022
  5. Elijah NewrenJan 1, 2022
  6. 3/8 merge-tree: add option parsing and initial shell for real merge functionElijah Newren via GitGitGadget, Dec 31, 2021
  7. 4/8 merge-tree: implement real mergesElijah Newren via GitGitGadget, Dec 31, 2021
  8. Johannes AltmanningerJan 1, 2022
  9. Elijah NewrenJan 1, 2022
  10. Fabian StelzerJan 3, 2022
  11. Elijah NewrenJan 3, 2022
  12. 5/8 merge-ort: split out a separate display_update_messages() functionElijah Newren via GitGitGadget, Dec 31, 2021
  13. Fabian StelzerJan 3, 2022
  14. Fabian StelzerJan 3, 2022
  15. 8/8 merge-tree: provide an easy way to access which files have conflictsElijah Newren via GitGitGadget, Dec 31, 2021
  16. 7/8 merge-tree: support saving merge messages to a separate fileElijah Newren via GitGitGadget, Dec 31, 2021
  17. Fabian StelzerJan 3, 2022
  18. Elijah NewrenJan 3, 2022
  19. Fabian StelzerJan 3, 2022
  20. Elijah NewrenJan 3, 2022
  21. Fabian StelzerJan 4, 2022
  22. Fabian StelzerJan 3, 2022
  23. Elijah NewrenJan 3, 2022
  24. 6/8 merge-ort: allow update messages to be written to different file streamElijah Newren via GitGitGadget, Dec 31, 2021
  25. Johannes AltmanningerJan 1, 2022
  26. Elijah NewrenJan 1, 2022
  27. 0/8 RFC: Server side merges (no ref updating, no commit creating, no touching worktree or index)Elijah Newren via GitGitGadget, Jan 5, 2022
  28. 1/8 merge-tree: rename merge_trees() to trivial_merge_trees()Elijah Newren via GitGitGadget, Jan 5, 2022
  29. 2/8 merge-tree: move logic for existing merge into new functionElijah Newren via GitGitGadget, Jan 5, 2022
  30. 3/8 merge-tree: add option parsing and initial shell for real merge functionElijah Newren via GitGitGadget, Jan 5, 2022
  31. 5/8 merge-ort: split out a separate display_update_messages() functionElijah Newren via GitGitGadget, Jan 5, 2022
  32. 4/8 merge-tree: implement real mergesElijah Newren via GitGitGadget, Jan 5, 2022
  33. Johannes SchindelinJan 7, 2022
  34. Elijah NewrenJan 7, 2022
  35. Johannes SchindelinJan 7, 2022
  36. Elijah NewrenJan 7, 2022
  37. Junio C HamanoJan 7, 2022
  38. Johannes SchindelinJan 11, 2022
  39. Christian CouderJan 7, 2022
  40. Elijah NewrenJan 7, 2022
  41. 6/8 merge-ort: allow update messages to be written to different file streamElijah Newren via GitGitGadget, Jan 5, 2022
  42. 7/8 merge-tree: support saving merge messages to a separate fileElijah Newren via GitGitGadget, Jan 5, 2022
  43. Johannes SchindelinJan 7, 2022
  44. Elijah NewrenJan 8, 2022
  45. 8/8 merge-tree: provide an easy way to access which files have conflictsElijah Newren via GitGitGadget, Jan 5, 2022
  46. Ramsay JonesJan 5, 2022
  47. Elijah NewrenJan 5, 2022
  48. Johannes SchindelinJan 7, 2022
  49. Elijah NewrenJan 7, 2022
  50. Johannes SchindelinFeb 22, 2022
  51. Elijah NewrenJan 8, 2022
  52. Johannes SchindelinFeb 22, 2022
  53. Junio C HamanoJan 5, 2022
  54. Elijah NewrenJan 5, 2022
  55. Christian CouderJan 7, 2022
  56. Elijah NewrenJan 7, 2022
  57. René ScharfeJan 7, 2022

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.