chiark / gitweb /
Update minimal GPG key length to match current requirements. Closes: #643933 Thanks...
[developers-reference.git] / resources.dbk
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4   <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
5 ]>
6 <chapter id="resources">
7 <title>Resources for Debian Developers</title>
8 <para>
9 In this chapter you will find a very brief road map of the Debian mailing
10 lists, the Debian machines which may be available to you as a developer, and
11 all the other resources that are available to help you in your maintainer work.
12 </para>
13 <section id="mailing-lists">
14 <title>Mailing lists</title>
15 <para>
16 Much of the conversation between Debian developers (and users) is managed
17 through a wide array of mailing lists we host at <literal><ulink
18 url="http://&lists-host;/">&lists-host;</ulink></literal>.
19 To find out more on how to subscribe or unsubscribe, how to post and how not to
20 post, where to find old posts and how to search them, how to contact the list
21 maintainers and see various other information about the mailing lists, please
22 read <ulink url="&url-debian-lists;"></ulink>.  This section
23 will only cover aspects of mailing lists that are of particular interest to
24 developers.
25 </para>
26 <section id="mailing-lists-rules">
27 <title>Basic rules for use</title>
28 <para>
29 When replying to messages on the mailing list, please do not send a carbon copy
30 (<literal>CC</literal>) to the original poster unless they explicitly request
31 to be copied.  Anyone who posts to a mailing list should read it to see the
32 responses.
33 </para>
34 <para>
35 Cross-posting (sending the same message to multiple lists) is discouraged.  As
36 ever on the net, please trim down the quoting of articles you're replying to.
37 In general, please adhere to the usual conventions for posting messages.
38 </para>
39 <para>
40 Please read the <ulink
41 url="&url-debian-lists;#codeofconduct">code of conduct</ulink>
42 for more information. The <ulink url="&url-dcg;">Debian Community
43 Guidelines</ulink> are also worth reading.
44 </para>
45 </section>
46
47 <section id="core-devel-mailing-lists">
48 <title>Core development mailing lists</title>
49 <para>
50 The core Debian mailing lists that developers should use are:
51 </para>
52 <itemizedlist>
53 <listitem>
54 <para>
55 &email-debian-devel-announce;, used to announce important
56 things to developers.  All developers are expected to be subscribed to this
57 list.
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 &email-debian-devel;, used to discuss various development
63 related technical issues.
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 &email-debian-policy;, where the Debian Policy is discussed
69 and voted on.
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 &email-debian-project;, used to discuss various non-technical
75 issues related to the project.
76 </para>
77 </listitem>
78 </itemizedlist>
79 <para>
80 There are other mailing lists available for a variety of special topics; see
81 <ulink url="http://&lists-host;/"></ulink> for a list.
82 </para>
83 </section>
84
85 <section id="mailing-lists-special">
86 <title>Special lists</title>
87 <para>
88 &email-debian-private; is a special mailing list for private
89 discussions amongst Debian developers.  It is meant to be used for posts which
90 for whatever reason should not be published publicly.  As such, it is a low
91 volume list, and users are urged not to use
92 &email-debian-private; unless it is really necessary.
93 Moreover, do <emphasis>not</emphasis> forward email from that list to anyone.
94 Archives of this list are not available on the web for obvious reasons, but you
95 can see them using your shell account on <literal>&master-host;</literal>
96 and looking in the <filename>&file-debian-private-archive;</filename>
97 directory.
98 </para>
99 <para>
100 &email-debian-email; is a special mailing list used as a
101 grab-bag for Debian related correspondence such as contacting upstream authors
102 about licenses, bugs, etc.  or discussing the project with others where it
103 might be useful to have the discussion archived somewhere.
104 </para>
105 </section>
106
107 <section id="mailing-lists-new">
108 <title>Requesting new development-related lists</title>
109 <para>
110 Before requesting a mailing list that relates to the development of a package
111 (or a small group of related packages), please consider if using an alias (via
112 a .forward-aliasname file on master.debian.org, which translates into a
113 reasonably nice <replaceable>you-aliasname@debian.org</replaceable> address) or
114 a self-managed mailing list on <link linkend="alioth">Alioth</link> is
115 more appropriate.
116 </para>
117 <para>
118 If you decide that a regular mailing list on &lists-host; is really what
119 you want, go ahead and fill in a request, following <ulink
120 url="&url-debian-lists-new;">the HOWTO</ulink>.
121 </para>
122 </section>
123
124 </section>
125
126 <section id="irc-channels">
127 <title>IRC channels</title>
128 <para>
129 Several IRC channels are dedicated to Debian's development.  They are mainly
130 hosted on the <ulink url="&url-oftc;">Open and free technology
131 community (OFTC)</ulink> network.  The <literal>irc.debian.org</literal> DNS
132 entry is an alias to <literal>irc.oftc.net</literal>.
133 </para>
134 <para>
135 The main channel for Debian in general is <literal>#debian</literal>.  This
136 is a large, general-purpose channel where users can find recent news in the
137 topic and served by bots.  <literal>#debian</literal> is for English
138 speakers; there are also <literal>#debian.de</literal>,
139 <literal>#debian-fr</literal>, <literal>#debian-br</literal> and other
140 similarly named channels for speakers of other languages.
141 </para>
142 <para>
143 The main channel for Debian development is <literal>#debian-devel</literal>.
144 It is a very active channel; it will typically have a minimum of 150 people
145 at any time of day.
146 It's a channel for people who work on Debian, it's not a support channel
147 (there's <literal>#debian</literal> for that).  It is however open to anyone
148 who wants to lurk (and learn).  Its topic is commonly full of interesting
149 information for developers.
150 </para>
151 <para>
152 Since <literal>#debian-devel</literal> is an open channel, you should not
153 speak there of issues that are discussed in
154 &email-debian-private;.  There's another channel for this
155 purpose, it's called <literal>#debian-private</literal> and it's protected by
156 a key.  This key is available at
157 <filename>master.debian.org:&file-debian-private-key;</filename>.
158 </para>
159 <para>
160 There are other additional channels dedicated to specific subjects.
161 <literal>#debian-bugs</literal> is used for coordinating bug squashing
162 parties.  <literal>#debian-boot</literal> is used to coordinate the work on
163 the debian-installer.  <literal>#debian-doc</literal> is occasionally used to
164 talk about documentation, like the document you are reading.  Other channels
165 are dedicated to an architecture or a set of packages:
166 <literal>#debian-kde</literal>, <literal>#debian-dpkg</literal>,
167 <literal>#debian-jr</literal>, <literal>#debian-edu</literal>,
168 <literal>#debian-oo</literal> (OpenOffice.org package)...
169 </para>
170 <para>
171 Some non-English developers' channels exist as well, for example
172 <literal>#debian-devel-fr</literal> for French speaking people interested in
173 Debian's development.
174 </para>
175 <para>
176 Channels dedicated to Debian also exist on other IRC networks, notably on the
177 <ulink url="&url-openprojects;">freenode</ulink> IRC network,
178 which was pointed at by the <literal>irc.debian.org</literal> alias until 4th
179 June 2006.
180 </para>
181 <para>
182 To get a cloak on freenode, you send Jörg Jaspert &lt;joerg@debian.org&gt; a
183 signed mail where you tell what your nick is.  Put cloak somewhere in the
184 Subject: header.  The nick should be registered: <ulink
185 url="http://freenode.net/faq.shtml#nicksetup">Nick Setup Page</ulink>.  The
186 mail needs to be signed by a key in the Debian keyring.  Please see <ulink
187 url="http://freenode.net/faq.shtml#projectcloak">Freenodes
188 documentation</ulink> for more information about cloaks.
189 </para>
190 </section>
191
192 <section id="doc-rsrcs">
193 <title>Documentation</title>
194 <para>
195 This document contains a lot of information which is useful to Debian
196 developers, but it cannot contain everything.  Most of the other interesting
197 documents are linked from <ulink url="&url-devel-docs;">The
198 Developers' Corner</ulink>.  Take the time to browse all the links, you will
199 learn many more things.
200 </para>
201 </section>
202
203 <section id="server-machines">
204 <title>Debian machines</title>
205 <para>
206 Debian has several computers working as servers, most of which serve critical
207 functions in the Debian project.  Most of the machines are used for porting
208 activities, and they all have a permanent connection to the Internet.
209 </para>
210 <para>
211 Some of the machines are available for individual developers to use, as long as
212 the developers follow the rules set forth in the <ulink
213 url="&url-dmup;">Debian Machine Usage Policies</ulink>.
214 </para>
215 <para>
216 Generally speaking, you can use these machines for Debian-related purposes as
217 you see fit.  Please be kind to system administrators, and do not use up tons
218 and tons of disk space, network bandwidth, or CPU without first getting the
219 approval of the system administrators.  Usually these machines are run by
220 volunteers.
221 </para>
222 <para>
223 Please take care to protect your Debian passwords and SSH keys installed on
224 Debian machines.  Avoid login or upload methods which send passwords over the
225 Internet in the clear, such as Telnet, FTP, POP etc.
226 </para>
227 <para>
228 Please do not put any material that doesn't relate to Debian on the Debian
229 servers, unless you have prior permission.
230 </para>
231 <para>
232 The current list of Debian machines is available at <ulink
233 url="&url-devel-machines;"></ulink>.  That web page contains
234 machine names, contact information, information about who can log in, SSH keys
235 etc.
236 </para>
237 <para>
238 If you have a problem with the operation of a Debian server, and you think that
239 the system operators need to be notified of this problem, you can check
240 the list of open issues in the DSA queue of our request tracker at <ulink
241 url="&url-rt;" /> (you can login with user "guest" and password "readonly").
242 To report a new problem, simply send a mail to &email-rt-dsa; and make
243 sure to put the string "Debian RT" somewhere in the subject.
244 </para>
245 <para>
246 If you have a problem with a certain service, not related to the system
247 administration (such as packages to be removed from the archive, suggestions
248 for the web site, etc.), generally you'll report a bug against a
249 ``pseudo-package''.  See <xref linkend="submit-bug"/> for information on how to
250 submit bugs.
251 </para>
252 <para>
253 Some of the core servers are restricted, but the information from there is
254 mirrored to another server.
255 </para>
256 <section id="servers-bugs">
257 <title>The bugs server</title>
258 <para>
259 <literal>&bugs-host;</literal> is the canonical location for
260 the Bug Tracking System (BTS).
261 </para>
262 <para>
263 If you plan on doing some statistical analysis or processing of Debian bugs,
264 this would be the place to do it.  Please describe your plans on
265 &email-debian-devel; before implementing anything, however, to
266 reduce unnecessary duplication of effort or wasted processing time.
267 </para>
268 </section>
269
270 <section id="servers-ftp-master">
271 <title>The ftp-master server</title>
272 <para>
273 The <literal>&ftp-master-host;</literal> server holds the canonical copy of
274 the Debian archive.  Generally, package uploaded to &ftp-upload-host;
275 end up on this server, see <xref linkend="upload"/>.
276 </para>
277 <para>
278 It is restricted; a mirror is available on <literal>&ftp-master-mirror;</literal>.
279 </para>
280 <para>
281 Problems with the Debian FTP archive generally need to be reported as bugs
282 against the <systemitem role="package">&ftp-debian-org;</systemitem>
283 pseudo-package or an email to &email-ftpmaster;, but also see
284 the procedures in <xref linkend="archive-manip"/>.
285 </para>
286 </section>
287
288 <section id="servers-www">
289 <title>The www-master server</title>
290 <para>
291 The main web server is <literal>www-master.debian.org</literal>.  It holds the
292 official web pages, the face of Debian for most newbies.
293 </para>
294 <para>
295 If you find a problem with the Debian web server, you should generally submit a
296 bug against the pseudo-package, <systemitem
297 role="package">www.debian.org</systemitem>.  Remember to check whether or not
298 someone else has already reported the problem to the <ulink
299 url="http://&bugs-host;/&www-debian-org;">Bug Tracking System</ulink>.
300 </para>
301 </section>
302
303 <section id="servers-people">
304 <title>The people web server</title>
305 <para>
306 <literal>people.debian.org</literal> is the server used for developers' own web
307 pages about anything related to Debian.
308 </para>
309 <para>
310 If you have some Debian-specific information which you want to serve on the
311 web, you can do this by putting material in the
312 <filename>public_html</filename> directory under your home directory on
313 <literal>people.debian.org</literal>.  This will be accessible at the URL
314 <literal>http://people.debian.org/~<replaceable>your-user-id</replaceable>/</literal>.
315 </para>
316 <para>
317 You should only use this particular location because it will be backed up,
318 whereas on other hosts it won't.
319 </para>
320 <para>
321 Usually the only reason to use a different host is when you need to publish
322 materials subject to the U.S.  export restrictions, in which case you can use
323 one of the other servers located outside the United States.
324 </para>
325 <para>
326 Send mail to &email-debian-devel; if you have any questions.
327 </para>
328 </section>
329
330 <section id="servers-vcs">
331 <title>The VCS servers</title>
332 <para>
333 If you need to use a Version Control System for any of your Debian work,
334 you can use one of the existing repositories hosted on Alioth or you can
335 request a new project and ask for the VCS repository of your choice.
336 Alioth supports CVS (cvs.alioth.debian.org/cvs.debian.org), Subversion
337 (svn.debian.org), Arch (tla/baz, both on arch.debian.org), Bazaar
338 (bzr.debian.org), Darcs (darcs.debian.org), Mercurial (hg.debian.org) and Git
339 (git.debian.org).  Checkout <ulink url="&url-alioth-pkg;" /> if you plan
340 to maintain packages in a VCS repository. See <xref linkend="alioth"/> for
341 information on the services provided by Alioth.
342 </para>
343 </section>
344
345 <section id="dchroot">
346 <title>chroots to different distributions</title>
347 <para>
348 On some machines, there are chroots to different distributions available.  You
349 can use them like this:
350 </para>
351 <screen>
352 vore$ dchroot unstable
353 Executing shell in chroot: /org/vore.debian.org/chroots/user/unstable
354 </screen>
355 <para>
356 In all chroots, the normal user home directories are available.  You can find
357 out which chroots are available via
358 <ulink url="&url-devel-machines;"></ulink>.
359 </para>
360 </section>
361
362 </section>
363
364 <section id="devel-db">
365 <title>The Developers Database</title>
366 <para>
367 The Developers Database, at <ulink
368 url="&url-debian-db;"></ulink>, is an LDAP directory for
369 managing Debian developer attributes.  You can use this resource to search the
370 list of Debian developers.  Part of this information is also available through
371 the finger service on Debian servers, try <command>finger
372 yourlogin@db.debian.org</command> to see what it reports.
373 </para>
374 <para>
375 Developers can <ulink url="&url-debian-db-login;">log into the
376 database</ulink> to change various information about themselves, such as:
377 </para>
378 <itemizedlist>
379 <listitem>
380 <para>
381 forwarding address for your debian.org email
382 </para>
383 </listitem>
384 <listitem>
385 <para>
386 subscription to debian-private
387 </para>
388 </listitem>
389 <listitem>
390 <para>
391 whether you are on vacation
392 </para>
393 </listitem>
394 <listitem>
395 <para>
396 personal information such as your address, country, the latitude and longitude
397 of the place where you live for use in <ulink
398 url="&url-worldmap;">the world map of Debian
399 developers</ulink>, phone and fax numbers, IRC nickname and web page
400 </para>
401 </listitem>
402 <listitem>
403 <para>
404 password and preferred shell on Debian Project machines
405 </para>
406 </listitem>
407 </itemizedlist>
408 <para>
409 Most of the information is not accessible to the public, naturally.  For more
410 information please read the online documentation that you can find at <ulink
411 url="&url-debian-db-doc;"></ulink>.
412 </para>
413 <para>
414 Developers can also submit their SSH keys to be used for authorization on the
415 official Debian machines, and even add new *.debian.net DNS entries.  Those
416 features are documented at <ulink
417 url="&url-debian-db-mail-gw;"></ulink>.
418 </para>
419 </section>
420
421 <section id="archive">
422 <title>The Debian archive</title>
423 <para>
424 The &debian-formal; distribution consists of a lot of packages
425 (currently around &number-of-pkgs; source packages) and a few additional
426 files (such as documentation and installation disk images).
427 </para>
428 <para>
429 Here is an example directory tree of a complete Debian archive:
430 </para>
431 &sample-dist-dirtree;
432 <para>
433 As you can see, the top-level directory contains two directories,
434 <filename>dists/</filename> and <filename>pool/</filename>.  The latter is a
435 “pool” in which the packages actually are, and which is handled by the
436 archive maintenance database and the accompanying programs.  The former
437 contains the distributions, <literal>stable</literal>,
438 <literal>testing</literal> and <literal>unstable</literal>.  The
439 <filename>Packages</filename> and <filename>Sources</filename> files in the
440 distribution subdirectories can reference files in the
441 <filename>pool/</filename> directory.  The directory tree below each of the
442 distributions is arranged in an identical manner.  What we describe below for
443 <literal>stable</literal> is equally applicable to the
444 <literal>unstable</literal> and <literal>testing</literal> distributions.
445 </para>
446 <para>
447 <filename>dists/stable</filename> contains three directories, namely
448 <filename>main</filename>, <filename>contrib</filename>, and
449 <filename>non-free</filename>.
450 </para>
451 <para>
452 In each of the areas, there is a directory for the source packages
453 (<filename>source</filename>) and a directory for each supported architecture
454 (<filename>binary-i386</filename>, <filename>binary-amd64</filename>, etc.).
455 </para>
456 <para>
457 The <filename>main</filename> area contains additional directories which hold
458 the disk images and some essential pieces of documentation required for
459 installing the Debian distribution on a specific architecture
460 (<filename>disks-i386</filename>, <filename>disks-amd64</filename>, etc.).
461 </para>
462 <section id="archive-sections">
463 <title>Sections</title>
464 <para>
465 The <literal>main</literal> section of the Debian archive is what makes up
466 the <emphasis role="strong">official &debian-formal; distribution</emphasis>.
467 The <literal>main</literal> section is official because it fully complies
468 with all our guidelines.  The other two sections do not, to different degrees;
469 as such, they are <emphasis role="strong">not</emphasis> officially part of
470 &debian-formal;.
471 </para>
472 <para>
473 Every package in the main section must fully comply with the <ulink
474 url="&url-dfsg;">Debian Free Software
475 Guidelines</ulink> (DFSG) and with all other policy requirements as described
476 in the <ulink url="&url-debian-policy;">Debian Policy
477 Manual</ulink>.  The DFSG is our definition of “free software.” Check out
478 the Debian Policy Manual for details.
479 </para>
480 <para>
481 Packages in the <literal>contrib</literal> section have to comply with the
482 DFSG, but may fail other requirements.  For instance, they may depend on
483 non-free packages.
484 </para>
485 <para>
486 Packages which do not conform to the DFSG are placed in the
487 <literal>non-free</literal> section.  These packages are not considered as
488 part of the Debian distribution, though we enable their use, and we provide
489 infrastructure (such as our bug-tracking system and mailing lists) for non-free
490 software packages.
491 </para>
492 <para>
493 The <ulink url="&url-debian-policy;">Debian Policy
494 Manual</ulink> contains a more exact definition of the three sections.  The
495 above discussion is just an introduction.
496 </para>
497 <para>
498 The separation of the three sections at the top-level of the archive is
499 important for all people who want to distribute Debian, either via FTP servers
500 on the Internet or on CD-ROMs: by distributing only the
501 <literal>main</literal> and <literal>contrib</literal> sections, one can
502 avoid any legal risks.  Some packages in the <literal>non-free</literal>
503 section do not allow commercial distribution, for example.
504 </para>
505 <para>
506 On the other hand, a CD-ROM vendor could easily check the individual package
507 licenses of the packages in <literal>non-free</literal> and include as many
508 on the CD-ROMs as it's allowed to.  (Since this varies greatly from vendor to
509 vendor, this job can't be done by the Debian developers.)
510 </para>
511 <para>
512 Note that the term section is also used to refer to categories which simplify
513 the organization and browsing of available packages, e.g.
514 <literal>admin</literal>, <literal>net</literal>,
515 <literal>utils</literal> etc.  Once upon a time, these sections (subsections,
516 rather) existed in the form of subdirectories within the Debian archive.
517 Nowadays, these exist only in the Section header fields of packages.
518 </para>
519 </section>
520
521 <section id="s4.6.2">
522 <title>Architectures</title>
523 <para>
524 In the first days, the Linux kernel was only available for Intel i386 (or
525 greater) platforms, and so was Debian.  But as Linux became more and more
526 popular, the kernel was ported to other architectures and Debian started
527 to support them. And as if supporting so much hardware was not enough,
528 Debian decided to build some ports based on other Unix kernels, like
529 <literal>hurd</literal> and <literal>kfreebsd</literal>.
530 </para>
531 <para>
532 &debian-formal; 1.3 was only available as <literal>i386</literal>.  Debian
533 2.0 shipped for <literal>i386</literal> and <literal>m68k</literal>
534 architectures.  Debian 2.1 shipped for the <literal>i386</literal>,
535 <literal>m68k</literal>, <literal>alpha</literal>, and
536 <literal>sparc</literal> architectures.  Since then Debian has grown hugely.
537 Debian 6 supports a total of nine Linux architectures (<literal>amd64</literal>,
538 <literal>armel</literal>, <literal>i386</literal>,
539 <literal>ia64</literal>, <literal>mips</literal>,
540 <literal>mipsel</literal>, <literal>powerpc</literal>,
541 <literal>s390</literal>, <literal>sparc</literal>) and two kFreeBSD architectures
542 (<literal>kfreebsd-i386</literal> and <literal>kfreebsd-amd64</literal>).
543 </para>
544 <para>
545 Information for developers and users about the specific ports are available at
546 the <ulink url="&url-debian-ports;">Debian Ports web pages</ulink>.
547 </para>
548 </section>
549
550 <section id="s4.6.3">
551 <title>Packages</title>
552 <para>
553 There are two types of Debian packages, namely <literal>source</literal> and
554 <literal>binary</literal> packages.
555 </para>
556 <para>
557 Depending on the format of the source package, it will consist
558 of one or more files in addition to the mandatory <filename>.dsc</filename>
559 file:
560 <itemizedlist>
561 <listitem><para>with format “1.0”, it has either a <filename>.tar.gz</filename>
562 file or both an <filename>.orig.tar.gz</filename> and a
563 <filename>.diff.gz</filename> file;</para></listitem>
564 <listitem><para>with format “3.0 (quilt)”, it has a mandatory
565 <filename>.orig.tar.{gz,bz2,xz}</filename> upstream tarball,
566 multiple optional <filename>.orig-<replaceable>component</replaceable>.tar.{gz,bz2,xz}</filename>
567 additional upstream tarballs and a mandatory
568 <filename>debian.tar.{gz,bz2,xz}</filename> debian
569 tarball;</para></listitem>
570 <listitem><para>with format “3.0 (native)”, it has only
571 a single <filename>.tar.{gz,bz2,xz}</filename> tarball.</para></listitem>
572 </itemizedlist>
573 </para>
574 <para>
575 If a package is developed specially for Debian and is not distributed
576 outside of Debian, there is just one
577 <filename>.tar.{gz,bz2,xz}</filename> file which contains the sources of
578 the program, it's called a “native” source package.  If a package is
579 distributed elsewhere too, the
580 <filename>.orig.tar.{gz,bz2,xz}</filename> file stores the so-called
581 <literal>upstream source code</literal>, that is the source code that's
582 distributed by the <literal>upstream maintainer</literal> (often the
583 author of the software). In this case, the <filename>.diff.gz</filename>
584 or the <filename>debian.tar.{gz,bz2,xz}</filename> contains the changes
585 made by the Debian maintainer.
586 </para>
587 <para>
588 The <filename>.dsc</filename> file lists all the files in the source package
589 together with checksums (<command>md5sums</command>) and some additional info
590 about the package (maintainer, version, etc.).
591 </para>
592 </section>
593
594 <section id="s4.6.4">
595 <title>Distributions</title>
596 <para>
597 The directory system described in the previous chapter is itself contained
598 within <literal>distribution directories</literal>.  Each distribution is
599 actually contained in the <filename>pool</filename> directory in the top-level
600 of the Debian archive itself.
601 </para>
602 <para>
603 To summarize, the Debian archive has a root directory within an FTP server.
604 For instance, at the mirror site, <literal>ftp.us.debian.org</literal>, the
605 Debian archive itself is contained in <ulink
606 url="ftp://ftp.us.debian.org/debian">/debian</ulink>, which is a common
607 location (another is <filename>/pub/debian</filename>).
608 </para>
609 <para>
610 A distribution comprises Debian source and binary packages, and the respective
611 <filename>Sources</filename> and <filename>Packages</filename> index files,
612 containing the header information from all those packages.  The former are kept
613 in the <filename>pool/</filename> directory, while the latter are kept in the
614 <filename>dists/</filename> directory of the archive (for backwards
615 compatibility).
616 </para>
617 <section id="sec-dists">
618 <title>Stable, testing, and unstable</title>
619 <para>
620 There are always distributions called <literal>stable</literal> (residing in
621 <filename>dists/stable</filename>), <literal>testing</literal> (residing in
622 <filename>dists/testing</filename>), and <literal>unstable</literal>
623 (residing in <filename>dists/unstable</filename>).  This reflects the
624 development process of the Debian project.
625 </para>
626 <para>
627 Active development is done in the <literal>unstable</literal> distribution
628 (that's why this distribution is sometimes called the <literal>development
629 distribution</literal>).  Every Debian developer can update his or her
630 packages in this distribution at any time.  Thus, the contents of this
631 distribution change from day to day.  Since no special effort is made to make
632 sure everything in this distribution is working properly, it is sometimes
633 literally unstable.
634 </para>
635 <para>
636 The <link linkend="testing">testing</link> distribution is generated
637 automatically by taking packages from <literal>unstable</literal> if they
638 satisfy certain criteria.  Those criteria should ensure a good quality for
639 packages within <literal>testing</literal>.  The update to
640 <literal>testing</literal> is launched twice each day, right  after the new
641 packages have been installed.  See <xref linkend="testing"/>.
642 </para>
643 <para>
644 After a period of development, once the release manager deems fit, the
645 <literal>testing</literal> distribution is frozen, meaning that the policies
646 which control how packages move from <literal>unstable</literal> to
647 <literal>testing</literal> are tightened.  Packages which are too buggy are
648 removed.  No changes are allowed into <literal>testing</literal> except for
649 bug fixes.  After some time has elapsed, depending on progress, the
650 <literal>testing</literal> distribution is frozen even further.  Details of
651 the handling of the testing distribution are published by the Release Team on
652 debian-devel-announce.  After the open issues are solved to the satisfaction of
653 the Release Team, the distribution is released.  Releasing means that
654 <literal>testing</literal> is renamed to <literal>stable</literal>, and a
655 new copy is created for the new <literal>testing</literal>, and the previous
656 <literal>stable</literal> is renamed to <literal>oldstable</literal> and
657 stays there until it is finally archived.  On archiving, the contents are moved
658 to <literal>&archive-host;</literal>.
659 </para>
660 <para>
661 This development cycle is based on the assumption that the
662 <literal>unstable</literal> distribution becomes <literal>stable</literal>
663 after passing a period of being in <literal>testing</literal>.  Even once a
664 distribution is considered stable, a few bugs inevitably remain — that's why
665 the stable distribution is updated every now and then.  However, these updates
666 are tested very carefully and have to be introduced into the archive
667 individually to reduce the risk of introducing new bugs.  You can find proposed
668 additions to <literal>stable</literal> in the
669 <filename>proposed-updates</filename> directory.  Those packages in
670 <filename>proposed-updates</filename> that pass muster are periodically moved
671 as a batch into the stable distribution and the revision level of the stable
672 distribution is incremented (e.g., ‘6.0’ becomes ‘6.0.1’, ‘5.0.7’
673 becomes ‘5.0.8’, and so forth).  Please refer to
674 <link linkend="upload-stable">uploads to the <literal>stable</literal>
675 distribution</link> for details.
676 </para>
677 <para>
678 Note that development under <literal>unstable</literal> continues during the
679 freeze period, since the <literal>unstable</literal> distribution remains in
680 place in parallel with <literal>testing</literal>.
681 </para>
682 </section>
683
684 <section id="s4.6.4.2">
685 <title>More information about the testing distribution</title>
686 <para>
687 Packages are usually installed into the <literal>testing</literal> distribution
688 after they have undergone some degree of testing in <literal>unstable</literal>.
689 </para>
690 <para>
691 For more details, please see the <link linkend="testing">information about
692 the testing distribution</link>.
693 </para>
694 </section>
695
696 <section id="experimental">
697 <title>Experimental</title>
698 <para>
699 The <literal>experimental</literal> distribution is a special distribution.
700 It is not a full distribution in the same sense as <literal>stable</literal>,
701 <literal>testing</literal> and <literal>unstable</literal> are.
702 Instead, it is meant to be a temporary staging area for highly experimental
703 software where there's a good chance that the software could break your system,
704 or software that's just too unstable even for the <literal>unstable</literal>
705 distribution (but there is a reason to package it nevertheless).  Users who
706 download and install packages from <literal>experimental</literal> are
707 expected to have been duly warned.  In short, all bets are off for the
708 <literal>experimental</literal> distribution.
709 </para>
710 <para>
711 These are the <citerefentry> <refentrytitle>sources.list</refentrytitle>
712 <manvolnum>5</manvolnum> </citerefentry> lines for
713 <literal>experimental</literal>:
714 </para>
715 <programlisting>
716 deb http://ftp.<replaceable>xy</replaceable>.debian.org/debian/ experimental main
717 deb-src http://ftp.<replaceable>xy</replaceable>.debian.org/debian/ experimental main
718 </programlisting>
719 <para>
720 If there is a chance that the software could do grave damage to a system, it is
721 likely to be better to put it into <literal>experimental</literal>.  For
722 instance, an experimental compressed file system should probably go into
723 <literal>experimental</literal>.
724 </para>
725 <para>
726 Whenever there is a new upstream version of a package that introduces new
727 features but breaks a lot of old ones, it should either not be uploaded, or be
728 uploaded to <literal>experimental</literal>.  A new, beta, version of some
729 software which uses a completely different configuration can go into
730 <literal>experimental</literal>, at the maintainer's discretion.  If you are
731 working on an incompatible or complex upgrade situation, you can also use
732 <literal>experimental</literal> as a staging area, so that testers can get
733 early access.
734 </para>
735 <para>
736 Some experimental software can still go into <literal>unstable</literal>,
737 with a few warnings in the description, but that isn't recommended because
738 packages from <literal>unstable</literal> are expected to propagate to
739 <literal>testing</literal> and thus to <literal>stable</literal>.  You
740 should not be afraid to use <literal>experimental</literal> since it does not
741 cause any pain to the ftpmasters, the experimental packages are periodically
742 removed once you upload the package in <literal>unstable</literal> with a
743 higher version number.
744 </para>
745 <para>
746 New software which isn't likely to damage your system can go directly into
747 <literal>unstable</literal>.
748 </para>
749 <para>
750 An alternative to <literal>experimental</literal> is to use your personal web
751 space on <literal>people.debian.org</literal>.
752 </para>
753 </section>
754
755 </section>
756
757 <section id="codenames">
758 <title>Release code names</title>
759 <para>
760 Every released Debian distribution has a <literal>code name</literal>: Debian
761 1.1 is called <literal>buzz</literal>; Debian 1.2, <literal>rex</literal>;
762 Debian 1.3, <literal>bo</literal>; Debian 2.0, <literal>hamm</literal>;
763 Debian 2.1, <literal>slink</literal>; Debian 2.2, <literal>potato</literal>;
764 Debian 3.0, <literal>woody</literal>; Debian 3.1, <literal>sarge</literal>;
765 Debian 4.0, <literal>etch</literal>; Debian 5.0, <literal>lenny</literal>
766 and the next release will be called <literal>wheezy</literal>.
767 There is also a ``pseudo-distribution'', called
768 <literal>sid</literal>, which is the current <literal>unstable</literal>
769 distribution; since packages are moved from <literal>unstable</literal> to
770 <literal>testing</literal> as they approach stability, <literal>sid</literal>
771 itself is never released.  As well as the usual contents of a Debian
772 distribution, <literal>sid</literal> contains packages for architectures which
773 are not yet officially supported or released by Debian.  These architectures
774 are planned to be integrated into the mainstream distribution at some future
775 date.
776 </para>
777 <para>
778 Since Debian has an open development model (i.e., everyone can participate and
779 follow the development) even the <literal>unstable</literal> and <literal>
780 testing</literal> distributions are distributed to the Internet through the
781 Debian FTP and HTTP server network. Thus, if we had called the directory which
782 contains the release candidate version <literal>testing</literal>, then we
783 would have to rename it to <literal>stable</literal> when the version
784 is released, which would cause all FTP mirrors to re-retrieve the whole
785 distribution (which is quite large).
786 </para>
787 <para>
788 On the other hand, if we called the distribution directories
789 <literal>Debian-x.y</literal> from the beginning, people would think that
790 Debian release <literal>x.y</literal> is available.  (This happened in the
791 past, where a CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0
792 development version.  That's the reason why the first official Debian release
793 was 1.1, and not 1.0.)
794 </para>
795 <para>
796 Thus, the names of the distribution directories in the archive are determined
797 by their code names and not their release status (e.g., `squeeze'). These names
798 stay the same during the development period and after the release; symbolic
799 links, which can be changed easily, indicate the currently released stable
800 distribution.  That's why the real distribution directories use the
801 <literal>code names</literal>, while symbolic links for
802 <literal>stable</literal>, <literal>testing</literal>, and
803 <literal>unstable</literal> point to the appropriate release directories.
804 </para>
805 </section>
806
807 </section>
808
809 <section id="mirrors">
810 <title>Debian mirrors</title>
811 <para>
812 The various download archives and the web site have several mirrors available
813 in order to relieve our canonical servers from heavy load.  In fact, some of
814 the canonical servers aren't public — a first tier of mirrors balances the
815 load instead.  That way, users always access the mirrors and get used to using
816 them, which allows Debian to better spread its bandwidth requirements over
817 several servers and networks, and basically makes users avoid hammering on one
818 primary location.  Note that the first tier of mirrors is as up-to-date as it
819 can be since they update when triggered from the internal sites (we call this
820 push mirroring).
821 </para>
822 <para>
823 All the information on Debian mirrors, including a list of the available public
824 FTP/HTTP servers, can be found at <ulink
825 url="&url-debian-mirrors;"></ulink>.  This useful page also
826 includes information and tools which can be helpful if you are interested in
827 setting up your own mirror, either for internal or public access.
828 </para>
829 <para>
830 Note that mirrors are generally run by third-parties who are interested in
831 helping Debian.  As such, developers generally do not have accounts on these
832 machines.
833 </para>
834 </section>
835
836 <section id="incoming-system">
837 <title>The Incoming system</title>
838 <para>
839 The Incoming system is responsible for collecting updated packages and
840 installing them in the Debian archive.  It consists of a set of directories and
841 scripts that are installed on <literal>&ftp-master-host;</literal>.
842 </para>
843 <para>
844 Packages are uploaded by all the maintainers into a directory called
845 <filename>UploadQueue</filename>.  This directory is scanned every few minutes
846 by a daemon called <command>queued</command>,
847 <filename>*.command</filename>-files are executed, and remaining and correctly
848 signed <filename>*.changes</filename>-files are moved together with their
849 corresponding files to the <filename>unchecked</filename> directory.  This
850 directory is not visible for most Developers, as ftp-master is restricted; it
851 is scanned every 15 minutes by the <command>dak process-upload</command> script,
852 which verifies the integrity of the uploaded packages and their cryptographic
853 signatures.  If the package is considered ready to be installed, it is moved
854 into the <filename>done</filename> directory.  If this is the first upload
855 of the package (or it has new binary packages), it is moved to the
856 <filename>new</filename> directory, where it waits for approval by the
857 ftpmasters.  If the package contains files to be installed by hand it is moved
858 to the <filename>byhand</filename> directory, where it waits for manual
859 installation by the ftpmasters.  Otherwise, if any error has been detected, the
860 package is refused and is moved to the <filename>reject</filename> directory.
861 </para>
862 <para>
863 Once the package is accepted, the system sends a confirmation mail to the
864 maintainer and closes all the bugs marked as fixed by the upload, and the
865 auto-builders may start recompiling it.  The package is now publicly accessible
866 at <ulink url="&url-incoming;"></ulink> until it is really
867 installed in the Debian archive.  This happens four times a day (and is also
868 called the `dinstall run' for historical reasons); the package is then removed
869 from incoming and installed in the pool along with all the other packages.
870 Once all the other updates (generating new <filename>Packages</filename> and
871 <filename>Sources</filename> index files for example) have been made, a special
872 script is called to ask all the primary mirrors to update themselves.
873 </para>
874 <para>
875 The archive maintenance software will also send the OpenPGP/GnuPG signed
876 <filename>.changes</filename> file that you uploaded to the appropriate mailing
877 lists.  If a package is released with the <literal>Distribution</literal> set
878 to <literal>stable</literal>, the announcement is sent to
879 &email-debian-changes;.  If a package is released with
880 <literal>Distribution</literal> set to <literal>unstable</literal> or
881 <literal>experimental</literal>, the announcement will be posted to
882 &email-debian-devel-changes; instead.
883 </para>
884 <para>
885 Though ftp-master is restricted, a copy of the installation is available to all
886 developers on <literal>&ftp-master-mirror;</literal>.
887 </para>
888 <!-- FIXME: delete it or keep it for historical purposes?
889 <para>
890 All Debian developers have write access to the <filename>unchecked</filename>
891 directory in order to upload their packages; they also have that access
892 to the <filename>reject</filename> directory in order to remove their bad uploads
893 or to move some files back to the <filename>unchecked</filename> directory. But
894 all the other directories are only writable by the ftpmasters, which is
895 why you cannot remove an upload once it has been accepted.
896 </para>
897
898 <section id="delayed-incoming-broken">
899 <title>Delayed incoming</title>
900 <para>
901 <emphasis>Note:</emphasis> This description here is currently not working, because
902 ftp-master is restricted. Please see <xref linkend="delayed-incoming"/> for
903 the currently working way.
904 </para>
905 <para>
906 The <filename>unchecked</filename> directory has a special <filename>DELAYED</filename>
907 subdirectory. It is itself subdivided in nine directories
908 called <filename>1-day</filename> to <filename>9-day</filename>. Packages which are uploaded to
909 one of those directories will be moved to the real unchecked
910 directory after the corresponding number of days.
911 This is done by a script which is run each day and which moves the
912 packages between the directories. Those which are in "1-day" are
913 installed in <filename>unchecked</filename> while the others are moved to the
914 adjacent directory (for example, a package in <filename>5-day</filename> will
915 be moved to <filename>4-day</filename>). This feature is particularly useful
916 for people who are doing non-maintainer uploads. Instead of
917 waiting before uploading a NMU, it is uploaded as soon as it is
918 ready, but to one of those <filename>DELAYED/<varname>x</varname>-day</filename> directories.
919 That leaves the corresponding number of days for the maintainer
920 to react and upload another fix themselves if they are not
921 completely satisfied with the NMU. Alternatively they can remove
922 the NMU.
923 </para>
924 <para>
925 The use of that delayed feature can be simplified with a bit
926 of integration with your upload tool.  For instance, if you use
927 <command>dupload</command> (see <xref linkend="dupload"/>), you can add this
928 snippet to your configuration file:
929 <programlisting>
930 $delay = ($ENV{DELAY} || 7);
931 $cfg{'delayed'} = {
932          fqdn => "&ftp-upload-host;",
933          login => "yourdebianlogin",
934          incoming => "/org/&ftp-debian-org;/incoming/DELAYED/$delay-day/",
935          dinstall_runs => 1,
936          method => "scpb"
937 };
938 </programlisting>
939 Once you've made that change, <command>dupload</command> can be used to
940 easily upload a package in one of the delayed directories:
941 <literal>DELAY=5 dupload -X-to delayed &lt;changes-file&gt;</literal>
942 </para>
943 </section>
944 -->
945 </section>
946
947 <section id="pkg-info">
948 <title>Package information</title>
949 <section id="pkg-info-web">
950 <title>On the web</title>
951 <para>
952 Each package has several dedicated web pages.
953 <literal>http://&packages-host;/<replaceable>package-name</replaceable></literal>
954 displays each version of the package available in the various distributions.
955 Each version links to a page which provides information, including the package
956 description, the dependencies, and package download links.
957 </para>
958 <para>
959 The bug tracking system tracks bugs for each package.  You can view the bugs of
960 a given package at the URL
961 <literal>http://&bugs-host;/<replaceable>package-name</replaceable></literal>.
962 </para>
963 </section>
964
965 <section id="dak-ls">
966 <title>The <command>dak ls</command> utility</title>
967 <para>
968 <command>dak ls</command> is part of the dak suite of tools, listing
969 available package versions for all known distributions and architectures.
970 The <command>dak</command> tool is available on
971 <literal>&ftp-master-host;</literal>, and on the mirror on
972 <literal>&ftp-master-mirror;</literal>.  It uses a single argument
973 corresponding to a package name. An example will explain it better:
974 </para>
975 <screen>
976 $ dak ls evince
977 evince | 0.1.5-2sarge1 |     oldstable | source, alpha, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
978 evince |    0.4.0-5 |     etch-m68k | source, m68k
979 evince |    0.4.0-5 |        stable | source, alpha, amd64, arm, hppa, i386, ia64, mips, mipsel, powerpc, s390, sparc
980 evince |   2.20.2-1 |       testing | source
981 evince | 2.20.2-1+b1 |       testing | alpha, amd64, arm, armel, hppa, i386, ia64, mips, mipsel, powerpc, s390, sparc
982 evince |   2.22.2-1 |      unstable | source, alpha, amd64, arm, armel, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
983 </screen>
984 <para>
985 In this example, you can see that the version in <literal>unstable</literal>
986 differs from the version in <literal>testing</literal> and that there has
987 been a binary-only NMU of the package for all architectures.  Each version
988 of the package has been recompiled on all architectures.
989 </para>
990 </section>
991
992 </section>
993
994 <section id="pkg-tracking-system">
995 <title>The Package Tracking System</title>
996 <para>
997 The Package Tracking System (PTS) is an email-based tool to track the activity
998 of a source package.  This really means that you can get the same emails that
999 the package maintainer gets, simply by subscribing to the package in the PTS.
1000 </para>
1001 <para>
1002 Each email sent through the PTS is classified under one of the keywords listed
1003 below.  This will let you select the mails that you want to receive.
1004 </para>
1005 <para>
1006 By default you will get:
1007 </para>
1008 <variablelist>
1009 <varlistentry>
1010 <term><literal>bts</literal></term>
1011 <listitem>
1012 <para>
1013 All the bug reports and following discussions.
1014 </para>
1015 </listitem>
1016 </varlistentry>
1017 <varlistentry>
1018 <term><literal>bts-control</literal></term>
1019 <listitem>
1020 <para>
1021 The email notifications from <email>control@&bugs-host;</email> about bug
1022 report status changes.
1023 </para>
1024 </listitem>
1025 </varlistentry>
1026 <varlistentry>
1027 <term><literal>upload-source</literal></term>
1028 <listitem>
1029 <para>
1030 The email notification from <command>dak</command> when an uploaded source
1031 package is accepted.
1032 </para>
1033 </listitem>
1034 </varlistentry>
1035 <varlistentry>
1036 <term><literal>katie-other</literal></term>
1037 <listitem>
1038 <para>
1039 Other warning and error emails from <command>dak</command> (such as an
1040 override disparity for the section and/or the priority field).
1041 </para>
1042 </listitem>
1043 </varlistentry>
1044 <varlistentry>
1045 <term><literal>buildd</literal></term>
1046 <listitem>
1047 <para>
1048 Build failures notifications sent by the network of build daemons, they contain
1049 a pointer to the build logs for analysis.
1050 </para>
1051 </listitem>
1052 </varlistentry>
1053 <varlistentry>
1054 <term><literal>default</literal></term>
1055 <listitem>
1056 <para>
1057 Any non-automatic email sent to the PTS by people who wanted to contact the
1058 subscribers of the package.  This can be done by sending mail to
1059 <literal><replaceable>sourcepackage</replaceable>@&pts-host;</literal>.
1060 In order to prevent spam, all messages sent to these addresses must contain the
1061 <literal>X-PTS-Approved</literal> header with a non-empty value.
1062 </para>
1063 </listitem>
1064 </varlistentry>
1065 <varlistentry>
1066 <term><literal>contact</literal></term>
1067 <listitem>
1068 <para>
1069 Mails sent to the maintainer through the *@packages.debian.org email
1070 aliases.
1071 </para>
1072 </listitem>
1073 </varlistentry>
1074 <varlistentry>
1075 <term><literal>summary</literal></term>
1076 <listitem>
1077 <para>
1078 Regular summary emails about the package's status, including progression
1079 into <literal>testing</literal>,
1080 <ulink url="&url-dehs;">DEHS</ulink> notifications of
1081 new upstream versions, and a notification if the package is removed or
1082 orphaned.
1083 </para>
1084 </listitem>
1085 </varlistentry>
1086 </variablelist>
1087 <para>
1088 You can also decide to receive additional information:
1089 </para>
1090 <variablelist>
1091 <varlistentry>
1092 <term><literal>upload-binary</literal></term>
1093 <listitem>
1094 <para>
1095 The email notification from <command>katie</command> when an uploaded binary
1096 package is accepted.  In other words, whenever a build daemon or a porter
1097 uploads your package for another architecture, you can get an email to track
1098 how your package gets recompiled for all architectures.
1099 </para>
1100 </listitem>
1101 </varlistentry>
1102 <varlistentry>
1103 <term><literal>cvs</literal></term>
1104 <listitem>
1105 <para>
1106 VCS commit notifications, if the package has a VCS repository and the
1107 maintainer has set up forwarding of commit notifications to the PTS. The
1108 "cvs" name is historic, in most cases commit notifications will come
1109 from some other VCS like subversion or git.
1110 </para>
1111 </listitem>
1112 </varlistentry>
1113 <varlistentry>
1114 <term><literal>ddtp</literal></term>
1115 <listitem>
1116 <para>
1117 Translations of descriptions or debconf templates submitted to the Debian
1118 Description Translation Project.
1119 </para>
1120 </listitem>
1121 </varlistentry>
1122 <varlistentry>
1123 <term><literal>derivatives</literal></term>
1124 <listitem>
1125 <para>
1126 Information about changes made to the package in derivative distributions (for
1127 example Ubuntu).
1128 </para>
1129 </listitem>
1130 </varlistentry>
1131 <varlistentry>
1132 <term><literal>derivatives-bugs</literal></term>
1133 <listitem>
1134 <para>
1135 Bugs reports and comments from derivative distributions (for example Ubuntu).
1136 </para>
1137 </listitem>
1138 </varlistentry>
1139 </variablelist>
1140 <section id="pts-commands">
1141 <title>The PTS email interface</title>
1142 <para>
1143 You can control your subscription(s) to the PTS by sending various commands to
1144 <email>pts@qa.debian.org</email>.
1145 </para>
1146 <variablelist>
1147 <varlistentry>
1148 <term><literal>subscribe &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1149 <listitem>
1150 <para>
1151 Subscribes <replaceable>email</replaceable> to communications related to the
1152 source package <replaceable>sourcepackage</replaceable>.  Sender address is
1153 used if the second argument is not present.  If
1154 <replaceable>sourcepackage</replaceable> is not a valid source package, you'll
1155 get a warning.  However if it's a valid binary package, the PTS will subscribe
1156 you to the corresponding source package.
1157 </para>
1158 </listitem>
1159 </varlistentry>
1160 <varlistentry>
1161 <term><literal>unsubscribe &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1162 <listitem>
1163 <para>
1164 Removes a previous subscription to the source package
1165 <replaceable>sourcepackage</replaceable> using the specified email address or
1166 the sender address if the second argument is left out.
1167 </para>
1168 </listitem>
1169 </varlistentry>
1170 <varlistentry>
1171 <term><literal>unsubscribeall [&lt;email&gt;]</literal></term>
1172 <listitem>
1173 <para>
1174 Removes all subscriptions of the specified email address or the sender address
1175 if the second argument is left out.
1176 </para>
1177 </listitem>
1178 </varlistentry>
1179 <varlistentry>
1180 <term><literal>which [&lt;email&gt;]</literal></term>
1181 <listitem>
1182 <para>
1183 Lists all subscriptions for the sender or the email address optionally
1184 specified.
1185 </para>
1186 </listitem>
1187 </varlistentry>
1188 <varlistentry>
1189 <term><literal>keyword [&lt;email&gt;]</literal></term>
1190 <listitem>
1191 <para>
1192 Tells you the keywords that you are accepting.  For an explanation of keywords,
1193 <link linkend="pkg-tracking-system">see above</link>.  Here's a quick
1194 summary:
1195 </para>
1196 <itemizedlist>
1197 <listitem>
1198 <para>
1199 <literal>bts</literal>: mails coming from the Debian Bug Tracking System
1200 </para>
1201 </listitem>
1202 <listitem>
1203 <para>
1204 <literal>bts-control</literal>: reply to mails sent to
1205 &email-bts-control;
1206 </para>
1207 </listitem>
1208 <listitem>
1209 <para>
1210 <literal>summary</literal>: automatic summary mails about the state of a
1211 package
1212 </para>
1213 </listitem>
1214 <listitem>
1215 <para>
1216 <literal>contact</literal>: mails sent to the maintainer through the
1217 *@packages.debian.org aliases
1218 </para>
1219 </listitem>
1220 <listitem>
1221 <para>
1222 <literal>cvs</literal>: notification of VCS commits
1223 </para>
1224 </listitem>
1225 <listitem>
1226 <para>
1227 <literal>ddtp</literal>: translations of descriptions and debconf templates
1228 </para>
1229 </listitem>
1230 <listitem>
1231 <para>
1232 <literal>derivatives</literal>: changes made on the package by derivative
1233 distributions
1234 </para>
1235 </listitem>
1236 <listitem>
1237 <para>
1238 <literal>derivatives-bugs</literal>: bugs reports and comments from derivative
1239 distributions
1240 </para>
1241 </listitem>
1242 <listitem>
1243 <para>
1244 <literal>upload-source</literal>: announce of a new source upload that has been
1245 accepted
1246 </para>
1247 </listitem>
1248 <listitem>
1249 <para>
1250 <literal>upload-binary</literal>: announce of a new binary-only upload
1251 (porting)
1252 </para>
1253 </listitem>
1254 <listitem>
1255 <para>
1256 <literal>katie-other</literal>: other mails from ftpmasters (override
1257 disparity, etc.)
1258 </para>
1259 </listitem>
1260 <listitem>
1261 <para>
1262 <literal>buildd</literal>: build failures notifications from build daemons
1263 </para>
1264 </listitem>
1265 <listitem>
1266 <para>
1267 <literal>default</literal>: all the other mails (those which aren't automatic)
1268 </para>
1269 </listitem>
1270 </itemizedlist>
1271 </listitem>
1272 </varlistentry>
1273 <varlistentry>
1274 <term><literal>keyword &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1275 <listitem>
1276 <para>
1277 Same as the previous item but for the given source package, since you may
1278 select a different set of keywords for each source package.
1279 </para>
1280 </listitem>
1281 </varlistentry>
1282 <varlistentry>
1283 <term><literal>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1284 <listitem>
1285 <para>
1286 Accept (+) or refuse (-) mails classified under the given keyword(s).  Define
1287 the list (=) of accepted keywords.  This changes the default set of keywords
1288 accepted by a user.
1289 </para>
1290 </listitem>
1291 </varlistentry>
1292 <varlistentry>
1293 <term><literal>keywordall [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1294 <listitem>
1295 <para>
1296 Accept (+) or refuse (-) mails classified under the given keyword(s).  Define
1297 the list (=) of accepted keywords.  This changes the set of accepted keywords
1298 of all the currently active subscriptions of a user.
1299 </para>
1300 </listitem>
1301 </varlistentry>
1302 <varlistentry>
1303 <term><literal>keyword &lt;sourcepackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1304 <listitem>
1305 <para>
1306 Same as previous item but overrides the keywords list for the indicated source
1307 package.
1308 </para>
1309 </listitem>
1310 </varlistentry>
1311 <varlistentry>
1312 <term><literal>quit | thanks | --</literal></term>
1313 <listitem>
1314 <para>
1315 Stops processing commands.  All following lines are ignored by the bot.
1316 </para>
1317 </listitem>
1318 </varlistentry>
1319 </variablelist>
1320 <para>
1321 The <command>pts-subscribe</command> command-line utility (from the <systemitem
1322 role="package">devscripts</systemitem> package) can be handy to temporarily
1323 subscribe to some packages, for example after having made an non-maintainer
1324 upload.
1325 </para>
1326 </section>
1327
1328 <section id="pts-mail-filtering">
1329 <title>Filtering PTS mails</title>
1330 <para>
1331 Once you are subscribed to a package, you will get the mails sent to
1332 <literal><replaceable>sourcepackage</replaceable>@&pts-host;</literal>.
1333 Those mails have special headers appended to let you filter them in a special
1334 mailbox (e.g.  with <command>procmail</command>).  The added headers are
1335 <literal>X-Loop</literal>, <literal>X-PTS-Package</literal>,
1336 <literal>X-PTS-Keyword</literal> and <literal>X-Unsubscribe</literal>.
1337 </para>
1338 <para>
1339 Here is an example of added headers for a source upload notification on the
1340 <systemitem role="package">dpkg</systemitem> package:
1341 </para>
1342 <screen>
1343 X-Loop: dpkg@&pts-host;
1344 X-PTS-Package: dpkg
1345 X-PTS-Keyword: upload-source
1346 List-Unsubscribe: &lt;mailto:pts@qa.debian.org?body=unsubscribe+dpkg&gt;
1347 </screen>
1348 </section>
1349
1350 <section id="pts-vcs-commit">
1351 <title>Forwarding VCS commits in the PTS</title>
1352 <para>
1353 If you use a publicly accessible VCS repository for maintaining your Debian
1354 package, you may want to forward the commit notification to the PTS so that the
1355 subscribers (and possible co-maintainers) can closely follow the package's
1356 evolution.
1357 </para>
1358 <para>
1359 Once you set up the VCS repository to generate commit notifications, you just
1360 have to make sure it sends a copy of those mails to
1361 <literal><replaceable>sourcepackage</replaceable>_cvs@&pts-host;</literal>.
1362 Only the people who accept the <literal>cvs</literal> keyword will receive
1363 these notifications. Note that the mail needs to be sent from a
1364 <literal>debian.org</literal> machine, otherwise you'll have to add
1365 the <literal>X-PTS-Approved: 1</literal> header.
1366 </para>
1367 <para>
1368 For Subversion repositories, the usage of svnmailer is recommended.
1369 See <ulink url="&url-alioth-pkg;" /> for an example on how to do it.
1370 </para>
1371 </section>
1372
1373 <section id="pts-web">
1374 <title>The PTS web interface</title>
1375 <para>
1376 The PTS has a web interface at <ulink
1377 url="http://&pts-host;/"></ulink> that puts together a lot of
1378 information about each source package.  It features many useful links (BTS, QA
1379 stats, contact information, DDTP translation status, buildd logs) and gathers
1380 much more information from various places (30 latest changelog entries, testing
1381 status, etc.).  It's a very useful tool if you want to know what's going on with
1382 a specific source package.  Furthermore there's a form that allows easy
1383 subscription to the PTS via email.
1384 </para>
1385 <para>
1386 You can jump directly to the web page concerning a specific source package with
1387 a URL like
1388 <literal>http://&pts-host;/<replaceable>sourcepackage</replaceable></literal>.
1389 </para>
1390 <para>
1391 This web interface has been designed like a portal for the development of
1392 packages: you can add custom content on your packages' pages.  You can add
1393 static information (news items that are meant to stay available indefinitely)
1394 and news items in the latest news section.
1395 </para>
1396 <para>
1397 Static news items can be used to indicate:
1398 </para>
1399 <itemizedlist>
1400 <listitem>
1401 <para>
1402 the availability of a project hosted on
1403 <link linkend="alioth">Alioth</link> for co-maintaining the package
1404 </para>
1405 </listitem>
1406 <listitem>
1407 <para>
1408 a link to the upstream web site
1409 </para>
1410 </listitem>
1411 <listitem>
1412 <para>
1413 a link to the upstream bug tracker
1414 </para>
1415 </listitem>
1416 <listitem>
1417 <para>
1418 the existence of an IRC channel dedicated to the software
1419 </para>
1420 </listitem>
1421 <listitem>
1422 <para>
1423 any other available resource that could be useful in the maintenance of the
1424 package
1425 </para>
1426 </listitem>
1427 </itemizedlist>
1428 <para>
1429 Usual news items may be used to announce that:
1430 </para>
1431 <itemizedlist>
1432 <listitem>
1433 <para>
1434 beta packages are available for testing
1435 </para>
1436 </listitem>
1437 <listitem>
1438 <para>
1439 final packages are expected for next week
1440 </para>
1441 </listitem>
1442 <listitem>
1443 <para>
1444 the packaging is about to be redone from scratch
1445 </para>
1446 </listitem>
1447 <listitem>
1448 <para>
1449 backports are available
1450 </para>
1451 </listitem>
1452 <listitem>
1453 <para>
1454 the maintainer is on vacation (if they wish to publish this information)
1455 </para>
1456 </listitem>
1457 <listitem>
1458 <para>
1459 a NMU is being worked on
1460 </para>
1461 </listitem>
1462 <listitem>
1463 <para>
1464 something important will affect the package
1465 </para>
1466 </listitem>
1467 </itemizedlist>
1468 <para>
1469 Both kinds of news are generated in a similar manner: you just have to send an
1470 email either to <email>pts-static-news@qa.debian.org</email> or to
1471 <email>pts-news@qa.debian.org</email>.  The mail should indicate which package
1472 is concerned by having the name of the source package in a
1473 <literal>X-PTS-Package</literal> mail header or in a <literal>Package</literal>
1474 pseudo-header (like the BTS reports).  If a URL is available in the
1475 <literal>X-PTS-Url</literal> mail header or in the <literal>Url</literal>
1476 pseudo-header, then the result is a link to that URL instead of a complete news
1477 item.
1478 </para>
1479 <para>
1480 Here are a few examples of valid mails used to generate news items in the PTS.
1481 The first one adds a link to the viewsvn interface of debian-cd in the Static
1482 information section:
1483 </para>
1484 <screen>
1485 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
1486 To: pts-static-news@qa.debian.org
1487 Subject: Browse debian-cd SVN repository
1488
1489 Package: debian-cd
1490 Url: http://svn.debian.org/viewsvn/debian-cd/trunk/
1491 </screen>
1492 <para>
1493 The second one is an announcement sent to a mailing list which is also sent to
1494 the PTS so that it is published on the PTS web page of the package.  Note the
1495 use of the BCC field to avoid answers sent to the PTS by mistake.
1496 </para>
1497 <screen>
1498 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
1499 To: debian-gtk-gnome@&lists-host;
1500 Bcc: pts-news@qa.debian.org
1501 Subject: Galeon 2.0 backported for woody
1502 X-PTS-Package: galeon
1503
1504 Hello gnomers!
1505
1506 I'm glad to announce that galeon has been backported for woody. You'll find
1507 everything here:
1508 ...
1509 </screen>
1510 <para>
1511 Think twice before adding a news item to the PTS because you won't be able to
1512 remove it later and you won't be able to edit it either.  The only thing that
1513 you can do is send a second news item that will deprecate the information
1514 contained in the previous one.
1515 </para>
1516 </section>
1517
1518 </section>
1519
1520 <section id="ddpo">
1521 <title>Developer's packages overview</title>
1522 <para>
1523 A QA (quality assurance) web portal is available at <ulink
1524 url="&url-ddpo;"></ulink> which displays a table listing all
1525 the packages of a single developer (including those where the party is listed
1526 as a co-maintainer).  The table gives a good summary about the developer's
1527 packages: number of bugs by severity, list of available versions in each
1528 distribution, testing status and much more including links to any other useful
1529 information.
1530 </para>
1531 <para>
1532 It is a good idea to look up your own data regularly so that you don't forget
1533 any open bugs, and so that you don't forget which packages are your
1534 responsibility.
1535 </para>
1536 </section>
1537
1538 <section id="alioth">
1539 <title>Debian's FusionForge installation: Alioth</title>
1540 <para>
1541 Alioth is a Debian service based on a slightly modified version of the
1542 FusionForge software (which evolved from SourceForge and GForge). This software offers
1543 developers access to easy-to-use tools such as bug trackers, patch
1544 manager, project/task managers, file hosting services, mailing lists, VCS
1545 repositories etc.  All these tools are managed via a web interface.
1546 </para>
1547 <para>
1548 It is intended to provide facilities to free software projects backed or led by
1549 Debian, facilitate contributions from external developers to projects started
1550 by Debian, and help projects whose goals are the promotion of Debian or its
1551 derivatives. It's heavily used by many Debian teams and provides
1552 hosting for all sorts of VCS repositories.
1553 </para>
1554 <para>
1555 All Debian developers automatically have an account on Alioth.  They can
1556 activate it by using the recover password facility.  External developers can
1557 request guest accounts on Alioth.
1558 </para>
1559 <para>
1560 For more information please visit the following links:
1561 </para>
1562 <itemizedlist>
1563 <listitem><para><ulink url="&url-alioth-wiki;" /></para></listitem>
1564 <listitem><para><ulink url="&url-alioth-faq;" /></para></listitem>
1565 <listitem><para><ulink url="&url-alioth-pkg;" /></para></listitem>
1566 <listitem><para><ulink url="&url-alioth;" /></para></listitem>
1567 </itemizedlist>
1568 </section>
1569
1570 <section id="developer-misc">
1571 <title>Goodies for Developers</title>
1572 <section id="lwn">
1573 <title>LWN Subscriptions</title>
1574 <para>
1575 Since October of 2002, HP has sponsored a subscription to LWN for all
1576 interested Debian developers.  Details on how to get access to this benefit are
1577 in <ulink
1578 url="http://&lists-host;/debian-devel-announce/2002/10/msg00018.html"></ulink>.
1579 </para>
1580 </section>
1581 <section id="gandi">
1582 <title>Gandi.net Hosting Discount</title>
1583 <para>
1584 As of November 2008, Gandi.net offers a discount rate on their VPS
1585 hosting for Debian Developers.  See
1586 <ulink url="http://&lists-host;/debian-devel-announce/2008/11/msg00004.html"></ulink>.
1587 </para>
1588 </section>
1589
1590 </section>
1591
1592 </chapter>
1593