diff options
author | Máximo Cuadros <mcuadros@gmail.com> | 2018-10-16 11:18:27 +0200 |
---|---|---|
committer | Máximo Cuadros <mcuadros@gmail.com> | 2018-10-16 11:18:27 +0200 |
commit | 891fcfb419831c2ee5ca96c8f91bd35f0f3a3f58 (patch) | |
tree | 5667e0b98392d4e7ce819133ed73b5f3db8e85b6 /options.go | |
parent | 345ffd95a2cd1413d7f48280e21a035febbe4e10 (diff) | |
download | go-git-891fcfb419831c2ee5ca96c8f91bd35f0f3a3f58.tar.gz |
repository: improve CheckoutOption.Hash doc
Signed-off-by: Máximo Cuadros <mcuadros@gmail.com>
Diffstat (limited to 'options.go')
-rw-r--r-- | options.go | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -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 |