summaryrefslogtreecommitdiffstats
path: root/merge-ort.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--merge-ort.h117
1 files changed, 117 insertions, 0 deletions
diff --git a/merge-ort.h b/merge-ort.h
new file mode 100644
index 0000000..a994c9a
--- /dev/null
+++ b/merge-ort.h
@@ -0,0 +1,117 @@
+#ifndef MERGE_ORT_H
+#define MERGE_ORT_H
+
+#include "merge-recursive.h"
+#include "hash.h"
+
+struct commit;
+struct tree;
+struct strmap;
+
+struct merge_result {
+ /*
+ * Whether the merge is clean; possible values:
+ * 1: clean
+ * 0: not clean (merge conflicts)
+ * <0: operation aborted prematurely. (object database
+ * unreadable, disk full, etc.) Worktree may be left in an
+ * inconsistent state if operation failed near the end.
+ */
+ int clean;
+
+ /*
+ * Result of merge. If !clean, represents what would go in worktree
+ * (thus possibly including files containing conflict markers).
+ */
+ struct tree *tree;
+
+ /*
+ * Special messages and conflict notices for various paths
+ *
+ * This is a map of pathnames to a string_list. It contains various
+ * warning/conflict/notice messages (possibly multiple per path)
+ * that callers may want to use.
+ */
+ struct strmap *path_messages;
+
+ /*
+ * Additional metadata used by merge_switch_to_result() or future calls
+ * to merge_incore_*(). Includes data needed to update the index (if
+ * !clean) and to print "CONFLICT" messages. Not for external use.
+ */
+ void *priv;
+ /* Also private */
+ unsigned _properly_initialized;
+};
+
+/*
+ * rename-detecting three-way merge with recursive ancestor consolidation.
+ * working tree and index are untouched.
+ *
+ * merge_bases will be consumed (emptied) so make a copy if you need it.
+ *
+ * NOTE: empirically, the recursive algorithm will perform better if you
+ * pass the merge_bases in the order of oldest commit to the
+ * newest[1][2].
+ *
+ * [1] https://lore.kernel.org/git/nycvar.QRO.7.76.6.1907252055500.21907@tvgsbejvaqbjf.bet/
+ * [2] commit 8918b0c9c2 ("merge-recur: try to merge older merge bases
+ * first", 2006-08-09)
+ */
+void merge_incore_recursive(struct merge_options *opt,
+ struct commit_list *merge_bases,
+ struct commit *side1,
+ struct commit *side2,
+ struct merge_result *result);
+
+/*
+ * rename-detecting three-way merge, no recursion.
+ * working tree and index are untouched.
+ */
+void merge_incore_nonrecursive(struct merge_options *opt,
+ struct tree *merge_base,
+ struct tree *side1,
+ struct tree *side2,
+ struct merge_result *result);
+
+/* Update the working tree and index from head to result after incore merge */
+void merge_switch_to_result(struct merge_options *opt,
+ struct tree *head,
+ struct merge_result *result,
+ int update_worktree_and_index,
+ int display_update_msgs);
+
+/*
+ * Display messages about conflicts and which files were 3-way merged.
+ * Automatically called by merge_switch_to_result() with stream == stdout,
+ * so only call this when bypassing merge_switch_to_result().
+ */
+void merge_display_update_messages(struct merge_options *opt,
+ int detailed,
+ struct merge_result *result);
+
+struct stage_info {
+ struct object_id oid;
+ int mode;
+ int stage;
+};
+
+/*
+ * Provide a list of path -> {struct stage_info*} mappings for
+ * all conflicted files. Note that each path could appear up to three
+ * times in the list, corresponding to 3 different stage entries. In short,
+ * this basically provides the info that would be printed by `ls-files -u`.
+ *
+ * result should have been populated by a call to
+ * one of the merge_incore_[non]recursive() functions.
+ *
+ * conflicted_files should be empty before calling this function.
+ */
+void merge_get_conflicted_files(struct merge_result *result,
+ struct string_list *conflicted_files);
+
+/* Do needed cleanup when not calling merge_switch_to_result() */
+void merge_finalize(struct merge_options *opt,
+ struct merge_result *result);
+
+#endif