From d32cfcc9cbde6650d5caa4f4bd10eff721e85ed0 Mon Sep 17 00:00:00 2001
From: mpl <mathieu.lonjaret@gmail.com>
Date: Sun, 9 Jun 2013 19:38:12 +0200
Subject: [PATCH] buildinfo: document GitInfo

Change-Id: I1b62fd1b56de4ae9a9448886e4b2287a8dbae456
---
 pkg/buildinfo/buildinfo.go | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/pkg/buildinfo/buildinfo.go b/pkg/buildinfo/buildinfo.go
index 2f829749c..4b8a6c6a3 100644
--- a/pkg/buildinfo/buildinfo.go
+++ b/pkg/buildinfo/buildinfo.go
@@ -1,10 +1,14 @@
 package buildinfo
 
+// GitInfo is either the empty string (the default)
+// or is set to the git hash of the most recent commit
+// using the -X linker flag. For example, it's set like:
+// $ go install --ldflags="-X camlistore.org/pkg/buildinfo.GitInfo "`./misc/gitversion` camlistore.org/server/camlistored
 var GitInfo string
 
 func Version() string {
 	if GitInfo != "" {
 		return GitInfo
 	}
-	return "unknown" // TODO: show binary's date?
+	return "unknown"
 }