X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=docs%2FREADME.config;h=feb2a27af2bb8f3f531c9a3cfdc55a99f12ea503;hb=4f3c7874fd19d380b106a9d4bbab0403ed089359;hp=760427e1f4510907740c9c6c7fd8253883c6bf92;hpb=26e707c6facc87ec5c4bb1861ce9a31c7e4959f2;p=dak.git

diff --git a/docs/README.config b/docs/README.config
index 760427e1..feb2a27a 100644
--- a/docs/README.config
+++ b/docs/README.config
@@ -2,6 +2,15 @@
 // Example annotated configuration file for dak
 ///////////////////////////////////////////////////////////
 
+///////////////////////////////////////////////////////////
+// Common settings
+///////////////////////////////////////////////////////////
+Common
+{
+    //// ThreadCount (optional):  Maximum number of threads to use.  Defaults to 1
+    ThreadCount 1;
+};
+
 ///////////////////////////////////////////////////////////
 // Essential.  List of database details.
 ///////////////////////////////////////////////////////////
@@ -32,15 +41,6 @@ DB
     Unicode "false";
 };
 
-///////////////////////////////////////////////////////////
-// Common settings
-///////////////////////////////////////////////////////////
-Common
-{
-    //// ThreadCount (optional):  Maximum number of threads to use.  Defaults to 1
-    ThreadCount 1;
-};
-
 ///////////////////////////////////////////////////////////
 // Dinstall general settings
 ///////////////////////////////////////////////////////////
@@ -108,14 +108,15 @@ Dinstall
     //// option is set.
     // BXANotify "true";
 
-    //// FutureTimeTravelGrace (required): specifies how many seconds into the
+    //// FutureTimeTravelGrace (optional): specifies how many seconds into the
     //// future timestamps are allowed to be inside a deb before being rejected.
-    //// 28800 = 8 hours
-    FutureTimeTravelGrace 28800;
+    //// Defaults to 86400 (24 hours) if not specified.
+    FutureTimeTravelGrace 86400;
 
-    //// PastCutoffYear (required): specifies the cut-off year which is used when
+    //// PastCutoffYear (optional): specifies the cut-off year which is used when
     //// deciding whether or not to reject packages based on the file timestamp.
-    PastCutoffYear "1984";
+    //// Defaults to "1975" if not specified.
+    PastCutoffYear "1975";
 
     //// SkipTime (required): an integer value which is the number of seconds
     //// that a file must be older than (via it's last modified timestamp)
@@ -145,8 +146,8 @@ Dinstall
     // ReleaseTransitions "/srv/dak/web/transitions.yaml";
 
     //// KeyAutoFetch (optional): boolean (default: false), which if set (and
-    //// not overriden by explicit argument to check_signature()) will enable
-    //// auto key retrieval.  Requires KeyServer and SigningKeyIds variables be
+    //// not overridden by explicit argument to check_signature()) will enable
+    //// auto key retrieval.  Requires KeyServer variable be
     //// set.  NB: you should only enable this variable on production systems
     //// if you have strict control of your upload queue.
     // KeyAutoFetch "false";
@@ -186,6 +187,9 @@ Dir
     //// Log (required): Directory to store dak logs in
     Log "/srv/dak/log/";
 
+    //// Lock directory (required): Directory to store dak locks in
+    Lock "/srv/dak/lock/";
+
     //// Morgue (required): Removed files are moved there.  The morgue has various
     //// sub-directories, including (optionally) those defined by
     //// Clean-Queues::MorgueSubDir and Clean-Suites::MorgueSubDir.
@@ -196,10 +200,6 @@ Dir
     //// is mainly used for britney (the testing script).
     // UrgencyLog "/srv/dak/testing/urgencies/";
 
-    //// Holding (required): Directory to use for temporary storage during
-    //// process-upload
-    Holding "/srv/dak/queue/holding/";
-
     //// Done (required): Directory in which to store processed .changes files
     Done "/srv/dak/queue/done/";
 
@@ -210,7 +210,7 @@ Dir
     //// Queue (required): This sub-tree defines important directories for the
     //// incoming queue.  The following variables have to be set: Byhand, New
     //// NewStage, Reject, Unchecked.  An explanation of the function of
-    //// these directores can be found in README.new-incoming.
+    //// these directories can be found in README.new-incoming.
     Queue
     {  
         Byhand "/srv/dak/queue/byhand/";
@@ -229,7 +229,7 @@ Dir
 // There are three mapping types:
 //
 // (1) map <source> <dest>
-// Any target suite of '<source>' is unconditionally overriden to '<dest>'.
+// Any target suite of '<source>' is unconditionally overridden to '<dest>'.
 // (2) map-unreleased <source> <dest>
 // Any upload targeted for suite '<source>' will be mapped to '<dest>' iff it
 // contains uploads for an architecture that is not part of '<source>'.