-Explanation of configuration files options for katie
-====================================================
+Explanation of configuration files options for dak
+==================================================
DB
--
| Port -1;
| };
-If the database is local, Host should be blank. If the port is the
-default (5432), it should be set to -1.
+Name (required): The name of the PostgreSQL database which has been created
+for dak.
+
+Host (required): The name of the host on which the database is located. If
+the database is local, Host should be blank.
+
+Port (required): The port of the database. If the port is the default
+value (5432), this option should be set to -1.
================================================================================
| {
| Root "/org/ftp.debian.org/ftp/";
| Pool "/org/ftp.debian.org/ftp/pool/";
-| Templates "/org/ftp.debian.org/katie/templates/";
+| Templates "/org/ftp.debian.org/dak/templates/";
| PoolRoot "pool/";
| 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/";
-| Override "/org/ftp.debian.org/scripts/override/";
-| AcceptedAutoBuild "/org/incoming.debian.org/buildd/";
+| QueueBuild "/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/";
| };
| };
+Root (required): Specifies the path of the root of the FTP archive.
+
+Pool (required): This variable specifies the path of the pool
+directory. Debian packages will be placed in the pool by 'dak
+process-accepted' after they have been accepted by dak
+process-unchecked.
+
+Templates (required): dak sends various mails and uses templates from
+this directory.
+
+PoolRoot (required): This variable specifies the basename of the pool
+directory.
+
+Override (optional): This directory optionally stores override files (used
+by 'dak make-overrides').
+
+Lists (optional): This directory holds file lists used by apt-ftparchive to
+generate Packages and Sources files (used by 'dak make-suite-file-list').
+
+Log (required): Log files are put in this directory.
+
+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.
+
+UrgencyLog (optional): If this directory is specified, 'dak
+process-accepted' will store the urgency value of each upload. This
+is mainly used for britney (the testing script).
+
+Queue (required): This sub-tree defines important directories for the
+incoming queue. The following variables have to be set: Accepted, Byhand
+Done, Holding, New, Reject, Unchecked. An explanation of the function of
+these directores can be found in README.new-incoming.
+
+Queue::BTSVersionTrack (optional): this directory holds the DebBugs
+Version Tracking support files.
+
================================================================================
Suite
| {
| Components
| {
-| main "";
+| main;
| };
| Architectures
| {
-| "source" "";
-| "all" "";
-| "i386" "";
+| source;
+| all;
+| i386;
| };
| Announce "debian-devel-changes@lists.debian.org";
| Origin "Debian";
| };
| };
-Announce controls where "Installed foo" mails are sent; leave empty to
-not send any. CodeName, Origin and Description are used by ziyi and
-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).
+Announce (optional): controls where "Installed foo" mails are sent.
+
+CodeName, Origin and Description (optional): This settings are used by
+'dak generate-releases' and put in the Release files.
+
+OverrideCodeName (optional): used by 'dak make-overrides'.
-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.
+Priority (optional) determines which suite is used for the Maintainers file
+as generated by 'dak make-maintainers' (highest wins).
-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.
+CopyChanges (optional): if this variable 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.
+
+CopyDotDak (optional): if this is present it should be an absolute path; any
+upload targeted for a suite with this config option present will have the
+.dak 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 .dak files aren't, so the paths will usually be
+different.
+
+There are more optional variables, such as VersionChecks. Please see
+dak.conf for examples.
================================================================================
| Dinstall
| {
-| PGPKeyring "/org/keyring.debian.org/keyrings/debian-keyring.pgp";
-| GPGKeyring "/org/keyring.debian.org/keyrings/debian-keyring.gpg";
| SigningKeyring "/org/ftp.debian.org/s3kr1t/dot-gnupg/secring.gpg";
+| SendmailCommand "/usr/sbin/sendmail -odq -oi -t";
| MyEmailAddress "Debian Installer <installer@ftp-master.debian.org>";
| MyAdminAddress "ftpmaster@debian.org";
-| MyHost "debian.org"; // used for generating user@my_host addresses in e.g. manual_reject()
| MyDistribution "Debian";
| BugServer "bugs.debian.org";
| PackagesServer "packages.debian.org";
| TrackingServer "packages.qa.debian.org";
-| LockFile "/org/ftp.debian.org/katie/lock";
+| LockFile "/org/ftp.debian.org/dak/lock";
| Bcc "archive@ftp-master.debian.org";
-| GroupOverrideFilename "override.group-maint";
-| FutureTimeTravelGrace "8640"; // 6 hours
+| FutureTimeTravelGrace 28800; // 8 hours
| PastCutoffYear "1984";
-| BXANotify 0;
+| BXANotify "false";
| };
-PGPKeyring and GPGKeyring are mandatory fields which are filenames of
-the PGP and GnuPG keyrings to be used by katie respectively.
+SigningKeyring (optional): this is the private keyring used by 'dak
+generate-releases'.
+
+SendmailCommand (required): command to call the MTA.
-SigningKeyring is the private keyring used by ziyi.
+MyEmailAddress (required): this is used as the From: line for sending mails
+as a script/daemon.
-MyEmailAddress is used as the From: line for sending mails as a
-script/daemon. MyAdminAddress is used as a contact address in mails.
+MyAdminAddress (required): used as a contact address in mails.
-MyDistribution is used in emails sent out by katie and others.
+MyDistribution (required): this variable is used in emails sent out by
+dak and others. It should indicate the name of the distribution.
-BugServer is used by katie and melanie when closing bugs.
+BugServer (required): is used by 'dak process-unchecked' and 'dak rm'
+when closing bugs.
-PackagesServer is used by melanie when carbon-copying a bug close mail
-to a package maintainer.
+PackagesServer (required): used by 'dak rm' and 'dak override' when
+carbon-copying a bug close mail to a package maintainer.
-TrackingServer is used by katie and melanie to send messages for the
-maintainer also to an alias for people tracking a specific source
-package.
+TrackingServer (optional): used by 'dak process-unchecked' and 'dak
+rm' to send messages for the maintainer also to an alias for people
+tracking a specific source package.
-LockFile is a mandatory field and contains the filename of the
-lockfile used by dinstall when in action mode (i.e. not using
--n/--no-action).
+LockFile (required): contains the filename of the lockfile used by dinstall
+when in action mode (i.e. not using -n/--no-action).
-All sent mail is blind carbon copied to the email
-address in Bcc if it's not blank.
+All sent mail is blind carbon copied to the email address in Bcc if it's
+not blank.
-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.
+FutureTimeTravelGrace (required): specifies how many seconds into the
+future timestamps are allowed to be inside a deb before being rejected.
-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.
+PastCutoffYear (required): 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.
+BXANotify (optional): a boolean (default: no); if true (Debian-specific)
+BXA notification is sent. The template for the BXA notification is located
+in Dir::Templates/process-new.bxa_notification and should be changed if this
+option is set.
-OverrideDisparityCheck is a boolean; if true, jennifer compares an
-uploads section/priority with the overrides and whines at the
-maintainer if they differ.
+OverrideDisparityCheck (optional): a boolean (default: no); if true,
+dak process-unchecked 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.
+CloseBugs (optional): a boolean (default: no); if true the automated bug
+closing feature of dinstall is activated.
-SpecialAcceptedAutoBuild is a boolean; if true it activates support
+QueueBuild is a boolean; if true it activates support
for auto-building from accepted.
-OverrideMaintainer can be used to globally override the
+OverrideMaintainer (optional): 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.
+SkipTime (required): an integer value which is the number of seconds that a
+file must be older than (via it's last modified timestamp) before dak process-unchecked
+will REJECT rather than SKIP the package.
+
+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
+set. NB: you should only enable this variable on production systems
+if you have strict control of your upload queue.
+
+KeyServer (optional): keyserver used for key auto-retrieval
+(c.f. KeyAutoFetch).
================================================================================
| };
| };
-OriginServer and PrimaryMirror are mandatory and are used melanie's
-bug closing mail templates. The host name and it's OriginServer and
-Description are part of the SQL database in the 'archive' table.
+OriginServer and PrimaryMirror (required): used 'dak rm's bug closing mail
+templates. The host name and it's OriginServer and Description are part of
+the SQL database in the 'archive' table.
================================================================================
| };
Both values go into the SQL database's 'architecture' table.
-Description is currently unused.
-
-================================================================================
-
-Component
----------
-
-Mandatory. List of all components, e.g.
-
-| Component
-| {
-| main
-| {
-| Description "Main";
-| MeetsDFSG "true";
-| };
-| };
-
-All three values go into the SQL database's 'component' table.
-MeetsDFSG is currently unused.
+The description is currently unused.
================================================================================
| Section
| {
-| base "";
+| base;
| };
The section goes into the 'section' table in SQL database.
================================================================================
-OverrideType
-------------
-
-Mandatory. List of al valid override types, e.g.
-
-| OverrideType
-| {
-| deb "";
-| dsc "";
-| udeb "";
-| };
-
-The type goes into the 'override_type' table in the SQL database.
-
-================================================================================
-
Location
--------
| {
| Archive "ftp-master";
| Type "pool";
+| Suites
+| {
+| Stable;
+| Unstable;
+| };
| };
| };
-There are three types: 'legacy', 'legacy-mixed' and 'pool'. 'legacy'
-and 'pool' are assumed to have sections for all components listed in
-the Components section 'legacy-mixed' are assumed to mix all
-components into one location. The Archive and Type sections go into
-the SQL database's 'location' table.
+There are three valid values for 'Type': 'legacy', 'legacy-mixed' and
+'pool'. 'legacy' and 'pool' are assumed to have sections for all
+components listed in the Components section 'legacy-mixed' are assumed
+to mix all components into one location. The 'Archive' and 'Type'
+sections go into the SQL database's 'location' table. 'Suites' is a
+list of existent suites that should be used to populate the SQL
+database.
+
+Note that the archive value specified here must correspond to one defined
+in Archive.
[Note: yes, this is horrible, it dates back to the original `import
- the existent archive into the SQL Database' script (neve) and
+ the existent archive into the SQL Database' script ('dak import-archive') and
isn't otherwise used. It should be revisted at some stage.]
================================================================================
---
-James Troup <james@nocrew.org>, Horsforth, Leeds
-Wed, 26 Sep 2001 03:20:39 +0100
+Urgency
+-------
+
+Mandatory.
+
+| Urgency
+| {
+| Default "low";
+| Valid
+| {
+| low;
+| medium;
+| high;
+| emergency;
+| critical;
+| };
+| };
+
+This defines the valid and default urgency of an upload. If a package is
+uploaded with an urgency not listed here, it will be rejected.
+
+================================================================================
projects / dak.git / blobdiff