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/showcase/main.go | |
| parent | 0e9dea19f856e256e609c3390e000760d2b2b95a (diff) | |
| download | go-git-305f28004ecbc03ea353437cf4c76423d93fbbd8.tar.gz | |
_examples: improve documentation
Diffstat (limited to '_examples/showcase/main.go')
| -rw-r--r-- | _examples/showcase/main.go | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/_examples/showcase/main.go b/_examples/showcase/main.go index 7772d84..82c2acf 100644 --- a/_examples/showcase/main.go +++ b/_examples/showcase/main.go @@ -11,6 +11,14 @@ import ( . "srcd.works/go-git.v4/_examples" ) +// Example of an specific use case: +// - Clone a repository in a specific path +// - Get the HEAD reference +// - Using the HEAD reference, obtain the commit this reference is pointing to +// - Print the commit content +// - Using the commit, iterate all its files and print them +// - Print all the commit history with commit messages, short hash and the +// first line of the commit message func main() { CheckArgs("<url> <path>") url := os.Args[1] |