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