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