From b083f5a956e69715efaaf95b810b02dec687c82e Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Mon, 26 Sep 2011 22:57:31 -0400
Subject: [PATCH] Documentation.

---
 distrib/federation.properties |   22 ++++++++++++++++++----
 1 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/distrib/federation.properties b/distrib/federation.properties
index e7e17f7..c762b45 100644
--- a/distrib/federation.properties
+++ b/distrib/federation.properties
@@ -37,11 +37,25 @@
 #   The shortest frequency allowed is every 5 minutes
 #   Decimal frequency values are cast to integers
 #   Frequency values may be specified in mins, hours, or days
-#   Values that can not be parsed default to *federation.defaultFrequency*
+#   Values that can not be parsed or are unspecified default to *federation.defaultFrequency*
 #
 # folder:
-#   if blank, the folder is *git.repositoriesFolder*
+#   if unspecified, the folder is *git.repositoriesFolder*
 #   if specified, the folder is relative to *git.repositoriesFolder*
+#
+# bare:
+#   if true, each repository will be created as a *bare* repository and will not
+#   have a working directory.
+#
+#   if false, each repository will be created as a normal repository suitable
+#   for local work.
+#
+# mirror:
+#   if true, each repository HEAD is reset to *origin/master* after each pull.
+#   The repository will be flagged *isFrozen* after the initial clone.
+#
+#   if false, each repository HEAD will point to the FETCH_HEAD of the initial
+#   clone from the origin until pushed to or otherwise manipulated.
 #
 # mergeAccounts:
 #   if true, remote accounts and their permissions are merged into your 
@@ -52,7 +66,7 @@
 #   notified by email of pull failures
 #
 # include and exclude:
-#   space-separated list of repositories to include or exclude from pull
+#   Space-delimited list of repositories to include or exclude from pull
 #   may be * wildcard to include or exclude all
 #   may use fuzzy match (e.g. org.eclipse.*)
 
@@ -64,6 +78,6 @@
 #federation.example1.token = 6f3b8a24bf970f17289b234284c94f43eb42f0e4
 #federation.example1.frequency = 120 mins
 #federation.example1.folder =
-#federation.example1.bare = true
+#federation.example1.bare = true 
 #federation.example1.mirror = true 
 #federation.example1.mergeAccounts = true

--
Gitblit v1.9.1