From fece56308886351073fab7e978c9ad27038a99f5 Mon Sep 17 00:00:00 2001 From: Venus Xeon-Blonde Date: Tue, 25 Mar 2025 02:28:07 -0400 Subject: [PATCH 1/2] docs(#1148): Add note regarding potentially confusing behavior of `git_checkout_head`. --- src/repo.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/repo.rs b/src/repo.rs index 464530332e..1bf7fd4608 100644 --- a/src/repo.rs +++ b/src/repo.rs @@ -2065,6 +2065,13 @@ impl Repository { /// Updates files in the index and the working tree to match the content of /// the commit pointed at by HEAD. + /// + /// Make sure you're aware of the potentially confusing semantics of this function, as described + /// by the libgit2 documentation for the underlying libgit2 function: + /// . + /// + /// Notably, this should not be used for switching branches. For that you should checkout the target of the + /// desired branch and then use [Repository::set_head] to update HEAD to point to the checked-out branch. pub fn checkout_head(&self, opts: Option<&mut CheckoutBuilder<'_>>) -> Result<(), Error> { unsafe { let mut raw_opts = mem::zeroed(); From acfd633be6772bc394f370a96faa772ade281338 Mon Sep 17 00:00:00 2001 From: Venus Xeon-Blonde Date: Tue, 25 Mar 2025 02:30:29 -0400 Subject: [PATCH 2/2] chore: cargo fmt --- src/repo.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/repo.rs b/src/repo.rs index 1bf7fd4608..9242ba12c5 100644 --- a/src/repo.rs +++ b/src/repo.rs @@ -2065,12 +2065,12 @@ impl Repository { /// Updates files in the index and the working tree to match the content of /// the commit pointed at by HEAD. - /// + /// /// Make sure you're aware of the potentially confusing semantics of this function, as described - /// by the libgit2 documentation for the underlying libgit2 function: + /// by the libgit2 documentation for the underlying libgit2 function: /// . - /// - /// Notably, this should not be used for switching branches. For that you should checkout the target of the + /// + /// Notably, this should not be used for switching branches. For that you should checkout the target of the /// desired branch and then use [Repository::set_head] to update HEAD to point to the checked-out branch. pub fn checkout_head(&self, opts: Option<&mut CheckoutBuilder<'_>>) -> Result<(), Error> { unsafe {