]> git.decadent.org.uk Git - dak.git/blob - docs/README.first
check_signature, get_satus_output and Dict move to utils
[dak.git] / docs / README.first
1                                 Notes
2                                 =====
3
4 o Please be careful: katie sends out lots of emails and if not
5   configured properly will happily send them to lots of people who
6   probably didn't want those emails.
7
8 o Don't use katie.conf, apt.conf, cron.* etc. as starting points for
9   your own configuration files, they're the configuration files for
10   auric (aka ftp-master.debian.org) and are highly Debian specific.
11   Start from scratch and refer to the security.debian.org config files
12   (-security) as they're a better example for a private archive.
13
14 o Don't be put off by the names, see doc/README.names for a mapping of
15   name -> what the script does.
16
17                     What do all these scripts do?
18                     =============================
19
20 Generic and generally useful
21 ----------------------------
22
23 o To process queue/:
24
25   * jennifer - processes queue/unchecked
26   * kelly - processes queue/accepted
27   * lisa - processes queue/new and queue/byhand
28
29 o To generate indices files:
30
31   * jenna - generates file lists for apt-ftparchive and removes
32             obsolete packages from suites
33   * ziyi  - generates Release
34
35 o To clean things up:
36
37   * rhona - to remove obsolete files from the pool
38   * shania - to remove obsolete/stray files from the queue
39   * melanie - to remove package(s) from suite(s)
40
41 o Information display:
42
43   * madison - shows information about package(s)
44   * helena - shows information about package(s) in queue/
45
46 Generic and useful, but only for those with existing archives
47 -------------------------------------------------------------
48
49 o catherine - migrates packages from legacy locations to the pool
50 o neve - initializes a projectb database from an exisiting archive
51
52 Generic but not overly useful (in normal use)
53 ---------------------------------------------
54
55 o ashley - dumps info in .katie files
56 o julia - sync PostgreSQL users with system users
57 o rene - check for obsolete or duplicated packages
58 o rose - directory creation in the initial setup of an archive
59 o tea - various sanity checks of the database and archive
60 o natalie - manpiulates/list override entries
61 o heidi - removes/adds/lists package(s) from/to/for a suite
62 o saffron - produces various statistics
63
64 Semi-generic
65 ------------
66
67 To generate less-used indices files:
68
69 o charisma - generates Maintainers file
70 o denise  - generates override.<foo> files
71
72 Mostly Debian(.org) specific
73 ----------------------------
74
75 o amber - wrapper for Debian security team
76 o halle - removes obsolete .changes files from proposed-updates
77 o jeri - basic dependency checking for proposed-updates
78
79 Very Incomplete or otherwise not generally useful
80 -------------------------------------------------
81
82 o alyson - currently only initializes a DB from a katie.conf config file
83 o andrea - looks for version descrepancies that shouldn't exist in many
84            archives
85 o cindy - override cruft checker that doesn't work well with New Incoming
86
87 Scripts invoked by other scripts
88 --------------------------------
89
90 o fernanda - invoked by lisa to "check" NEW packages
91 o claire - invoked by catherine to determine packages still in legacy locations
92 o katie - common code used by lisa, jennifer, kelly and others
93
94                         How do I get started?
95                         =====================
96
97 [Very incomplete - FIXME]
98
99 o Write your own katie.conf and apt.conf files
100 o Run rose
101 o If you have an existing archive:
102    * Run neve
103   otherwise:
104    * Run alyson
105