Use gix-merge to merge trees when cherry-picking.

Author: Byron

crates/gitbutler-cherry-pick/src/lib.rs

@@ -40,12 +40,21 @@ impl Deref for ConflictedTreeKey {
 }
 
 pub trait RepositoryExt {
+    /// Cherry-pick, but understands GitButler conflicted states.
+    ///
+    /// This method *should* always be used in favour of native functions.
     fn cherry_pick_gitbutler(
         &self,
         head: &git2::Commit,
         to_rebase: &git2::Commit,
         merge_options: Option<&MergeOptions>,
     ) -> Result<git2::Index, anyhow::Error>;
+
+    /// Find the real tree of a commit, which is the tree of the commit if it's not in a conflicted state
+    /// or the tree according to `side` if it is conflicted.
+    ///
+    /// Unless you want to find a particular side, you likely want to pass Default::default()
+    /// as the [`side`](ConflictedTreeKey) which will give the automatically resolved resolution
     fn find_real_tree(
         &self,
         commit: &git2::Commit,
@@ -54,10 +63,6 @@ pub trait RepositoryExt {
 }
 
 impl RepositoryExt for git2::Repository {
-    /// cherry-pick, but understands GitButler conflicted states
-    ///
-    /// cherry_pick_gitbutler should always be used in favour of libgit2 or gitoxide
-    /// cherry pick functions
     fn cherry_pick_gitbutler(
         &self,
         head: &git2::Commit,
@@ -83,11 +88,6 @@ impl RepositoryExt for git2::Repository {
             .context("failed to merge trees for cherry pick")
     }
 
-    /// Find the real tree of a commit, which is the tree of the commit if it's not in a conflicted state
-    /// or the parent parent tree if it is in a conflicted state
-    ///
-    /// Unless you want to find a particular side, you likly want to pass Default::default()
-    /// as the ConfclitedTreeKey which will give the automatically resolved resolution
     fn find_real_tree(
         &self,
         commit: &git2::Commit,

crates/gitbutler-repo/src/repository_ext.rs

@@ -749,7 +749,7 @@ pub trait GixRepositoryExt: Sized {
         their_tree: gix::ObjectId,
     ) -> Result<bool>;
 
-    /// Return default lable names when merging trees.
+    /// Return default label names when merging trees.
     ///
     /// Note that these should probably rather be branch names, but that's for another day.
     fn default_merge_labels(&self) -> gix::merge::blob::builtin_driver::text::Labels<'static> {