Clarify config

Based on feedback from Daniel Silverstone. The config keys previously
marked as "Lars doesn't understand" are now marked as ignored. Some
other stuff was clarified.

1 files changed, 13 insertions, 11 deletions

diff --git a/README b/README
index 90d6abd..c2fe8d4 100644
--- a/README
+++ b/README
@@ -28,23 +28,25 @@ shared between Trove and Lorry specs:
 * `interval` specifies how often Lorry Controller should mirror the
   repositories in the spec. See below for INTERVAL.
 * Additionally, the following seem to be supported by an old version
-  of Lorry Controller, but Lars doesn't know what they mean or if
-  they're useful anymore (FIXME: find out or scrap them): `uuid`,
-  `serial`, `create`, `destroy`, `stagger`, `tarball`.
+  of Lorry Controller, but are ignored by the new Lorry Controller:
+  `uuid`, `serial`, `create`, `destroy`, `stagger`, `tarball`.
 
 Trove specs have the following keys:
 
-* `trovehost` is the other Trove to mirror; a domain name or IP address.
+* `trovehost` is the other Trove to mirror; a domain name or IP
+  address. It is mandatory.
 * `ls-interval` determines how often should Lorry Controller query the
   other Trove for a list of repositories it may mirror. See below for
-  INTERVAL.
+  INTERVAL. `ls-interval` is mandatory.
 * `prefixmap` maps repository path prefixes from the other Trove to
-  the local Trove. If the remote prefix is `foo`, and the local prefix
-  is `bar`, then remote repository `foo/baserock/yeehaa` gets mirrored
-  to local repository `bar/baserock/yeehaa`.
+  the local Trove. It is mandatory in a Trove spec. If the remote
+  prefix is `foo`, and the local prefix is `bar`, then remote
+  repository `foo/baserock/yeehaa` gets mirrored to local repository
+  `bar/baserock/yeehaa`. If the remote Trove has a repository that
+  does not match a prefix, that repository gets ignored.
 * `ignore` is a list of git repositories from the other Trove that
   should NOT be mirrored. Each list element is a path to the git
-  repository (not including leading slash).
+  repository (not including leading slash). `ignore` is optional.
 
 An INTERVAL value (for `interval` or `ls-interval`) is number and a
 unit to indicate a time interval. Allowed units are minutes (`m`),
@@ -54,11 +56,11 @@ or lower case.
 Lorry specs have the following keys:
 
 * `prefix` is a path prefix to be prepended to all repositories
-  created from the `.lorry` files from this spec.
+  created from the `.lorry` files from this spec. It is mandatory.
 * `globs` is a list of globs (as strings) for `.lorry` files to use.
   The glob is matched in the directory containing the configuration
   file in which this spec is. It is OK for the globs to not match
-  anything.
+  anything. A `globs` entry is mandatory, however.
 
 A fairly minimal example for mirroring `git.baserock.org` and using
 local `.lorry` files.