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