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