diff options
| author | Santiago M. Mola <santi@mola.io> | 2017-02-07 17:26:13 +0100 |
|---|---|---|
| committer | Santiago M. Mola <santi@mola.io> | 2017-02-07 17:26:13 +0100 |
| commit | 62666856d9f4b3150671eb1f215a7072c02c0bc6 (patch) | |
| tree | 3cd937fbca4386bf3454ed217546b7c42d8bf93a /plumbing/object/commit.go | |
| parent | 1f39465975d56bbb02f5cdfb1e3e77f41c613f1d (diff) | |
| download | go-git-62666856d9f4b3150671eb1f215a7072c02c0bc6.tar.gz | |
doc: add object fields godoc
Diffstat (limited to 'plumbing/object/commit.go')
| -rw-r--r-- | plumbing/object/commit.go | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/plumbing/object/commit.go b/plumbing/object/commit.go index 9bb1d3c..7238f5c 100644 --- a/plumbing/object/commit.go +++ b/plumbing/object/commit.go @@ -22,10 +22,15 @@ type Hash plumbing.Hash // commit, a pointer to the previous commit(s), etc. // http://schacon.github.io/gitbook/1_the_git_object_model.html type Commit struct { - Hash plumbing.Hash - Author Signature + // Hash of the commit object. + Hash plumbing.Hash + // Author is the original author of the commit. + Author Signature + // Committer is the one performing the commit, might be different from + // Author. Committer Signature - Message string + // Message is the commit message, contains arbitrary text. + Message string tree plumbing.Hash parents []plumbing.Hash |