aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSantiago M. Mola <santi@mola.io>2017-02-08 10:30:56 +0100
committerSantiago M. Mola <santi@mola.io>2017-02-08 10:30:56 +0100
commit84b6bd8c22c8683479881a67db03dfdeeeb299ce (patch)
tree3ef3dec5917eac540eaabbcad13ac3191b5bea38
parentf3554ac62e29fd3e06c6e1fdeda914ac19cb68fa (diff)
downloadgo-git-84b6bd8c22c8683479881a67db03dfdeeeb299ce.tar.gz
doc: improve object.Tag godoc.
-rw-r--r--plumbing/object/tag.go10
1 files changed, 7 insertions, 3 deletions
diff --git a/plumbing/object/tag.go b/plumbing/object/tag.go
index 085e3f6..549e337 100644
--- a/plumbing/object/tag.go
+++ b/plumbing/object/tag.go
@@ -18,6 +18,8 @@ import (
// contains meta-information about the tag, including the tagger, tag date and
// message.
//
+// Note that this is not used for lightweight tags.
+//
// https://git-scm.com/book/en/v2/Git-Internals-Git-References#Tags
type Tag struct {
// Hash of the tag.
@@ -26,10 +28,12 @@ type Tag struct {
Name string
// Tagger is the one who created the tag.
Tagger Signature
- // Message is an arbitrary text message
- Message string
+ // Message is an arbitrary text message.
+ Message string
+ // TargetType is the object type of the target.
TargetType plumbing.ObjectType
- Target plumbing.Hash
+ // Target is the hash of the target object.
+ Target plumbing.Hash
s storer.EncodedObjectStorer
}