Note 7.3, just for the fun

[dak.git] / docs / README.config

diff --git a/docs/README.config b/docs/README.config
index 760427e1f4510907740c9c6c7fd8253883c6bf92..0e9dbd3377d0a64b1a90906528a2e6f88255dd8e 100644 (file)
--- 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)
@@ -146,7 +147,7 @@ Dinstall
 
     //// 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
+    //// 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.