]> git.decadent.org.uk Git - dak.git/blobdiff - docs/README.first
Merge remote-tracking branch 'jcristau/cs-set-log-suite'
[dak.git] / docs / README.first
index 07a1e3f9fbb86e1c4849a794aa035ca2127a62b7..017985dc6054ad2e4ea3afccc2f82252afd171d6 100644 (file)
@@ -1,18 +1,15 @@
                                Notes
                                =====
 
-o Please be careful: katie sends out lots of emails and if not
+o Please be careful: dak sends out lots of emails and if not
   configured properly will happily send them to lots of people who
   probably didn't want those emails.
 
-o Don't use katie.conf, apt.conf, cron.* etc. as starting points for
-  your own configuration files, they're the configuration files for
-  auric (aka ftp-master.debian.org) and are highly Debian specific.
-  Start from scratch and refer to the security.debian.org config files
-  (-security) as they're a better example for a private archive.
-
-o Don't be put off by the names, see doc/README.names for a mapping of
-  name -> what the script does.
+o Don't use the debian dak.conf, cron.* etc. as starting
+  points for your own configuration files, they're highly Debian
+  specific.  Start from scratch and refer to the security.debian.org
+  config files (-security) as they're a better example for a private
+  archive.
 
                    What do all these scripts do?
                    =============================
@@ -22,84 +19,73 @@ Generic and generally useful
 
 o To process queue/:
 
-  * jennifer - processes queue/unchecked
-  * kelly - processes queue/accepted
-  * lisa - processes queue/new and queue/byhand
+  * dak process-upload - processes queue/unchecked
+  * dak process-new - allows ftp administrator to process queue/new and queue/byhand
+  * dak process-policy - processes policy queues (including new and byhand)
 
 o To generate indices files:
 
-  * jenna - generates file lists for apt-ftparchive and removes
-            obsolete packages from suites
-  * ziyi  - generates Release
+  * dak dominate          - removes obsolete packages from suites
+  * dak generate-packages-sources2 - generate Packages, Sources
+  * dak generate-releases - generates Release
 
 o To clean things up:
 
-  * rhona - to remove obsolete files from the pool
-  * shania - to remove obsolete/stray files from the queue
-  * melanie - to remove package(s) from suite(s)
+  * dak clean-suites - to remove obsolete files from the pool
+  * dak clean-queues - to remove obsolete/stray files from the queue
+  * dak rm - to remove package(s) from suite(s)
+  * dak override - to change individual override entries
 
 o Information display:
 
-  * madison - shows information about package(s)
-  * helena - shows information about package(s) in queue/
+  * dak ls - shows information about package(s)
+  * dak queue-report - shows information about package(s) in queue/
+  * dak override - can show you individual override entries
+  * dak graph - creates some pretty graphs of queue sizes over time
 
 Generic and useful, but only for those with existing archives
 -------------------------------------------------------------
 
-o catherine - migrates packages from legacy locations to the pool
-o neve - initializes a projectb database from an exisiting archive
+o dak init-archive - initializes a projectb database from an existing archive
 
 Generic but not overly useful (in normal use)
 ---------------------------------------------
 
-o ashley - dumps info in .katie files
-o julia - sync PostgreSQL users with system users
-o rene - check for obsolete or duplicated packages
-o rose - directory creation in the initial setup of an archive
-o tea - various sanity checks of the database and archive
-o natalie - manpiulates/list override entries
-o heidi - removes/adds/lists package(s) from/to/for a suite
-o saffron - produces various statistics
+o dak import-users-from-passwd - sync PostgreSQL users with system users
+o dak cruft-report - check for obsolete or duplicated packages
+o dak init-dirs - directory creation in the initial setup of an archive
+o dak check-archive - various sanity checks of the database and archive
+o dak control-overrides - manipulates/lists override entries
+o dak control-suite - removes/adds/lists package(s) from/to/for a suite
+o dak stats - produces various statistics
+o dak find-null-maintainers - checks for users with no packages in the archive
 
 Semi-generic
 ------------
 
 To generate less-used indices files:
 
-o charisma - generates Maintainers file
-o denise  - generates override.<foo> files
+o dak make-maintainers - generates Maintainers file used by, e.g. debbugs
+o dak make-overrides  - generates override.<foo> files
 
 Mostly Debian(.org) specific
 ----------------------------
 
-o amber - wrapper for Debian security team
-o halle - removes obsolete .changes files from proposed-updates
-o jeri - basic dependency checking for proposed-updates
+o dak security-install - wrapper for Debian security team
+o dak import-ldap-fingerprints - syncs fingerprint and uid information with a debian.org LDAP DB
 
 Very Incomplete or otherwise not generally useful
 -------------------------------------------------
 
-o alyson - currently only initializes a DB from a katie.conf config file
-o andrea - looks for version descrepancies that shouldn't exist in many
-           archives
-o cindy - override cruft checker that doesn't work well with New Incoming
+o dak init-db - currently only initializes a DB from a dak.conf config file
+o dak check-overrides - override cruft checker that doesn't work well with New Incoming
 
 Scripts invoked by other scripts
 --------------------------------
 
-o fernanda - invoked by lisa to "check" NEW packages
-o claire - invoked by catherine to determine packages still in legacy locations
-o katie - common code used by lisa, jennifer, kelly and others
+o dak examine-package - invoked by 'dak process-new' to "check" NEW packages
 
                        How do I get started?
                        =====================
 
-[Very incomplete - FIXME]
-
-o Write your own katie.conf and apt.conf files
-o Run rose
-o If you have an existing archive:
-   * Run neve
-  otherwise:
-   * Run alyson
-
+Please refer to setup/README for instructions how to setup dak.