From 305f28004ecbc03ea353437cf4c76423d93fbbd8 Mon Sep 17 00:00:00 2001 From: Antonio Jesus Navarro Perez Date: Tue, 28 Feb 2017 11:56:10 +0100 Subject: _examples: improve documentation --- _examples/log/main.go | 5 +++++ 1 file changed, 5 insertions(+) (limited to '_examples/log') 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: -- cgit