documentation: improve docs for checkout_head
#3822
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| * do not change your `HEAD` and then call this method, that would leave | ||
| * you with checkout conflicts since your working directory would then | ||
| * appear to be dirty. Instead, checkout the target of the branch and | ||
| * then update `HEAD` if that was successful. |
There was a problem hiding this comment.
Should we mention git_repository_set_head() here, as that's the convenient way we offer to switch the active branch?
There was a problem hiding this comment.
Updated to mention git_repository_set_head.
`git_checkout_head` is sadly misunderstood as something that can switch branches. It cannot. Update the documentation to reflect this.
54e8df8 to
b926648
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
git_checkout_headis sadly misunderstood as something that canswitch branches. It cannot. Update the documentation to reflect this.
Fixes #2864