gix_merge/commit/
function.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
use crate::blob::builtin_driver;
use crate::commit::{Error, Options};
use gix_object::FindExt;
use std::borrow::Cow;

/// Like [`tree()`](crate::tree()), but it takes only two commits, `our_commit` and `their_commit` to automatically
/// compute the merge-bases among them.
/// If there are multiple merge bases, these will be auto-merged into one, recursively, if
/// [`allow_missing_merge_base`](Options::allow_missing_merge_base) is `true`.
///
/// `labels` are names where [`current`](crate::blob::builtin_driver::text::Labels::current) is a name for `our_commit`
/// and [`other`](crate::blob::builtin_driver::text::Labels::other) is a name for `their_commit`.
/// If [`ancestor`](crate::blob::builtin_driver::text::Labels::ancestor) is unset, it will be set by us based on the
/// merge-bases of `our_commit` and `their_commit`.
///
/// The `graph` is used to find the merge-base between `our_commit` and `their_commit`, and can also act as cache
/// to speed up subsequent merge-base queries.
///
/// Use `abbreviate_hash(id)` to shorten the given `id` according to standard git shortening rules. It's used in case
/// the ancestor-label isn't explicitly set so that the merge base label becomes the shortened `id`.
/// Note that it's a dyn closure only to make it possible to recursively call this function in case of multiple merge-bases.
///
/// `write_object` is used only if it's allowed to merge multiple merge-bases into one, and if there
/// are multiple merge bases, and to write merged buffers as blobs.
///
/// ### Performance
///
/// Note that `objects` *should* have an object cache to greatly accelerate tree-retrieval.
///
/// ### Notes
///
/// When merging merge-bases recursively, the options are adjusted automatically to act like Git, i.e. merge binary
/// blobs and resolve with *ours*, while resorting to using the base/ancestor in case of unresolvable conflicts.
///
/// ### Deviation
///
/// * It's known that certain conflicts around symbolic links can be auto-resolved. We don't have an option for this
///   at all, yet, primarily as Git seems to not implement the *ours*/*theirs* choice in other places even though it
///   reasonably could. So we leave it to the caller to continue processing the returned tree at will.
#[allow(clippy::too_many_arguments)]
pub fn commit<'objects>(
    our_commit: gix_hash::ObjectId,
    their_commit: gix_hash::ObjectId,
    labels: builtin_driver::text::Labels<'_>,
    graph: &mut gix_revwalk::Graph<'_, '_, gix_revwalk::graph::Commit<gix_revision::merge_base::Flags>>,
    diff_resource_cache: &mut gix_diff::blob::Platform,
    blob_merge: &mut crate::blob::Platform,
    objects: &'objects (impl gix_object::FindObjectOrHeader + gix_object::Write),
    abbreviate_hash: &mut dyn FnMut(&gix_hash::oid) -> String,
    options: Options,
) -> Result<super::Outcome<'objects>, Error> {
    let merge_bases = gix_revision::merge_base(our_commit, &[their_commit], graph)?;
    let mut virtual_merge_bases = Vec::new();
    let mut state = gix_diff::tree::State::default();
    let mut commit_to_tree =
        |commit_id: gix_hash::ObjectId| objects.find_commit(&commit_id, &mut state.buf1).map(|c| c.tree());

    let (merge_base_tree_id, ancestor_name): (_, Cow<'_, str>) = match merge_bases.clone() {
        Some(base_commit) if base_commit.len() == 1 => {
            (commit_to_tree(base_commit[0])?, abbreviate_hash(&base_commit[0]).into())
        }
        Some(mut base_commits) => {
            let virtual_base_tree = if options.use_first_merge_base {
                let first = base_commits.first().expect("if Some() there is at least one.");
                commit_to_tree(*first)?
            } else {
                let first = base_commits.pop().expect("at least two");
                let second = base_commits.pop().expect("at least one left");
                let out = crate::commit::virtual_merge_base(
                    first,
                    second,
                    base_commits,
                    graph,
                    diff_resource_cache,
                    blob_merge,
                    objects,
                    abbreviate_hash,
                    options.tree_merge.clone(),
                )?;
                virtual_merge_bases = out.virtual_merge_bases;
                out.tree_id
            };
            (virtual_base_tree, "merged common ancestors".into())
        }
        None => {
            if options.allow_missing_merge_base {
                (gix_hash::ObjectId::empty_tree(our_commit.kind()), "empty tree".into())
            } else {
                return Err(Error::NoMergeBase {
                    our_commit_id: our_commit,
                    their_commit_id: their_commit,
                });
            }
        }
    };

    let mut labels = labels; // TODO(borrowchk): this re-assignment shouldn't be needed.
    if labels.ancestor.is_none() {
        labels.ancestor = Some(ancestor_name.as_ref().into());
    }

    let our_tree_id = objects.find_commit(&our_commit, &mut state.buf1)?.tree();
    let their_tree_id = objects.find_commit(&their_commit, &mut state.buf1)?.tree();

    let outcome = crate::tree(
        &merge_base_tree_id,
        &our_tree_id,
        &their_tree_id,
        labels,
        objects,
        |buf| objects.write_buf(gix_object::Kind::Blob, buf),
        &mut state,
        diff_resource_cache,
        blob_merge,
        options.tree_merge,
    )?;

    Ok(super::Outcome {
        tree_merge: outcome,
        merge_bases,
        merge_base_tree_id,
        virtual_merge_bases,
    })
}