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 and Debian Maintainers</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="https://&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="https://&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; it will typically have a minimum of 150 people
145 at any time of day.
146 It's a channel for people who work on Debian, it's not a support channel
147 (there's <literal>#debian</literal> for that).  It is however open to anyone
148 who wants to lurk (and learn).  Its topic is commonly full of interesting
149 information for developers.
150 </para>
151 <para>
152 Since <literal>#debian-devel</literal> is an open channel, you should not
153 speak there of issues that are discussed in
154 &email-debian-private;.  There's another channel for this
155 purpose, it's called <literal>#debian-private</literal> and it's protected by
156 a key.  This key is available at
157 <filename>;</filename>.
158 </para>
159 <para>
160 There are other additional channels dedicated to specific subjects.
161 <literal>#debian-bugs</literal> is used for coordinating bug squashing
162 parties.  <literal>#debian-boot</literal> is used to coordinate the work on
163 the debian-installer.  <literal>#debian-doc</literal> is occasionally used to
164 talk about documentation, like the document you are reading.  Other channels
165 are dedicated to an architecture or a set of packages:
166 <literal>#debian-kde</literal>, <literal>#debian-dpkg</literal>,
167 <literal>#debian-jr</literal>, <literal>#debian-edu</literal>,
168 <literal>#debian-oo</literal> ( package)...
169 </para>
170 <para>
171 Some non-English developers' channels exist as well, for example
172 <literal>#debian-devel-fr</literal> for French speaking people interested in
173 Debian's development.
174 </para>
175 <para>
176 Channels dedicated to Debian also exist on other IRC networks, notably on the
177 <ulink url="&url-openprojects;">freenode</ulink> IRC network,
178 which was pointed at by the <literal></literal> alias until 4th
179 June 2006.
180 </para>
181 <para>
182 To get a cloak on freenode, you send Jörg Jaspert &lt;; a
183 signed mail where you tell what your nick is.  Put cloak somewhere in the
184 Subject: header.  The nick should be registered: <ulink
185 url="">Nick Setup Page</ulink>.  The
186 mail needs to be signed by a key in the Debian keyring.  Please see <ulink
187 url="">Freenode
188 documentation</ulink> for more information about cloaks.
189 </para>
190 </section>
192 <section id="doc-rsrcs">
193 <title>Documentation</title>
194 <para>
195 This document contains a lot of information which is useful to Debian
196 developers, but it cannot contain everything.  Most of the other interesting
197 documents are linked from <ulink url="&url-devel-docs;">The
198 Developers' Corner</ulink>.  Take the time to browse all the links, you will
199 learn many more things.
200 </para>
201 </section>
203 <section id="server-machines">
204 <title>Debian machines</title>
205 <para>
206 Debian has several computers working as servers, most of which serve critical
207 functions in the Debian project.  Most of the machines are used for porting
208 activities, and they all have a permanent connection to the Internet.
209 </para>
210 <para>
211 Some of the machines are available for individual developers to use, as long as
212 the developers follow the rules set forth in the <ulink
213 url="&url-dmup;">Debian Machine Usage Policies</ulink>.
214 </para>
215 <para>
216 Generally speaking, you can use these machines for Debian-related purposes as
217 you see fit.  Please be kind to system administrators, and do not use up tons
218 and tons of disk space, network bandwidth, or CPU without first getting the
219 approval of the system administrators.  Usually these machines are run by
220 volunteers.
221 </para>
222 <para>
223 Please take care to protect your Debian passwords and SSH keys installed on
224 Debian machines.  Avoid login or upload methods which send passwords over the
225 Internet in the clear, such as Telnet, FTP, POP etc.
226 </para>
227 <para>
228 Please do not put any material that doesn't relate to Debian on the Debian
229 servers, unless you have prior permission.
230 </para>
231 <para>
232 The current list of Debian machines is available at <ulink
233 url="&url-devel-machines;"></ulink>.  That web page contains
234 machine names, contact information, information about who can log in, SSH keys
235 etc.
236 </para>
237 <para>
238 If you have a problem with the operation of a Debian server, and you think that
239 the system operators need to be notified of this problem, you can check
240 the list of open issues in the DSA (Debian System Administration) Team's queue
241 of our request tracker at <ulink url="&url-rt;" /> (you can login with user
242 "debian", its password is available at
243 <filename>;</filename>).  To report a
244 new problem in the request tracker, simply send a mail to &email-rt-dsa; and
245 make sure to put the string "Debian RT" somewhere in the subject.  To contact
246 the DSA team by email, use <email></email> for anything that
247 contains private or privileged information and should not be made public, and
248 <email></email> otherwise.  The DSA team is also
249 present on the <literal>#debian-admin</literal> IRC channel on OFTC.
250 </para>
251 <para>
252 If you have a problem with a certain service, not related to the system
253 administration (such as packages to be removed from the archive, suggestions
254 for the web site, etc.), generally you'll report a bug against a
255 ``pseudo-package''.  See <xref linkend="submit-bug"/> for information on how to
256 submit bugs.
257 </para>
258 <para>
259 Some of the core servers are restricted, but the information from there is
260 mirrored to another server.
261 </para>
262 <section id="servers-bugs">
263 <title>The bugs server</title>
264 <para>
265 <literal>&bugs-host;</literal> is the canonical location for
266 the Bug Tracking System (BTS).
267 </para>
268 <para>
269 If you plan on doing some statistical analysis or processing of Debian bugs,
270 this would be the place to do it.  Please describe your plans on
271 &email-debian-devel; before implementing anything, however, to
272 reduce unnecessary duplication of effort or wasted processing time.
273 </para>
274 </section>
276 <section id="servers-ftp-master">
277 <title>The ftp-master server</title>
278 <para>
279 The <literal>&ftp-master-host;</literal> server holds the canonical copy of
280 the Debian archive.  Generally, package uploaded to &ftp-upload-host;
281 end up on this server, see <xref linkend="upload"/>.
282 </para>
283 <para>
284 It is restricted; a mirror is available on <literal>&ftp-master-mirror;</literal>.
285 </para>
286 <para>
287 Problems with the Debian FTP archive generally need to be reported as bugs
288 against the <systemitem role="package">&ftp-debian-org;</systemitem>
289 pseudo-package or an email to &email-ftpmaster;, but also see
290 the procedures in <xref linkend="archive-manip"/>.
291 </para>
292 </section>
294 <section id="servers-www">
295 <title>The www-master server</title>
296 <para>
297 The main web server is <literal></literal>.  It holds the
298 official web pages, the face of Debian for most newbies.
299 </para>
300 <para>
301 If you find a problem with the Debian web server, you should generally submit a
302 bug against the pseudo-package, <systemitem
303 role="package"></systemitem>.  Remember to check whether or not
304 someone else has already reported the problem to the <ulink
305 url="https://&bugs-host;/&www-debian-org;">Bug Tracking System</ulink>.
306 </para>
307 </section>
309 <section id="servers-people">
310 <title>The people web server</title>
311 <para>
312 <literal></literal> is the server used for developers' own web
313 pages about anything related to Debian.
314 </para>
315 <para>
316 If you have some Debian-specific information which you want to serve on the
317 web, you can do this by putting material in the
318 <filename>public_html</filename> directory under your home directory on
319 <literal></literal>.  This will be accessible at the URL
320 <literal><replaceable>your-user-id</replaceable>/</literal>.
321 </para>
322 <para>
323 You should only use this particular location because it will be backed up,
324 whereas on other hosts it won't.
325 </para>
326 <para>
327 Usually the only reason to use a different host is when you need to publish
328 materials subject to the U.S.  export restrictions, in which case you can use
329 one of the other servers located outside the United States.
330 </para>
331 <para>
332 Send mail to &email-debian-devel; if you have any questions.
333 </para>
334 </section>
336 <section id="servers-vcs">
337 <title>The VCS servers</title>
338 <para>
339 If you need to use a Version Control System for any of your Debian work,
340 you can use one of the existing repositories hosted on Alioth or you can
341 request a new project and ask for the VCS repository of your choice.
342 Alioth supports CVS (, Subversion
343 (, Arch (tla/baz, both on, Bazaar
344 (, Darcs (, Mercurial ( and Git
345 (  Checkout <ulink url="&url-alioth-pkg;" /> if you plan
346 to maintain packages in a VCS repository. See <xref linkend="alioth"/> for
347 information on the services provided by Alioth.
348 </para>
349 </section>
351 <section id="dchroot">
352 <title>chroots to different distributions</title>
353 <para>
354 On some machines, there are chroots to different distributions available.  You
355 can use them like this:
356 </para>
357 <screen>
358 vore$ dchroot unstable
359 Executing shell in chroot: /org/
360 </screen>
361 <para>
362 In all chroots, the normal user home directories are available.  You can find
363 out which chroots are available via
364 <ulink url="&url-devel-machines;"></ulink>.
365 </para>
366 </section>
368 </section>
370 <section id="devel-db">
371 <title>The Developers Database</title>
372 <para>
373 The Developers Database, at <ulink
374 url="&url-debian-db;"></ulink>, is an LDAP directory for
375 managing Debian developer attributes.  You can use this resource to search the
376 list of Debian developers.  Part of this information is also available through
377 the finger service on Debian servers, try <command>finger
378</command> to see what it reports.
379 </para>
380 <para>
381 Developers can <ulink url="&url-debian-db-login;">log into the
382 database</ulink> to change various information about themselves, such as:
383 </para>
384 <itemizedlist>
385 <listitem>
386 <para>
387 forwarding address for your email
388 </para>
389 </listitem>
390 <listitem>
391 <para>
392 subscription to debian-private
393 </para>
394 </listitem>
395 <listitem>
396 <para>
397 whether you are on vacation
398 </para>
399 </listitem>
400 <listitem>
401 <para>
402 personal information such as your address, country, the latitude and longitude
403 of the place where you live for use in <ulink
404 url="&url-worldmap;">the world map of Debian
405 developers</ulink>, phone and fax numbers, IRC nickname and web page
406 </para>
407 </listitem>
408 <listitem>
409 <para>
410 password and preferred shell on Debian Project machines
411 </para>
412 </listitem>
413 </itemizedlist>
414 <para>
415 Most of the information is not accessible to the public, naturally.  For more
416 information please read the online documentation that you can find at <ulink
417 url="&url-debian-db-doc;"></ulink>.
418 </para>
419 <para>
420 Developers can also submit their SSH keys to be used for authorization on the
421 official Debian machines, and even add new * DNS entries.  Those
422 features are documented at <ulink
423 url="&url-debian-db-mail-gw;"></ulink>.
424 </para>
425 </section>
427 <section id="archive">
428 <title>The Debian archive</title>
429 <para>
430 The &debian-formal; distribution consists of a lot of packages
431 (currently around &number-of-pkgs; source packages) and a few additional
432 files (such as documentation and installation disk images).
433 </para>
434 <para>
435 Here is an example directory tree of a complete Debian archive:
436 </para>
437 &sample-dist-dirtree;
438 <para>
439 As you can see, the top-level directory contains two directories,
440 <filename>dists/</filename> and <filename>pool/</filename>.  The latter is a
441 “pool” in which the packages actually are, and which is handled by the
442 archive maintenance database and the accompanying programs.  The former
443 contains the distributions, <literal>stable</literal>,
444 <literal>testing</literal> and <literal>unstable</literal>.  The
445 <filename>Packages</filename> and <filename>Sources</filename> files in the
446 distribution subdirectories can reference files in the
447 <filename>pool/</filename> directory.  The directory tree below each of the
448 distributions is arranged in an identical manner.  What we describe below for
449 <literal>stable</literal> is equally applicable to the
450 <literal>unstable</literal> and <literal>testing</literal> distributions.
451 </para>
452 <para>
453 <filename>dists/stable</filename> contains three directories, namely
454 <filename>main</filename>, <filename>contrib</filename>, and
455 <filename>non-free</filename>.
456 </para>
457 <para>
458 In each of the areas, there is a directory for the source packages
459 (<filename>source</filename>) and a directory for each supported architecture
460 (<filename>binary-i386</filename>, <filename>binary-amd64</filename>, etc.).
461 </para>
462 <para>
463 The <filename>main</filename> area contains additional directories which hold
464 the disk images and some essential pieces of documentation required for
465 installing the Debian distribution on a specific architecture
466 (<filename>disks-i386</filename>, <filename>disks-amd64</filename>, etc.).
467 </para>
468 <section id="archive-sections">
469 <title>Sections</title>
470 <para>
471 The <literal>main</literal> section of the Debian archive is what makes up
472 the <emphasis role="strong">official &debian-formal; distribution</emphasis>.
473 The <literal>main</literal> section is official because it fully complies
474 with all our guidelines.  The other two sections do not, to different degrees;
475 as such, they are <emphasis role="strong">not</emphasis> officially part of
476 &debian-formal;.
477 </para>
478 <para>
479 Every package in the main section must fully comply with the <ulink
480 url="&url-dfsg;">Debian Free Software
481 Guidelines</ulink> (DFSG) and with all other policy requirements as described
482 in the <ulink url="&url-debian-policy;">Debian Policy
483 Manual</ulink>.  The DFSG is our definition of “free software.” Check out
484 the Debian Policy Manual for details.
485 </para>
486 <para>
487 Packages in the <literal>contrib</literal> section have to comply with the
488 DFSG, but may fail other requirements.  For instance, they may depend on
489 non-free packages.
490 </para>
491 <para>
492 Packages which do not conform to the DFSG are placed in the
493 <literal>non-free</literal> section.  These packages are not considered as
494 part of the Debian distribution, though we enable their use, and we provide
495 infrastructure (such as our bug-tracking system and mailing lists) for non-free
496 software packages.
497 </para>
498 <para>
499 The <ulink url="&url-debian-policy;">Debian Policy
500 Manual</ulink> contains a more exact definition of the three sections.  The
501 above discussion is just an introduction.
502 </para>
503 <para>
504 The separation of the three sections at the top-level of the archive is
505 important for all people who want to distribute Debian, either via FTP servers
506 on the Internet or on CD-ROMs: by distributing only the
507 <literal>main</literal> and <literal>contrib</literal> sections, one can
508 avoid any legal risks.  Some packages in the <literal>non-free</literal>
509 section do not allow commercial distribution, for example.
510 </para>
511 <para>
512 On the other hand, a CD-ROM vendor could easily check the individual package
513 licenses of the packages in <literal>non-free</literal> and include as many
514 on the CD-ROMs as it's allowed to.  (Since this varies greatly from vendor to
515 vendor, this job can't be done by the Debian developers.)
516 </para>
517 <para>
518 Note that the term section is also used to refer to categories which simplify
519 the organization and browsing of available packages, e.g.
520 <literal>admin</literal>, <literal>net</literal>,
521 <literal>utils</literal> etc.  Once upon a time, these sections (subsections,
522 rather) existed in the form of subdirectories within the Debian archive.
523 Nowadays, these exist only in the Section header fields of packages.
524 </para>
525 </section>
527 <section id="s4.6.2">
528 <title>Architectures</title>
529 <para>
530 In the first days, the Linux kernel was only available for Intel i386 (or
531 greater) platforms, and so was Debian.  But as Linux became more and more
532 popular, the kernel was ported to other architectures and Debian started
533 to support them. And as if supporting so much hardware was not enough,
534 Debian decided to build some ports based on other Unix kernels, like
535 <literal>hurd</literal> and <literal>kfreebsd</literal>.
536 </para>
537 <para>
538 Debian GNU/Linux 1.3 was only available as <literal>i386</literal>.  Debian
539 2.0 shipped for <literal>i386</literal> and <literal>m68k</literal>
540 architectures.  Debian 2.1 shipped for the <literal>i386</literal>,
541 <literal>m68k</literal>, <literal>alpha</literal>, and
542 <literal>sparc</literal> architectures.  Since then Debian has grown hugely.
543 Debian 6 supports a total of nine Linux architectures (<literal>amd64</literal>,
544 <literal>armel</literal>, <literal>i386</literal>,
545 <literal>ia64</literal>, <literal>mips</literal>,
546 <literal>mipsel</literal>, <literal>powerpc</literal>,
547 <literal>s390</literal>, <literal>sparc</literal>) and two kFreeBSD architectures
548 (<literal>kfreebsd-i386</literal> and <literal>kfreebsd-amd64</literal>).
549 </para>
550 <para>
551 Information for developers and users about the specific ports are available at
552 the <ulink url="&url-debian-ports;">Debian Ports web pages</ulink>.
553 </para>
554 </section>
556 <section id="s4.6.3">
557 <title>Packages</title>
558 <para>
559 There are two types of Debian packages, namely <literal>source</literal> and
560 <literal>binary</literal> packages.
561 </para>
562 <para>
563 Depending on the format of the source package, it will consist
564 of one or more files in addition to the mandatory <filename>.dsc</filename>
565 file:
566 <itemizedlist>
567 <listitem><para>with format “1.0”, it has either a <filename>.tar.gz</filename>
568 file or both an <filename>.orig.tar.gz</filename> and a
569 <filename>.diff.gz</filename> file;</para></listitem>
570 <listitem><para>with format “3.0 (quilt)”, it has a mandatory
571 <filename>.orig.tar.{gz,bz2,xz}</filename> upstream tarball,
572 multiple optional <filename>.orig-<replaceable>component</replaceable>.tar.{gz,bz2,xz}</filename>
573 additional upstream tarballs and a mandatory
574 <filename>debian.tar.{gz,bz2,xz}</filename> debian
575 tarball;</para></listitem>
576 <listitem><para>with format “3.0 (native)”, it has only
577 a single <filename>.tar.{gz,bz2,xz}</filename> tarball.</para></listitem>
578 </itemizedlist>
579 </para>
580 <para>
581 If a package is developed specially for Debian and is not distributed
582 outside of Debian, there is just one
583 <filename>.tar.{gz,bz2,xz}</filename> file which contains the sources of
584 the program, it's called a “native” source package.  If a package is
585 distributed elsewhere too, the
586 <filename>.orig.tar.{gz,bz2,xz}</filename> file stores the so-called
587 <literal>upstream source code</literal>, that is the source code that's
588 distributed by the <literal>upstream maintainer</literal> (often the
589 author of the software). In this case, the <filename>.diff.gz</filename>
590 or the <filename>debian.tar.{gz,bz2,xz}</filename> contains the changes
591 made by the Debian maintainer.
592 </para>
593 <para>
594 The <filename>.dsc</filename> file lists all the files in the source package
595 together with checksums (<command>md5sums</command>, <command>sha1sums</command>,
596 <command>sha256sums</command>) and some additional info
597 about the package (maintainer, version, etc.).
598 </para>
599 </section>
601 <section id="s4.6.4">
602 <title>Distributions</title>
603 <para>
604 The directory system described in the previous chapter is itself contained
605 within <literal>distribution directories</literal>.  Each distribution is
606 actually contained in the <filename>pool</filename> directory in the top-level
607 of the Debian archive itself.
608 </para>
609 <para>
610 To summarize, the Debian archive has a root directory within an FTP server.
611 For instance, at the mirror site, <literal></literal>, the
612 Debian archive itself is contained in <ulink
613 url="">/debian</ulink>, which is a common
614 location (another is <filename>/pub/debian</filename>).
615 </para>
616 <para>
617 A distribution comprises Debian source and binary packages, and the respective
618 <filename>Sources</filename> and <filename>Packages</filename> index files,
619 containing the header information from all those packages.  The former are kept
620 in the <filename>pool/</filename> directory, while the latter are kept in the
621 <filename>dists/</filename> directory of the archive (for backwards
622 compatibility).
623 </para>
624 <section id="sec-dists">
625 <title>Stable, testing, and unstable</title>
626 <para>
627 There are always distributions called <literal>stable</literal> (residing in
628 <filename>dists/stable</filename>), <literal>testing</literal> (residing in
629 <filename>dists/testing</filename>), and <literal>unstable</literal>
630 (residing in <filename>dists/unstable</filename>).  This reflects the
631 development process of the Debian project.
632 </para>
633 <para>
634 Active development is done in the <literal>unstable</literal> distribution
635 (that's why this distribution is sometimes called the <literal>development
636 distribution</literal>).  Every Debian developer can update their
637 packages in this distribution at any time.  Thus, the contents of this
638 distribution change from day to day.  Since no special effort is made to make
639 sure everything in this distribution is working properly, it is sometimes
640 literally unstable.
641 </para>
642 <para>
643 The <link linkend="testing">testing</link> distribution is generated
644 automatically by taking packages from <literal>unstable</literal> if they
645 satisfy certain criteria.  Those criteria should ensure a good quality for
646 packages within <literal>testing</literal>.  The update to
647 <literal>testing</literal> is launched twice each day, right  after the new
648 packages have been installed.  See <xref linkend="testing"/>.
649 </para>
650 <para>
651 After a period of development, once the release manager deems fit, the
652 <literal>testing</literal> distribution is frozen, meaning that the policies
653 which control how packages move from <literal>unstable</literal> to
654 <literal>testing</literal> are tightened.  Packages which are too buggy are
655 removed.  No changes are allowed into <literal>testing</literal> except for
656 bug fixes.  After some time has elapsed, depending on progress, the
657 <literal>testing</literal> distribution is frozen even further.  Details of
658 the handling of the testing distribution are published by the Release Team on
659 debian-devel-announce.  After the open issues are solved to the satisfaction of
660 the Release Team, the distribution is released.  Releasing means that
661 <literal>testing</literal> is renamed to <literal>stable</literal>, and a
662 new copy is created for the new <literal>testing</literal>, and the previous
663 <literal>stable</literal> is renamed to <literal>oldstable</literal> and
664 stays there until it is finally archived.  On archiving, the contents are moved
665 to <literal>&archive-host;</literal>.
666 </para>
667 <para>
668 This development cycle is based on the assumption that the
669 <literal>unstable</literal> distribution becomes <literal>stable</literal>
670 after passing a period of being in <literal>testing</literal>.  Even once a
671 distribution is considered stable, a few bugs inevitably remain — that's why
672 the stable distribution is updated every now and then.  However, these updates
673 are tested very carefully and have to be introduced into the archive
674 individually to reduce the risk of introducing new bugs.  You can find proposed
675 additions to <literal>stable</literal> in the
676 <filename>proposed-updates</filename> directory.  Those packages in
677 <filename>proposed-updates</filename> that pass muster are periodically moved
678 as a batch into the stable distribution and the revision level of the stable
679 distribution is incremented (e.g., ‘6.0’ becomes ‘6.0.1’, ‘5.0.7’
680 becomes ‘5.0.8’, and so forth).  Please refer to
681 <link linkend="upload-stable">uploads to the <literal>stable</literal>
682 distribution</link> for details.
683 </para>
684 <para>
685 Note that development under <literal>unstable</literal> continues during the
686 freeze period, since the <literal>unstable</literal> distribution remains in
687 place in parallel with <literal>testing</literal>.
688 </para>
689 </section>
691 <section id="s4.6.4.2">
692 <title>More information about the testing distribution</title>
693 <para>
694 Packages are usually installed into the <literal>testing</literal> distribution
695 after they have undergone some degree of testing in <literal>unstable</literal>.
696 </para>
697 <para>
698 For more details, please see the <link linkend="testing">information about
699 the testing distribution</link>.
700 </para>
701 </section>
703 <section id="experimental">
704 <title>Experimental</title>
705 <para>
706 The <literal>experimental</literal> distribution is a special distribution.
707 It is not a full distribution in the same sense as <literal>stable</literal>,
708 <literal>testing</literal> and <literal>unstable</literal> are.
709 Instead, it is meant to be a temporary staging area for highly experimental
710 software where there's a good chance that the software could break your system,
711 or software that's just too unstable even for the <literal>unstable</literal>
712 distribution (but there is a reason to package it nevertheless).  Users who
713 download and install packages from <literal>experimental</literal> are
714 expected to have been duly warned.  In short, all bets are off for the
715 <literal>experimental</literal> distribution.
716 </para>
717 <para>
718 These are the <citerefentry> <refentrytitle>sources.list</refentrytitle>
719 <manvolnum>5</manvolnum> </citerefentry> lines for
720 <literal>experimental</literal>:
721 </para>
722 <programlisting>
723 deb http://ftp.<replaceable>xy</replaceable> experimental main
724 deb-src http://ftp.<replaceable>xy</replaceable> experimental main
725 </programlisting>
726 <para>
727 If there is a chance that the software could do grave damage to a system, it is
728 likely to be better to put it into <literal>experimental</literal>.  For
729 instance, an experimental compressed file system should probably go into
730 <literal>experimental</literal>.
731 </para>
732 <para>
733 Whenever there is a new upstream version of a package that introduces new
734 features but breaks a lot of old ones, it should either not be uploaded, or be
735 uploaded to <literal>experimental</literal>.  A new, beta, version of some
736 software which uses a completely different configuration can go into
737 <literal>experimental</literal>, at the maintainer's discretion.  If you are
738 working on an incompatible or complex upgrade situation, you can also use
739 <literal>experimental</literal> as a staging area, so that testers can get
740 early access.
741 </para>
742 <para>
743 Some experimental software can still go into <literal>unstable</literal>,
744 with a few warnings in the description, but that isn't recommended because
745 packages from <literal>unstable</literal> are expected to propagate to
746 <literal>testing</literal> and thus to <literal>stable</literal>.  You
747 should not be afraid to use <literal>experimental</literal> since it does not
748 cause any pain to the ftpmasters, the experimental packages are periodically
749 removed once you upload the package in <literal>unstable</literal> with a
750 higher version number.
751 </para>
752 <para>
753 New software which isn't likely to damage your system can go directly into
754 <literal>unstable</literal>.
755 </para>
756 <para>
757 An alternative to <literal>experimental</literal> is to use your personal web
758 space on <literal></literal>.
759 </para>
760 </section>
762 </section>
764 <section id="codenames">
765 <title>Release code names</title>
766 <para>
767 Every released Debian distribution has a <literal>code name</literal>: Debian
768 1.1 is called <literal>buzz</literal>; Debian 1.2, <literal>rex</literal>;
769 Debian 1.3, <literal>bo</literal>; Debian 2.0, <literal>hamm</literal>;
770 Debian 2.1, <literal>slink</literal>; Debian 2.2, <literal>potato</literal>;
771 Debian 3.0, <literal>woody</literal>; Debian 3.1, <literal>sarge</literal>;
772 Debian 4.0, <literal>etch</literal>; Debian 5.0, <literal>lenny</literal>;
773 Debian 6.0, <literal>squeeze</literal>; Debian 7.0, <literal>wheezy</literal>;
774 and the next release will be called <literal>jessie</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., `squeeze'). 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>dak process-upload</command> script,
860 which 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>done</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 four times 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; or &email-debian-experimental-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>https://&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>https://&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
979 <literal>&ftp-master-host;</literal>, and on the mirror on
980 <literal>&ftp-master-mirror;</literal>.  It uses a single argument
981 corresponding to a package name. An example will 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>dak</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>dak</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 <varlistentry>
1140 <term><literal>derivatives-bugs</literal></term>
1141 <listitem>
1142 <para>
1143 Bugs reports and comments from derivative distributions (for example Ubuntu).
1144 </para>
1145 </listitem>
1146 </varlistentry>
1147 </variablelist>
1148 <section id="pts-commands">
1149 <title>The PTS email interface</title>
1150 <para>
1151 You can control your subscription(s) to the PTS by sending various commands to
1152 <email></email>.
1153 </para>
1154 <variablelist>
1155 <varlistentry>
1156 <term><literal>subscribe &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1157 <listitem>
1158 <para>
1159 Subscribes <replaceable>email</replaceable> to communications related to the
1160 source package <replaceable>sourcepackage</replaceable>.  Sender address is
1161 used if the second argument is not present.  If
1162 <replaceable>sourcepackage</replaceable> is not a valid source package, you'll
1163 get a warning.  However if it's a valid binary package, the PTS will subscribe
1164 you to the corresponding source package.
1165 </para>
1166 </listitem>
1167 </varlistentry>
1168 <varlistentry>
1169 <term><literal>unsubscribe &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1170 <listitem>
1171 <para>
1172 Removes a previous subscription to the source package
1173 <replaceable>sourcepackage</replaceable> using the specified email address or
1174 the sender address if the second argument is left out.
1175 </para>
1176 </listitem>
1177 </varlistentry>
1178 <varlistentry>
1179 <term><literal>unsubscribeall [&lt;email&gt;]</literal></term>
1180 <listitem>
1181 <para>
1182 Removes all subscriptions of the specified email address or the sender address
1183 if the second argument is left out.
1184 </para>
1185 </listitem>
1186 </varlistentry>
1187 <varlistentry>
1188 <term><literal>which [&lt;email&gt;]</literal></term>
1189 <listitem>
1190 <para>
1191 Lists all subscriptions for the sender or the email address optionally
1192 specified.
1193 </para>
1194 </listitem>
1195 </varlistentry>
1196 <varlistentry>
1197 <term><literal>keyword [&lt;email&gt;]</literal></term>
1198 <listitem>
1199 <para>
1200 Tells you the keywords that you are accepting.  For an explanation of keywords,
1201 <link linkend="pkg-tracking-system">see above</link>.  Here's a quick
1202 summary:
1203 </para>
1204 <itemizedlist>
1205 <listitem>
1206 <para>
1207 <literal>bts</literal>: mails coming from the Debian Bug Tracking System
1208 </para>
1209 </listitem>
1210 <listitem>
1211 <para>
1212 <literal>bts-control</literal>: reply to mails sent to
1213 &email-bts-control;
1214 </para>
1215 </listitem>
1216 <listitem>
1217 <para>
1218 <literal>summary</literal>: automatic summary mails about the state of a
1219 package
1220 </para>
1221 </listitem>
1222 <listitem>
1223 <para>
1224 <literal>contact</literal>: mails sent to the maintainer through the
1225 * aliases
1226 </para>
1227 </listitem>
1228 <listitem>
1229 <para>
1230 <literal>cvs</literal>: notification of VCS commits
1231 </para>
1232 </listitem>
1233 <listitem>
1234 <para>
1235 <literal>ddtp</literal>: translations of descriptions and debconf templates
1236 </para>
1237 </listitem>
1238 <listitem>
1239 <para>
1240 <literal>derivatives</literal>: changes made on the package by derivative
1241 distributions
1242 </para>
1243 </listitem>
1244 <listitem>
1245 <para>
1246 <literal>derivatives-bugs</literal>: bugs reports and comments from derivative
1247 distributions
1248 </para>
1249 </listitem>
1250 <listitem>
1251 <para>
1252 <literal>upload-source</literal>: announce of a new source upload that has been
1253 accepted
1254 </para>
1255 </listitem>
1256 <listitem>
1257 <para>
1258 <literal>upload-binary</literal>: announce of a new binary-only upload
1259 (porting)
1260 </para>
1261 </listitem>
1262 <listitem>
1263 <para>
1264 <literal>katie-other</literal>: other mails from ftpmasters (override
1265 disparity, etc.)
1266 </para>
1267 </listitem>
1268 <listitem>
1269 <para>
1270 <literal>buildd</literal>: build failures notifications from build daemons
1271 </para>
1272 </listitem>
1273 <listitem>
1274 <para>
1275 <literal>default</literal>: all the other mails (those which aren't automatic)
1276 </para>
1277 </listitem>
1278 </itemizedlist>
1279 </listitem>
1280 </varlistentry>
1281 <varlistentry>
1282 <term><literal>keyword &lt;sourcepackage&gt; [&lt;email&gt;]</literal></term>
1283 <listitem>
1284 <para>
1285 Same as the previous item but for the given source package, since you may
1286 select a different set of keywords for each source package.
1287 </para>
1288 </listitem>
1289 </varlistentry>
1290 <varlistentry>
1291 <term><literal>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1292 <listitem>
1293 <para>
1294 Accept (+) or refuse (-) mails classified under the given keyword(s).  Define
1295 the list (=) of accepted keywords.  This changes the default set of keywords
1296 accepted by a user.
1297 </para>
1298 </listitem>
1299 </varlistentry>
1300 <varlistentry>
1301 <term><literal>keywordall [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1302 <listitem>
1303 <para>
1304 Accept (+) or refuse (-) mails classified under the given keyword(s).  Define
1305 the list (=) of accepted keywords.  This changes the set of accepted keywords
1306 of all the currently active subscriptions of a user.
1307 </para>
1308 </listitem>
1309 </varlistentry>
1310 <varlistentry>
1311 <term><literal>keyword &lt;sourcepackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</literal></term>
1312 <listitem>
1313 <para>
1314 Same as previous item but overrides the keywords list for the indicated source
1315 package.
1316 </para>
1317 </listitem>
1318 </varlistentry>
1319 <varlistentry>
1320 <term><literal>quit | thanks | --</literal></term>
1321 <listitem>
1322 <para>
1323 Stops processing commands.  All following lines are ignored by the bot.
1324 </para>
1325 </listitem>
1326 </varlistentry>
1327 </variablelist>
1328 <para>
1329 The <command>pts-subscribe</command> command-line utility (from the <systemitem
1330 role="package">devscripts</systemitem> package) can be handy to temporarily
1331 subscribe to some packages, for example after having made an non-maintainer
1332 upload.
1333 </para>
1334 </section>
1336 <section id="pts-mail-filtering">
1337 <title>Filtering PTS mails</title>
1338 <para>
1339 Once you are subscribed to a package, you will get the mails sent to
1340 <literal><replaceable>sourcepackage</replaceable>@&pts-host;</literal>.
1341 Those mails have special headers appended to let you filter them in a special
1342 mailbox (e.g.  with <command>procmail</command>).  The added headers are
1343 <literal>X-Loop</literal>, <literal>X-PTS-Package</literal>,
1344 <literal>X-PTS-Keyword</literal> and <literal>X-Unsubscribe</literal>.
1345 </para>
1346 <para>
1347 Here is an example of added headers for a source upload notification on the
1348 <systemitem role="package">dpkg</systemitem> package:
1349 </para>
1350 <screen>
1351 X-Loop: dpkg@&pts-host;
1352 X-PTS-Package: dpkg
1353 X-PTS-Keyword: upload-source
1354 List-Unsubscribe: &lt;;
1355 </screen>
1356 </section>
1358 <section id="pts-vcs-commit">
1359 <title>Forwarding VCS commits in the PTS</title>
1360 <para>
1361 If you use a publicly accessible VCS repository for maintaining your Debian
1362 package, you may want to forward the commit notification to the PTS so that the
1363 subscribers (and possible co-maintainers) can closely follow the package's
1364 evolution.
1365 </para>
1366 <para>
1367 Once you set up the VCS repository to generate commit notifications, you just
1368 have to make sure it sends a copy of those mails to
1369 <literal><replaceable>sourcepackage</replaceable>_cvs@&pts-host;</literal>.
1370 Only the people who accept the <literal>cvs</literal> keyword will receive
1371 these notifications. Note that the mail needs to be sent from a
1372 <literal></literal> machine, otherwise you'll have to add
1373 the <literal>X-PTS-Approved: 1</literal> header.
1374 </para>
1375 <para>
1376 For Subversion repositories, the usage of svnmailer is recommended.
1377 See <ulink url="&url-alioth-pkg;" /> for an example on how to do it.
1378 </para>
1379 </section>
1381 <section id="pts-web">
1382 <title>The PTS web interface</title>
1383 <para>
1384 The PTS has a web interface at <ulink
1385 url="https://&pts-host;/"></ulink> that puts together a lot of
1386 information about each source package.  It features many useful links (BTS, QA
1387 stats, contact information, DDTP translation status, buildd logs) and gathers
1388 much more information from various places (30 latest changelog entries, testing
1389 status, etc.).  It's a very useful tool if you want to know what's going on with
1390 a specific source package.  Furthermore there's a form that allows easy
1391 subscription to the PTS via email.
1392 </para>
1393 <para>
1394 You can jump directly to the web page concerning a specific source package with
1395 a URL like
1396 <literal>https://&pts-host;/<replaceable>sourcepackage</replaceable></literal>.
1397 </para>
1398 <para>
1399 This web interface has been designed like a portal for the development of
1400 packages: you can add custom content on your packages' pages.  You can add
1401 static information (news items that are meant to stay available indefinitely)
1402 and news items in the latest news section.
1403 </para>
1404 <para>
1405 Static news items can be used to indicate:
1406 </para>
1407 <itemizedlist>
1408 <listitem>
1409 <para>
1410 the availability of a project hosted on
1411 <link linkend="alioth">Alioth</link> for co-maintaining the package
1412 </para>
1413 </listitem>
1414 <listitem>
1415 <para>
1416 a link to the upstream web site
1417 </para>
1418 </listitem>
1419 <listitem>
1420 <para>
1421 a link to the upstream bug tracker
1422 </para>
1423 </listitem>
1424 <listitem>
1425 <para>
1426 the existence of an IRC channel dedicated to the software
1427 </para>
1428 </listitem>
1429 <listitem>
1430 <para>
1431 any other available resource that could be useful in the maintenance of the
1432 package
1433 </para>
1434 </listitem>
1435 </itemizedlist>
1436 <para>
1437 Usual news items may be used to announce that:
1438 </para>
1439 <itemizedlist>
1440 <listitem>
1441 <para>
1442 beta packages are available for testing
1443 </para>
1444 </listitem>
1445 <listitem>
1446 <para>
1447 final packages are expected for next week
1448 </para>
1449 </listitem>
1450 <listitem>
1451 <para>
1452 the packaging is about to be redone from scratch
1453 </para>
1454 </listitem>
1455 <listitem>
1456 <para>
1457 backports are available
1458 </para>
1459 </listitem>
1460 <listitem>
1461 <para>
1462 the maintainer is on vacation (if they wish to publish this information)
1463 </para>
1464 </listitem>
1465 <listitem>
1466 <para>
1467 a NMU is being worked on
1468 </para>
1469 </listitem>
1470 <listitem>
1471 <para>
1472 something important will affect the package
1473 </para>
1474 </listitem>
1475 </itemizedlist>
1476 <para>
1477 Both kinds of news are generated in a similar manner: you just have to send an
1478 email either to <email></email> or to
1479 <email></email>.  The mail should indicate which package
1480 is concerned by having the name of the source package in a
1481 <literal>X-PTS-Package</literal> mail header or in a <literal>Package</literal>
1482 pseudo-header (like the BTS reports).  If a URL is available in the
1483 <literal>X-PTS-Url</literal> mail header or in the <literal>Url</literal>
1484 pseudo-header, then the result is a link to that URL instead of a complete news
1485 item.
1486 </para>
1487 <para>
1488 Here are a few examples of valid mails used to generate news items in the PTS.
1489 The first one adds a link to the viewsvn interface of debian-cd in the Static
1490 information section:
1491 </para>
1492 <screen>
1493 From: Raphael Hertzog &lt;;
1494 To:
1495 Subject: Browse debian-cd SVN repository
1497 Package: debian-cd
1498 Url:
1499 </screen>
1500 <para>
1501 The second one is an announcement sent to a mailing list which is also sent to
1502 the PTS so that it is published on the PTS web page of the package.  Note the
1503 use of the BCC field to avoid answers sent to the PTS by mistake.
1504 </para>
1505 <screen>
1506 From: Raphael Hertzog &lt;;
1507 To: debian-gtk-gnome@&lists-host;
1508 Bcc:
1509 Subject: Galeon 2.0 backported for woody
1510 X-PTS-Package: galeon
1512 Hello gnomers!
1514 I'm glad to announce that galeon has been backported for woody. You'll find
1515 everything here:
1516 ...
1517 </screen>
1518 <para>
1519 Think twice before adding a news item to the PTS because you won't be able to
1520 remove it later and you won't be able to edit it either.  The only thing that
1521 you can do is send a second news item that will deprecate the information
1522 contained in the previous one.
1523 </para>
1524 </section>
1526 </section>
1528 <section id="ddpo">
1529 <title>Developer's packages overview</title>
1530 <para>
1531 A QA (quality assurance) web portal is available at <ulink
1532 url="&url-ddpo;"></ulink> which displays a table listing all
1533 the packages of a single developer (including those where the party is listed
1534 as a co-maintainer).  The table gives a good summary about the developer's
1535 packages: number of bugs by severity, list of available versions in each
1536 distribution, testing status and much more including links to any other useful
1537 information.
1538 </para>
1539 <para>
1540 It is a good idea to look up your own data regularly so that you don't forget
1541 any open bugs, and so that you don't forget which packages are your
1542 responsibility.
1543 </para>
1544 </section>
1546 <section id="alioth">
1547 <title>Debian's FusionForge installation: Alioth</title>
1548 <para>
1549 Alioth is a Debian service based on a slightly modified version of the
1550 FusionForge software (which evolved from SourceForge and GForge). This software offers
1551 developers access to easy-to-use tools such as bug trackers, patch
1552 manager, project/task managers, file hosting services, mailing lists, VCS
1553 repositories etc.  All these tools are managed via a web interface.
1554 </para>
1555 <para>
1556 It is intended to provide facilities to free software projects backed or led by
1557 Debian, facilitate contributions from external developers to projects started
1558 by Debian, and help projects whose goals are the promotion of Debian or its
1559 derivatives. It's heavily used by many Debian teams and provides
1560 hosting for all sorts of VCS repositories.
1561 </para>
1562 <para>
1563 All Debian developers automatically have an account on Alioth.  They can
1564 activate it by using the recover password facility.  External developers can
1565 request guest accounts on Alioth.
1566 </para>
1567 <para>
1568 For more information please visit the following links:
1569 </para>
1570 <itemizedlist>
1571 <listitem><para><ulink url="&url-alioth-wiki;" /></para></listitem>
1572 <listitem><para><ulink url="&url-alioth-faq;" /></para></listitem>
1573 <listitem><para><ulink url="&url-alioth-pkg;" /></para></listitem>
1574 <listitem><para><ulink url="&url-alioth;" /></para></listitem>
1575 </itemizedlist>
1576 </section>
1578 <section id="developer-misc">
1579 <title>Goodies for Debian Developers and Debian Maintainers</title>
1580 <para>
1581 Benefits available to Debian Developers and Debian Maintainers are documented on <ulink
1582         url=""></ulink>.
1583 </para>
1584 </section>
1586 </chapter>