diff options
| author | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-28 11:56:10 +0100 |
|---|---|---|
| committer | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-28 11:56:10 +0100 |
| commit | 305f28004ecbc03ea353437cf4c76423d93fbbd8 (patch) | |
| tree | eb6078b1213dec261881739170c5cd1dd13be7b8 /_examples/log/main.go | |
| parent | 0e9dea19f856e256e609c3390e000760d2b2b95a (diff) | |
| download | go-git-305f28004ecbc03ea353437cf4c76423d93fbbd8.tar.gz | |
_examples: improve documentation
Diffstat (limited to '_examples/log/main.go')
| -rw-r--r-- | _examples/log/main.go | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/_examples/log/main.go b/_examples/log/main.go index eded360..da856ac 100644 --- a/_examples/log/main.go +++ b/_examples/log/main.go @@ -8,6 +8,11 @@ import ( "srcd.works/go-git.v4/storage/memory" ) +// Example of how to: +// - Clone a repository into memory +// - Get the HEAD reference +// - Using the HEAD reference, obtain the commit this reference is pointing to +// - Using the commit, obtain its history and print it func main() { // Clones the given repository, creating the remote, the local branches // and fetching the objects, everything in memory: |