1 #ifndef MERGE_RECURSIVE_H
2 #define MERGE_RECURSIVE_H
12 struct merge_options_internal;
13 struct merge_options {
14 struct repository *repo;
16 /* ref names used in console messages and conflict markers */
21 /* rename related options */
24 MERGE_DIRECTORY_RENAMES_NONE = 0,
25 MERGE_DIRECTORY_RENAMES_CONFLICT = 1,
26 MERGE_DIRECTORY_RENAMES_TRUE = 2
27 } detect_directory_renames;
30 int show_rename_progress;
32 /* xdiff-related options (patience, ignore whitespace, ours/theirs) */
35 MERGE_VARIANT_NORMAL = 0,
40 /* console output related options */
42 unsigned buffer_output; /* 1: output at end, 2: keep buffered */
43 struct strbuf obuf; /* output buffer; if buffer_output == 2, caller
44 * must handle and call strbuf_release */
46 /* miscellaneous control options */
47 const char *subtree_shift;
48 unsigned renormalize : 1;
50 /* internal fields used by the implementation */
51 struct merge_options_internal *priv;
54 void init_merge_options(struct merge_options *opt, struct repository *repo);
56 /* parse the option in s and update the relevant field of opt */
57 int parse_merge_opt(struct merge_options *opt, const char *s);
60 * RETURN VALUES: All the merge_* functions below return a value as follows:
62 * = 0 Merge had conflicts
63 * < 0 Merge hit an unexpected and unrecoverable problem (e.g. disk
64 * full) and aborted merge part-way through.
68 * rename-detecting three-way merge, no recursion.
71 * - See RETURN VALUES above
72 * - opt->repo->index has the new index
73 * - new index NOT written to disk
74 * - The working tree is updated with results of the merge
76 int merge_trees(struct merge_options *opt,
79 struct tree *merge_base);
82 * merge_recursive is like merge_trees() but with recursive ancestor
85 * NOTE: empirically, about a decade ago it was determined that with more
86 * than two merge bases, optimal behavior was found when the
87 * merge_bases were passed in the order of oldest commit to newest
88 * commit. Also, merge_bases will be consumed (emptied) so make a
89 * copy if you need it.
92 * - See RETURN VALUES above
93 * - *result is treated as scratch space for temporary recursive merges
94 * - opt->repo->index has the new index
95 * - new index NOT written to disk
96 * - The working tree is updated with results of the merge
98 int merge_recursive(struct merge_options *opt,
101 struct commit_list *merge_bases,
102 struct commit **result);
105 * merge_recursive_generic can operate on trees instead of commits, by
106 * wrapping the trees into virtual commits, and calling merge_recursive().
107 * It also writes out the in-memory index to disk if the merge is successful.
110 * - See RETURN VALUES above
111 * - *result is treated as scratch space for temporary recursive merges
112 * - opt->repo->index has the new index
113 * - new index also written to $GIT_INDEX_FILE on disk
114 * - The working tree is updated with results of the merge
116 int merge_recursive_generic(struct merge_options *opt,
117 const struct object_id *head,
118 const struct object_id *merge,
120 const struct object_id **merge_bases,
121 struct commit **result);