Update documentation in preparation of release.

1 files changed, 33 insertions, 3 deletions

diff --git a/example.conf b/example.conf
index b6654ef..117be5c 100644
--- a/example.conf
+++ b/example.conf
@@ -1,20 +1,50 @@
+# this config file tries to show a bit of everything, most real life
+# configurations really only need a "group" section with "members" and
+# "writable"
+
 [gitosis]
-repositories = repo
+## To override the default ~/repositories path
+# repositories = repositories
+
+## Allow gitweb to show all known repositories. If you want gitweb,
+## you need either this or a [repo foo] section for each repository
+## you want visible in gitweb.
 gitweb = no
+
+## Allow git-daemon to publish all known repositories. As with gitweb,
+## this can be done globally or per-repository.
+## NOT YET IMPLEMENTED.
 # daemon-ok = no
 
+## Logging level, one of DEBUG, INFO, WARNING, ERROR, CRITICAL
+loglevel = DEBUG
+
 [group quux]
 members = jdoe wsmith @anothergroup
 writable = foo bar baz/thud
 readonly = xyzzy
+
+## You can play fancy tricks by making some repositories appear with
+## different names in different contexts. Not really supported
+## everywhere (e.g. gitweb) and can be confusing -- experts only.
 map writable visiblename1 = actualname1
 map readonly visiblename2 = actualname2
 
 [repo foo]
-# description = blah blah
+## Allow gitweb to show this repository.
 gitweb = yes
+
+## Oneline description of the project, mostly for gitweb.
+## NOT YET IMPLEMENTED.
+# description = blah blah
+## Owner of this repository. Used in gitweb list of projects.
 owner = John Doe
+
+## Allow git-daemon to publish this repository.
+## NOT YET IMPLEMENTED.
 # daemon-ok = no
 
-# [gitweb]
+[gitweb]
+## Where to make gitweb link to as it's "home location".
+## NOT YET IMPLEMENTED.
 # homelink = http://example.com/