aboutsummaryrefslogtreecommitdiffstats
path: root/options.go
diff options
context:
space:
mode:
authorAyman Bagabas <ayman.bagabas@gmail.com>2023-12-12 12:26:54 -0500
committerAyman Bagabas <ayman.bagabas@gmail.com>2023-12-12 13:27:51 -0500
commit1e2b0d67ae859dc3c81fc4455290287235395d09 (patch)
treec063cd037870ed8abde16fd411ea266e6ef9acc0 /options.go
parent952f1baf5e6ffc9e2e143821368944b40fa0bdbf (diff)
downloadgo-git-1e2b0d67ae859dc3c81fc4455290287235395d09.tar.gz
git: worktree checkout tag hash id (#959)
Allow checking out a worktree using a tag hash id. Fixes: https://github.com/go-git/go-git/issues/959 Supersedes: https://github.com/go-git/go-git/pull/964
Diffstat (limited to 'options.go')
-rw-r--r--options.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/options.go b/options.go
index 8902b7e..e748b91 100644
--- a/options.go
+++ b/options.go
@@ -324,9 +324,9 @@ var (
// CheckoutOptions describes how a checkout operation should be performed.
type CheckoutOptions struct {
- // Hash is the hash of the commit to be checked out. If used, HEAD will be
- // in detached mode. If Create is not used, Branch and Hash are mutually
- // exclusive.
+ // Hash is the hash of a commit or tag to be checked out. If used, HEAD
+ // will be in detached mode. If Create is not used, Branch and Hash are
+ // mutually exclusive.
Hash plumbing.Hash
// Branch to be checked out, if Branch and Hash are empty is set to `master`.
Branch plumbing.ReferenceName