aboutsummaryrefslogtreecommitdiffstats
path: root/options.go
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2018-10-16 11:19:22 +0200
committerGitHub <noreply@github.com>2018-10-16 11:19:22 +0200
commitcd64b4d630b6c2d2b3d72e9615e14f9d58bb5787 (patch)
tree81482525dbfaaf8896f6434bdfde12ed0763b21c /options.go
parent07c03d9c05d9370502e3cc5630ec02e46a35e4bc (diff)
parent891fcfb419831c2ee5ca96c8f91bd35f0f3a3f58 (diff)
downloadgo-git-cd64b4d630b6c2d2b3d72e9615e14f9d58bb5787.tar.gz
Merge pull request #985 from mcuadros/checkout-docv4.7.1
repository: improve CheckoutOption.Hash doc
Diffstat (limited to 'options.go')
-rw-r--r--options.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/options.go b/options.go
index b8bc1e9..5d10a88 100644
--- a/options.go
+++ b/options.go
@@ -231,8 +231,9 @@ var (
// CheckoutOptions describes how a checkout 31operation should be performed.
type CheckoutOptions struct {
- // Hash to be checked out, if used HEAD will in detached mode. Branch and
- // Hash are mutually exclusive, if Create is not used.
+ // 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 plumbing.Hash
// Branch to be checked out, if Branch and Hash are empty is set to `master`.
Branch plumbing.ReferenceName