aboutsummaryrefslogtreecommitdiffstats
path: root/_examples/log/main.go
diff options
context:
space:
mode:
Diffstat (limited to '_examples/log/main.go')
-rw-r--r--_examples/log/main.go5
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: