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