* vars: external-overrides variable added* cron.daily: Update testing/unstable Task...

[dak.git] / docs / README.config

diff --git a/docs/README.config b/docs/README.config
index 92772185bbaae5c6ec06796c149648a17595fbdc..80a1010d0ec9cff5202a663f8ba773cfe77d01e1 100644 (file)
--- a/docs/README.config
+++ b/docs/README.config
@@ -25,15 +25,28 @@ Mandatory.  List of directory locations, e.g.
 
 | Dir
 | {
 
 | Dir
 | {

-|   RootDir "/org/ftp.debian.org/ftp/";
-|   PoolDir "/org/ftp.debian.org/ftp/pool/";
-|   TemplatesDir "/org/ftp.debian.org/katie/templates/";
+|   Root "/org/ftp.debian.org/ftp/";
+|   Pool "/org/ftp.debian.org/ftp/pool/";
+|   Templates "/org/ftp.debian.org/katie/templates/";

 |   PoolRoot "pool/";
 |   PoolRoot "pool/";

-|   IncomingDir "/org/ftp.debian.org/incoming/";
-|   OverrideDir "/org/ftp.debian.org/scripts/override/";
-|   ListsDir "/org/ftp.debian.org/database/dists/";
-|   LogDir "/org/ftp.debian.org/log/";
+|   Override "/org/ftp.debian.org/scripts/override/";
+|   Lists "/org/ftp.debian.org/database/dists/";
+|   Log "/org/ftp.debian.org/log/";

 |   Morgue "/org/ftp.debian.org/morgue/";
 |   Morgue "/org/ftp.debian.org/morgue/";

+|   Override "/org/ftp.debian.org/scripts/override/";
+|   AcceptedAutoBuild "/org/incoming.debian.org/buildd/";
+|   UrgencyLog "/org/ftp.debian.org/testing/urgencies/";
+|   Queue
+|   {  
+|     Root "/org/ftp.debian.org/queue/";
+|     Accepted "/org/ftp.debian.org/queue/accepted/";
+|     Byhand "/org/ftp.debian.org/queue/byhand/";
+|     Done "/org/ftp.debian.org/queue/done/";
+|     Holding "/org/ftp.debian.org/queue/holding/";
+|     New "/org/ftp.debian.org/queue/new/";
+|     Reject "/org/ftp.debian.org/queue/reject/";
+|     Unchecked "/org/ftp.debian.org/queue/unchecked/";
+|   };

 | };
 
 ================================================================================
 | };
 
 ================================================================================


@@ -72,6 +85,55 @@ put in the Release files.  OverrideCodeName is used by Denise.
 Priority determines which suite is used for the Maintainers file as
 generated by charisma/da_mkmaintainers (highest wins).
 
 Priority determines which suite is used for the Maintainers file as
 generated by charisma/da_mkmaintainers (highest wins).
 

+If CopyChanges is present it should be a path into the archive
+(i.e. "Dir::RootDir"); any upload targeted for a suite with this
+config option present will have the .changes file copied into that
+path.
+
+If CopyKatie is present it should be an absolute path; any upload
+targeted for a suite with this config option present will have the
+.katie file copied into that path.  This option is similar to
+CopyChanges and will most often be used with it; they're seperate
+because .changes files are mirrored and .katie files aren't, so the
+paths will usually be different.
+
+================================================================================
+
+SuiteMappings
+-------------
+
+Optional.  List of mappings for the Distribution file in a .changes file, e.g.:
+
+| SuiteMappings
+| {
+|    "map stable proposed-updates";
+|    "map frozen unstable";
+|    "map-unreleased stable unstable";
+|    "map-unreleased proposed-updates unstable";
+|    "ignore testing";
+| };
+
+There are three mapping types:
+
+(1) map <source> <dest>
+
+      Any target suite of '<source>' is unconditionally overriden 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>'.
+
+(3) ignore <suite>
+
+      Any target suite of '<suite>' is unconditionally removed from
+      the list of target suites.  NB: if the upload had only one
+      target suite this will lead to rejection.
+
+NB: ordering is not guaranteed.
+

 ================================================================================
 
 Dinstall
 ================================================================================
 
 Dinstall


@@ -94,6 +156,9 @@ Mandatory.  List of dinstall options, e.g.:
 |    LockFile "/org/ftp.debian.org/katie/lock";
 |    Bcc "archive@ftp-master.debian.org";
 |    GroupOverrideFilename "override.group-maint";
 |    LockFile "/org/ftp.debian.org/katie/lock";
 |    Bcc "archive@ftp-master.debian.org";
 |    GroupOverrideFilename "override.group-maint";

+|    FutureTimeTravelGrace "8640"; // 6 hours
+|    PastCutoffYear "1984";
+|    BXANotify 0;

 | };
 
 PGPKeyring and GPGKeyring are mandatory fields which are filenames of
 | };
 
 PGPKeyring and GPGKeyring are mandatory fields which are filenames of


@@ -126,6 +191,32 @@ GroupOverrideFilename, if non-blank, is the override file which
 contains the list of email addresses which, if part of the Maintainer
 field, cause uploads to always be treated as maintainer uploads.
 
 contains the list of email addresses which, if part of the Maintainer
 field, cause uploads to always be treated as maintainer uploads.
 

+FutureTimeTravelGrace specifies how many seconds into the future
+timestamps are allowed to be inside a deb before being rejected.
+PastCutoffYear specifies the cut-off year which is used when deciding
+whether or not to reject packages based on the file timestamp.
+
+BXANotify is a boolean; if true (Debian-specfic) BXA notification is
+sent.
+
+OverrideDisparityCheck is a boolean; if true, jennifer compares an
+uploads section/priority with the overrides and whines at the
+maintainer if they differ.
+
+CloseBugs is a boolean; if true the automated bug closing feature of
+dinstall is activated.
+
+SpecialAcceptedAutoBuild is a boolean; if true it activates support
+for auto-building from accepted.
+
+OverrideMaintainer can be used to globally override the
+__MAINTAINER_TO__ and __MAINTAINER_FROM__ variables in template mails.
+Use with caution.
+
+SkipTime is an integer value which is the number of seconds that a
+file must be older than (via it's last modified timestamp) before
+jennifer will REJECT rather than SKIP the package.
+

 ================================================================================
 
 Archive
 ================================================================================
 
 Archive


@@ -226,9 +317,9 @@ Mandatory.  List of al valid override types, e.g.
 
 | OverrideType
 | {
 
 | OverrideType
 | {

-|   deb "";
-|   dsc "";
-|   udeb "";
+|   deb;
+|   dsc;
+|   udeb;

 | };
 
 The type goes into the 'override_type' table in the SQL database.
 | };
 
 The type goes into the 'override_type' table in the SQL database.