X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=docs%2FREADME.config;h=a20cfc9f06d548520d807d8c2b847d5f4275f02d;hb=a4eef13f8450fe8b109f4fafc074d50f0fda0a7c;hp=087bf23f70f5afaeb756cf161eedd7707397e62f;hpb=f1c6b12f17fd63c6b6e644deff776dc378fdadad;p=dak.git diff --git a/docs/README.config b/docs/README.config index 087bf23f..a20cfc9f 100644 --- a/docs/README.config +++ b/docs/README.config @@ -1,5 +1,5 @@ -Explanation of configuration files options for katie -==================================================== +Explanation of configuration files options for dak +================================================== DB -- @@ -14,7 +14,7 @@ Essential. List of database details, e.g. | }; Name (required): The name of the PostgreSQL database which has been created -for katie. +for dak. Host (required): The name of the host on which the database is located. If the database is local, Host should be blank. @@ -33,14 +33,14 @@ Mandatory. List of directory locations, e.g. | { | 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/"; | MorgueReject "reject"; -| AcceptedAutoBuild "/org/incoming.debian.org/buildd/"; +| QueueBuild "/org/incoming.debian.org/buildd/"; | UrgencyLog "/org/ftp.debian.org/testing/urgencies/"; | Queue | { @@ -56,45 +56,49 @@ Mandatory. List of directory locations, e.g. 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 kelly after they have been -accepted by jennifer. +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): katie sends various mails and uses templates from +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 denise). +by 'dak make-overrides'). Lists (optional): This directory holds file lists used by apt-ftparchive to -generate Packages and Sources files (used by jenna). +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 -Shania::MorgueSubDir and Rhona::MorgueSubDir. +Clean-Queues::MorgueSubDir and Clean-Suites::MorgueSubDir. -MorgueReject (required): if katie cannot move a rejected package to +MorgueReject (required): if dak cannot move a rejected package to Dir::Queue::Reject, it will try to move it to the Dir::MorgueReject directory located under Dir::Morgue. -AcceptedAutoBuild (optional): This variable is only relevant if any suites -are to be auto built, i.e. if Dinstall::AcceptedAutoBuildSuites has any +QueueBuild (optional): This variable is only relevant if any suites +are to be auto built, i.e. if Dinstall::QueueBuildSuites has any values. -UrgencyLog (optional): If this directory is specified, kelly will store the -urgency value of each upload. This is mainly used for britney (the testing -script). +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 @@ -127,28 +131,28 @@ Mandatory. List of all suites, e.g. Announce (optional): controls where "Installed foo" mails are sent. -CodeName, Origin and Description (optional): This settings are used by ziyi -and put in the Release files. +CodeName, Origin and Description (optional): This settings are used by +'dak generate-releases' and put in the Release files. -OverrideCodeName (optional): used by Denise. +OverrideCodeName (optional): used by 'dak make-overrides'. Priority (optional) determines which suite is used for the Maintainers file -as generated by charisma/da_mkmaintainers (highest wins). +as generated by 'dak make-maintainers' (highest wins). 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. -CopyKatie (optional): if this is present it should be an absolute path; any +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 -.katie file copied into that path. This option is similar to CopyChanges +.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 .katie files aren't, so the paths will usually be +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 -katie.conf for examples. +dak.conf for examples. ================================================================================ @@ -196,8 +200,10 @@ Mandatory. List of dinstall options, e.g.: | Dinstall | { -| PGPKeyring "/org/keyring.debian.org/keyrings/debian-keyring.pgp"; -| GPGKeyring "/org/keyring.debian.org/keyrings/debian-keyring.gpg"; +| GPGKeyring { +| "/org/keyring.debian.org/keyrings/debian-keyring.gpg"; +| "/org/keyring.debian.org/keyrings/debian-keyring.pgp"; +| }; | SigningKeyring "/org/ftp.debian.org/s3kr1t/dot-gnupg/secring.gpg"; | SendmailCommand "/usr/sbin/sendmail -odq -oi -t"; | MyEmailAddress "Debian Installer "; @@ -207,22 +213,22 @@ Mandatory. List of dinstall options, e.g.: | 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 28800; // 8 hours | PastCutoffYear "1984"; | BXANotify "false"; -| AcceptedAutoBuildSuites +| QueueBuildSuites | { | unstable; | }; | }; -PGPKeyring and GPGKeyring (required): filenames of the PGP and GnuPG -keyrings to be used by katie respectively. +GPGKeyring (required): filenames of the PGP and GnuPG +keyrings to be used by dak. -SigningKeyring (optional): this is the private keyring used by ziyi. +SigningKeyring (optional): this is the private keyring used by 'dak +generate-releases'. SendmailCommand (required): command to call the MTA. @@ -232,16 +238,17 @@ as a script/daemon. MyAdminAddress (required): used as a contact address in mails. MyDistribution (required): this variable is used in emails sent out by -katie and others. It should indicate the name of the distribution. +dak and others. It should indicate the name of the distribution. -BugServer (required): is used by katie and melanie when closing bugs. +BugServer (required): is used by 'dak process-unchecked' and 'dak rm' +when closing bugs. -PackagesServer (requried): 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 (optional): 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 (required): contains the filename of the lockfile used by dinstall when in action mode (i.e. not using -n/--no-action). @@ -249,10 +256,6 @@ 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. -GroupOverrideFilename (optional): this 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. @@ -261,20 +264,20 @@ deciding whether or not to reject packages based on the file timestamp. 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/lisa.bxa_notification and should be changed if this +in Dir::Templates/process-new.bxa_notification and should be changed if this option is set. OverrideDisparityCheck (optional): a boolean (default: no); if true, -jennifer compares an uploads section/priority with the overrides and whines +dak process-unchecked compares an uploads section/priority with the overrides and whines at the maintainer if they differ. CloseBugs (optional): a boolean (default: no); if true the automated bug closing feature of dinstall is activated. -AcceptedAutoBuildSuites (optional): a list of suites which should be auto +QueueBuildSuites (optional): a list of suites which should be auto build. -SpecialAcceptedAutoBuild is a boolean; if true it activates support +QueueBuild is a boolean; if true it activates support for auto-building from accepted. OverrideMaintainer (optional): be used to globally override the @@ -282,9 +285,18 @@ __MAINTAINER_TO__ and __MAINTAINER_FROM__ variables in template mails. Use with caution. 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 jennifer +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). + ================================================================================ Archive @@ -302,7 +314,7 @@ Mandatory. List of all archives, e.g. | }; | }; -OriginServer and PrimaryMirror (required): used melanie's bug closing mail +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. @@ -405,20 +417,27 @@ Mandatory. List all locations, e.g. | { | 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.] ================================================================================ @@ -445,7 +464,3 @@ 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. ================================================================================ - --- -James Troup , Horsforth, Leeds -Wed, 26 Sep 2001 03:20:39 +0100