Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(#1148): Add note regarding potentially confusing behavior of git_checkout_head. #1149

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(#1148): Add note regarding potentially confusing behavior of git_checkout_head. #1149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fece563
docs(#1148): Add note regarding potentially confusing behavior of `gi…
vcfxb Mar 25, 2025
acfd633
chore: cargo fmt
vcfxb Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/repo.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
/// <https://libgit2.org/docs/reference/main/checkout/git_checkout_head.html>.
///
/// 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();
Expand Down