chiark / gitweb /
Sec "Uploading to ftp-master": xref to "Delayed incoming";
[developers-reference.git] / developers-reference.sgml
1 <!DOCTYPE debiandoc PUBLIC "-//DebianDoc//DTD DebianDoc//EN" [
2   <!-- include version information so we don't have to hard code it
3        within the document -->
4   <!entity % versiondata SYSTEM "version.ent"> %versiondata;
5   <!-- common, language independant entities -->
6   <!entity % commondata  SYSTEM "common.ent" > %commondata;
7
8   <!-- CVS revision of this document -->
9   <!entity cvs-rev "$Revision: 1.207 $">
10   <!-- if you are translating this document, please notate the CVS
11        revision of the developers reference here -->
12   <!--
13     <!entity cvs-en-rev "X.YY">
14     -->
15
16   <!--  -->
17   <!entity FIXME "<em>FIXME:</em>&nbsp;">
18
19 ]>
20 <debiandoc>
21   <book>
22       <title>Debian Developer's Reference
23
24       <author>Developer's Reference Team &email-devel-ref;
25       <author>Adam Di Carlo, editor
26       <author>Raphaël Hertzog
27       <author>Christian Schwarz
28       <author>Ian Jackson
29       <version>ver. &version;, &date-en;
30
31       <copyright>
32         <copyrightsummary>
33 copyright &copy; 1998&mdash;2003 Adam Di Carlo</copyrightsummary>
34         <copyrightsummary>
35 copyright &copy; 2002&mdash;2003 Raphaël Hertzog</copyrightsummary>
36         <copyrightsummary>
37 copyright &copy; 1997, 1998 Christian Schwarz</copyrightsummary>
38         <p>
39 This manual is free software; you may redistribute it and/or modify it
40 under the terms of the GNU General Public License as published by the
41 Free Software Foundation; either version 2, or (at your option) any
42 later version.
43         <p>
44 This is distributed in the hope that it will be useful, but
45 <em>without any warranty</em>; without even the implied warranty of
46 merchantability or fitness for a particular purpose.  See the GNU
47 General Public License for more details.
48         <p>
49 A copy of the GNU General Public License is available as &file-GPL; in
50 the &debian-formal; distribution or on the World Wide Web at <url
51 id="&url-gpl;" name="the GNU web site">.  You can also obtain it by
52 writing to the &fsf-addr;.
53
54     <toc detail="sect1">
55
56     <chapt id="scope">Scope of This Document
57       <p>
58 The purpose of this document is to provide an overview of the
59 recommended procedures and the available resources for Debian
60 developers.
61
62 <!-- FIXME: rewrites -->
63       <p>
64 The procedures discussed within include how to become a maintainer
65 (<ref id="new-maintainer">); how to create new packages
66 (<ref id="newpackage">) and how to upload packages (<ref id="upload">);
67 how to handle bug reports (<ref id="bug-handling">); how to move,
68 remove, or orphan packages (<ref id="archive-manip">); how to port
69 packages (<ref id="porting">); and how and when to do interim
70 releases of other maintainers' packages (<ref id="nmu">).
71       <p>
72 The resources discussed in this reference include the mailing lists
73 (<ref id="mailing-lists">) and servers (<ref id="server-machines">); a
74 discussion of the structure of the Debian archive (<ref
75 id="archive">); explanation of the different servers which accept
76 package uploads (<ref id="upload-ftp-master">); and a discussion of
77 resources which can help maintainers with the quality of their
78 packages (<ref id="tools">).
79       <p>
80 It should be clear that this reference does not discuss the technical
81 details of the Debian package nor how to generate Debian packages.
82 Nor does this reference detail the standards to which Debian software
83 must comply.  All of such information can be found in the <url
84 id="&url-debian-policy;" name="Debian Policy Manual">.
85       <p>
86 Furthermore, this document is <em>not an expression of formal
87 policy</em>.  It contains documentation for the Debian system and
88 generally agreed-upon best practices.  Thus, it is what is called a
89 ``normative'' document.
90
91
92     <chapt id="new-maintainer">Applying to Become a Maintainer
93         
94       <sect id="getting-started">Getting started
95         <p>
96 So, you've read all the documentation, you've gone through the <url
97 id="&url-newmaint-guide;" name="Debian New Maintainers' Guide">,
98 understand what everything in the <package>hello</package> example
99 package is for, and you're about to Debianize your favorite piece of
100 software.  How do you actually become a Debian developer so that your
101 work can be incorporated into the Project?
102         <p>
103 Firstly, subscribe to &email-debian-devel; if you haven't already.
104 Send the word <tt>subscribe</tt> in the <em>Subject</em> of an email
105 to &email-debian-devel-req;.  In case of problems, contact the list
106 administrator at &email-listmaster;.  More information on available
107 mailing lists can be found in <ref id="mailing-lists">.
108 &email-debian-devel-announce; is another list which is mandatory
109 for anyone who wishes to follow Debian's development.
110         <p>
111 You should subscribe and lurk (that is, read without posting) for a
112 bit before doing any coding, and you should post about your intentions
113 to work on something to avoid duplicated effort.
114         <p>
115 Another good list to subscribe to is &email-debian-mentors;.  See <ref
116 id="mentors"> for details.  The IRC channel <tt>#debian</tt> can also be
117 helpful.
118
119         <p>
120 When you know how you want to contribute to &debian-formal;, you
121 should get in contact with existing Debian maintainers who are working
122 on similar tasks.  That way, you can learn from experienced developers.
123 For example, if you are interested in packaging existing software for
124 Debian you should try to get a sponsor.  A sponsor will work together
125 with you on your package and upload it to the Debian archive once they
126 are happy with the packaging work you have done.  You can find a sponsor
127 by mailing the &email-debian-mentors; mailing list, describing your
128 package and yourself and asking for a sponsor (see <ref id="sponsoring">
129 for more information on sponsoring).  On the other hand, if you are
130 interested in porting Debian to alternative architectures or kernels
131 you can subscribe to port specific mailing lists and ask there how to
132 get started.  Finally, if you are interested in documentation or
133 Quality Assurance (QA) work you can join maintainers already working on
134 these tasks and submit patches and improvements.
135  
136
137       <sect id="registering">Registering as a Debian developer
138         <p>
139 Before you decide to register with &debian-formal;, you will need to
140 read all the information available at the <url id="&url-newmaint;"
141 name="New Maintainer's Corner">.  It describes exactly the
142 preparations you have to do before you can register to become a Debian
143 developer.
144
145 For example, before you apply, you have to to read the <url
146 id="&url-social-contract;" name="Debian Social Contract">.
147 Registering as a developer means that you agree with and pledge to
148 uphold the Debian Social Contract; it is very important that
149 maintainers are in accord with the essential ideas behind
150 &debian-formal;.  Reading the <url id="&url-gnu-manifesto;" name="GNU
151 Manifesto"> would also be a good idea.
152         <p>
153 The process of registering as a developer is a process of verifying
154 your identity and intentions, and checking your technical skills.  As
155 the number of people working on &debian-formal; has grown to over
156 &number-of-maintainers; people and our systems are used in several
157 very important places we have to be careful about being compromised.
158 Therefore, we need to verify new maintainers before we can give them
159 accounts on our servers and let them upload packages.
160         <p>
161 Before you actually register you should have shown that you can do
162 competent work and will be a good contributor.  You can show this by
163 submitting patches through the Bug Tracking System or having a package
164 sponsored by an existing maintainer for a while.  Also, we expect that
165 contributors are interested in the whole project and not just in
166 maintaining their own packages.  If you can help other maintainers by
167 providing further information on a bug or even a patch, then do so!
168         <p>
169 Registration requires that you are familiar with Debian's philosophy
170 and technical documentation.  Furthermore, you need a GnuPG key which
171 has been signed by an existing Debian maintainer.  If your GnuPG key
172 is not signed yet, you should try to meet a Debian maintainer in
173 person to get your key signed.  There's a <url id="&url-gpg-coord;"
174 name="GnuPG Key Signing Coordination page"> which should help you find
175 a maintainer close to you (If you cannot find a Debian maintainer
176 close to you, there's an alternative way to pass the ID check.  You
177 can send in a photo ID signed with your GnuPG key.  Having your GnuPG
178 key signed is the preferred way, however.  See the
179 <url id="&url-newmaint-id;" name="identification page"> for more
180 information about these two options.)
181
182         <p>
183 If you do not have an OpenPGP key yet, generate one. Every developer
184 needs a OpenPGP key in order to sign and verify package uploads. You
185 should read the manual for the software you are using, since it has
186 much important information which is critical to its security.  Many
187 more security failures are due to human error than to software failure
188 or high-powered spy techniques.  See <ref id="key-maint"> for more
189 information on maintaining your public key.
190         <p>
191 Debian uses the <prgn>GNU Privacy Guard</prgn> (package
192 <package>gnupg</package> version 1 or better) as its baseline standard.
193 You can use some other implementation of OpenPGP as well.  Note that
194 OpenPGP is an open standard based on <url id="&url-rfc2440;" name="RFC
195 2440">.
196         <p>
197 The recommended public key algorithm for use in Debian development
198 work is DSA (sometimes call ``DSS'' or ``DH/ElGamal'').  Other key
199 types may be used however.  Your key length must be at least 1024
200 bits; there is no reason to use a smaller key, and doing so would be
201 much less secure.  Your key must be signed with at least your own user
202 ID; this prevents user ID tampering.  <prgn>gpg</prgn> does this
203 automatically.
204         <p>
205 If your public key isn't on public key servers such as &pgp-keyserv;,
206 please read the documentation available locally in &file-keyservs;.
207 That document contains instructions on how to put your key on the
208 public key servers.  The New Maintainer Group will put your public key
209 on the servers if it isn't already there.
210         <p>
211 Some countries restrict the use of cryptographic software by their
212 citizens.  This need not impede one's activities as a Debian package
213 maintainer however, as it may be perfectly legal to use cryptographic
214 products for authentication, rather than encryption purposes.
215 &debian-formal; does not require the use of cryptography <em>qua</em>
216 cryptography in any manner.  If you live in a country where use of
217 cryptography even for authentication is forbidden
218 then please contact us so we can make special arrangements.
219         <p>
220 To apply as a new maintainer, you need an existing Debian maintainer
221 to verify your application (an <em>advocate</em>).  After you have
222 contributed to Debian for a while, and you want to apply to become a
223 registered developer, an existing developer with whom you
224 have worked over the past months has to express his belief that you
225 can contribute to Debian successfully.
226         <p>
227 When you have found an advocate, have your GnuPG key signed and have
228 already contributed to Debian for a while, you're ready to apply.
229 You can simply register on our <url id="&url-newmaint-apply;"
230 name="application page">.  After you have signed up, your advocate
231 has to confirm your application.  When your advocate has completed
232 this step you will be assigned an Application Manager who will
233 go with you through the necessary steps of the New Maintainer process.
234 You can always check your status on the <url id="&url-newmaint-db;"
235 name="applications status board">.
236         <p>
237 For more details, please consult <url id="&url-newmaint;" name="New
238 Maintainer's Corner"> at the Debian web site.  Make sure that you
239 are familiar with the necessary steps of the New Maintainer process
240 before actually applying.  If you are well prepared, you can save
241 a lot of time later on.
242
243
244       <sect id="mentors">Debian mentors and sponsors
245         <p>
246 The mailing list &email-debian-mentors; has been set up for novice
247 maintainers who seek help with initial packaging and other
248 developer-related issues.  Every new developer is invited to subscribe
249 to that list (see <ref id="mailing-lists"> for details).
250         <p>
251 Those who prefer one-on-one help (e.g., via private email) should also
252 post to that list and an experienced developer will volunteer to help.
253         <p>
254 In addition, if you have some packages ready for inclusion in Debian,
255 but are waiting for your new maintainer application to go through, you
256 might be able find a sponsor to upload your package for you.  Sponsors
257 are people who are official Debian maintainers, and who are willing to
258 criticize and upload your packages for you.  Those who are seeking a
259 sponsor can request one at <url id="&url-sponsors;">.
260         <p>
261 If you wish to be a mentor and/or sponsor, more information is
262 available in <ref id="newmaint">.
263
264
265     <chapt id="developer-duties">Debian Developer's Duties
266
267       <sect id="user-maint">Maintaining your Debian information
268         <p>
269 There's a LDAP database containing information about Debian developers at
270 <url id="&url-debian-db;">. You should enter your information there and
271 update it as it changes. Most notably, make sure that the address where your
272 debian.org email gets forwarded to is always up to date, as well as the
273 address where you get your debian-private subscription if you choose to
274 subscribe there.
275         <p>
276 For more information about the database, please see <ref id="devel-db">.
277
278
279
280       <sect id="key-maint">Maintaining your public key
281         <p>
282 Be very careful with your private keys.  Do not place them on any
283 public servers or multiuser machines, such as the Debian servers
284 (see <ref id="server-machines">).  Back your keys up; keep a copy offline.
285 Read the documentation that comes with your software; read the <url
286 id="&url-pgp-faq;" name="PGP FAQ">.
287         <p>
288 If you add signatures to your public key, or add user identities, you
289 can update the Debian key ring by sending your key to the key server at
290 <tt>&keyserver-host;</tt>.  If you need to add a completely new key,
291 or remove an old key, send mail to &email-debian-keyring;.  The same
292 key extraction routines discussed in <ref id="registering"> apply.
293         <p>
294 You can find a more in-depth discussion of Debian key maintenance in
295 the documentation of the <package>debian-keyring</package> package.
296
297
298        <sect id="voting">Voting
299         <p>
300 Even though Debian isn't really a democracy, we use a democratic
301 process to elect our leaders and to approve general resolutions.
302 These procedures are defined by the
303 <url id="&url-constitution;" name="Debian Constitution">.
304         <p>
305 Other than the yearly leader election, votes are not routinely held, and
306 they are not undertaken lightly. Each proposal is first discussed on
307 the &email-debian-vote; mailing list and it requires several endorsements
308 before the project secretary starts the voting procedure.
309         <p>
310 You don't have to track the pre-vote discussions, as the secretary will
311 issue several calls for votes on &email-debian-devel-announce; (and all
312 developers are expected to be subscribed to that list). Democracy doesn't
313 work well if people don't take part in the vote, which is why we encourage
314 all developers to vote. Voting is conducted via GPG-signed/encrypted emails
315 messages.
316         <p>
317 The list of all the proposals (past and current) is available on the
318 <url id="&url-vote;" name="Debian Voting Information"> page, along with
319 information on how to make, second and vote on proposals.
320
321
322       <sect id="inform-vacation">Going on vacation gracefully
323         <p>
324 It is common for developers to have periods of absence, whether those are
325 planned vacations or simply being buried in other work. The important thing
326 to notice is that the other developers need to know that you're on vacation
327 so that they can do whatever is needed if a problem occurs with your
328 packages or other duties in the project.
329         <p>
330 Usually this means that other developers are allowed to NMU (see
331 <ref id="nmu">) your package if a big problem (release critical bugs,
332 security update, etc.) occurs while you're on vacation. Sometimes it's
333 nothing as critical as that, but it's still appropriate to let the others
334 know that you're unavailable.
335         <p>
336 In order to inform the other developers, there's two things that you should do.
337 First send a mail to &email-debian-private; with "[VAC] " prepended to the
338 subject of your message<footnote>This is so that the message can be easily
339 filtered by people who don't want to read vacation notices.</footnote>
340 and state the period of time when you will be on vacation. You can also give
341 some special instructions on what to do if a problem occurs.
342         <p>
343 The other thing to do is to mark yourself as "on vacation" in the
344 <qref id="devel-db">Debian developers' LDAP database</qref> (this
345 information is only accessible to Debian developers).
346 Don't forget to remove the "on vacation" flag when you come back!
347
348
349       <sect id="upstream-coordination">Coordination with upstream developers
350         <p>
351 A big part of your job as Debian maintainer will be to stay in contact
352 with the upstream developers.  Debian users will sometimes report bugs
353 to the Bug Tracking System that are not specific to Debian.  You
354 must forward these bug reports to the upstream developers so that
355 they can be fixed in a future release.  It's not your job to fix
356 non-Debian specific bugs.  However, if you are able to do so, you are
357 encouraged to contribute to upstream development of the package by
358 providing a fix for the bug.  Debian users and developers will often
359 submit patches to fix upstream bugs, and you should evaluate and
360 forward these patches upstream.
361         <p>
362 If you need to modify the upstream sources in order to build a policy
363 compliant package, then you should propose a nice fix to the upstream
364 developers which can be included there, so that you won't have to
365 modify the sources of the next upstream version. Whatever changes you
366 need, always try not to fork from the upstream sources.
367
368
369       <sect id="rc-bugs">Managing release-critical bugs
370         <p>
371 Generally you should deal with bug reports on your packages as described in
372 <ref id="bug-handling">. However, there's a special category of bugs that
373 you need to take care of -- the so-called release-critical bugs (RC bugs).
374 All bug reports that have severity <em>critical</em>, <em>grave</em> or
375 <em>serious</em> are considered to have an impact on whether the package can
376 be released in the next stable release of Debian.
377 Those bugs can delay the Debian release
378 and/or can justify the removal of a package at freeze time. That's why
379 these bugs need to be corrected as quickly as possible.
380         <p>
381 Developers who are part of the <url id="&url-debian-qa;"
382 name="Quality Assurance"> group are following all such bugs, and trying
383 to help whenever possible. If, for any reason, you aren't able fix an
384 RC bug in a package of yours within 2 weeks, you should either ask for help
385 by sending a mail to the Quality Assurance (QA) group
386 &email-debian-qa;, or explain your difficulties and present a plan to fix
387 them by sending a mail to the bug report. Otherwise, people
388 from the QA group may want to do a Non-Maintainer Upload (see
389 <ref id="nmu">) after trying to contact you (they might not wait as long as
390 usual before they do their NMU if they have seen no recent activity from you
391 in the BTS).
392
393
394       <sect>Retiring
395         <p>
396 If you choose to leave the Debian project, you should make sure you do
397 the following steps:
398 <enumlist>
399             <item>
400 Orphan all your packages, as described in <ref id="orphaning">.
401             <item>
402 Send an email about why you are leaving the project to
403 &email-debian-private;.
404             <item>
405 Notify the Debian key ring maintainers that you are leaving by
406 emailing to &email-debian-keyring;.
407 </enumlist>
408
409
410
411    <chapt id="resources">Resources for Debian Developers
412      <p>
413 In this chapter you will find a very brief road map of the Debian
414 mailing lists, the Debian machines
415 which may be available to you as a developer, and all the other
416 resources that are available to help you in your maintainer work.
417
418       <sect id="mailing-lists">Mailing lists
419         <p>
420 The mailing list server is at <tt>&lists-host;</tt>.
421         <p>
422 Online archives of mailing lists are available at <url
423 id="&url-lists-archives;">.
424
425         <sect1 id="core-devel-mailing-lists">Core development mailing lists
426         <p>
427 The core Debian mailing lists that developers should use are:
428 <list>
429   <item>&email-debian-devel-announce;, used to announce important things to
430         developers.
431         All developers are expected to be subscribed to this list.
432   </item>
433   <item>&email-debian-devel;, used to discuss various development related
434         technical issues.
435   </item>
436   <item>&email-debian-policy;, where the Debian Policy is discussed and
437         voted on.
438   </item>
439   <item>&email-debian-project;, used to discuss various non-technical
440         issues related to the project.
441   </item>
442 </list>
443         <p>
444 There are
445 other mailing lists available for a variety of special topics; see
446 <url id="&url-debian-lists-subscribe;"> for a list.
447
448         <sect1 id="mailing-lists-subunsub">Subscribing and unsubscribing
449         <p>
450 To subscribe to or unsubscribe from any of the Debian mailing lists, email
451 <tt>debian-<var>foo</var>-REQUEST@&lists-host;</tt>, where
452 <tt>debian-<var>foo</var></tt> is the name of the list, with the word
453 <tt>subscribe</tt> in the <em>Subject</em> to subscribe to the list or
454 <tt>unsubscribe</tt> to unsubscribe.
455         <p>
456 If you prefer to use a web page to subscribe to multiple mailing lists,
457 there's one at <url id="&url-debian-lists-subscribe;">.
458         <p>
459 You can download the current list of mailing lists and basic usage
460 instructions from <url id="&url-debian-lists-txt;">
461 or install the <package>doc-debian</package> package and have it
462 locally in &file-mail-lists;.
463
464         <sect1 id="mailing-lists-rules">Basic rules for use
465         <p>
466 When replying to messages on the mailing list, please do not send a
467 carbon copy (<tt>CC</tt>) to the original poster unless they explicitly
468 request to be copied.  Anyone who posts to a mailing list should read
469 it to see the responses.
470         <p>
471 Cross-posting (sending the same message to multiple lists) is discouraged.
472 As ever on the net, please trim down the quoting of articles you're
473 replying to.  In general, please adhere to the usual conventions for
474 posting messages.
475         <p>
476 Please read the <url name="code of conduct" id="&url-debian-lists;">
477 for more information.
478
479         <sect1 id="mailing-lists-special">Special lists
480         <p>
481 &email-debian-private; is a special mailing list for private
482 discussions amongst Debian developers.  It is meant to be used for
483 posts which for whatever reason should not be published publicly.
484 As such, it is a low volume list, and users are urged not to use
485 &email-debian-private; unless it is really necessary.  Moreover, do
486 <em>not</em> forward email from that list to anyone.  Archives of this
487 list are not available on the web for obvious reasons, but you can see
488 them using your shell account on <tt>lists.debian.org</tt> and looking
489 in the <file>~debian/archive/debian-private</file> directory.
490         <p>
491 &email-debian-email; is a special mailing list used as a grab-bag 
492 for Debian related correspondence such as contacting upstream authors
493 about licenses, bugs, etc. or discussing the project with others where it
494 might be useful to have the discussion archived somewhere.
495
496
497       <sect id="irc-channels">IRC channels
498         <p>
499 Several IRC channels are dedicated to Debian's development. They are mainly
500 hosted on the <url id="&url-openprojects;" name="freenode"> network
501 (previously known as Open Projects Network).
502 The <tt>irc.debian.org</tt> DNS entry is an alias to
503 <tt>irc.freenode.net</tt>.
504         <p>
505 The main channel for Debian in general is <em>#debian</em>. This is a large,
506 general-purpose channel where users can find recent news in the topic and
507 served by bots. <em>#debian</em> is for English speakers; there are also
508 <em>#debian.de</em>, <em>#debian-fr</em>, <em>#debian-br</em> and other
509 similarly named channels for speakers of other languages.
510         <p>
511 The main channel for Debian development is <em>#debian-devel</em>.
512 It is a very active channel since usually over 150 people are always
513 logged in. It's a channel for people who work
514 on Debian, it's not a support channel (there's <em>#debian</em> for that).
515 It is however open to anyone who wants to lurk (and learn). Its topic is
516 commonly full of interesting information for developers.
517         <p>
518 Since <em>#debian-devel</em> it's an open channel, you
519 should not speak there of issues that are discussed in
520 &email-debian-private;. There's another channel for this purpose,
521 it's called <em>#debian-private</em> and it's protected by a key.
522 This key is available in the archives of debian-private in
523 <file>master.debian.org:&file-debian-private-archive;</file>,
524 just <prgn>zgrep</prgn> for <em>#debian-private</em> in
525 all the files.
526         <p>
527 There are other additional channels dedicated to specific subjects.
528 <em>#debian-bugs</em> is used for coordinating bug squash parties.
529 <em>#debian-boot</em> is used to coordinate the work on the boot
530 floppies (i.e., the installer). <em>#debian-doc</em> is
531 occasionally used to talk about documentation, like the document you are
532 reading. Other channels are dedicated to an architecture or a set of
533 packages: <em>#debian-bsd</em>, <em>#debian-kde</em>, <em>#debian-jr</em>,
534 <em>#debian-edu</em>,
535 <em>#debian-sf</em> (SourceForge package), <em>#debian-oo</em> (OpenOffice
536 package) ...
537         <p>
538 Some non-English developers' channels exist as well, for example
539 <em>#debian-devel-fr</em> for
540 French speaking people interested in Debian's development.
541         <p>
542 Channels dedicated to Debian also exist on other IRC networks, notably on
543 the <url name="Open and free technology community (OFTC)"
544 id="http://www.oftc.net/"> IRC network.
545
546
547       <sect id="doc-rsrcs">Documentation
548         <p>
549 This document contains a lot of information very useful to Debian developers,
550 but it can not contain everything. Most of the other interesting documents
551 are linked from <url id="&url-devel-docs;" name="The Developers' Corner">.
552 Take the time to browse all the links, you will learn many more things.
553
554
555       <sect id="server-machines">Debian machines
556         <p>
557 Debian has several computers working as servers, most of which serve
558 critical functions in the Debian project. Most of the machines are used
559 for porting activities, and they all have a permanent connection to the
560 Internet.
561         <p>
562 Most of the machines are available for individual developers to use,
563 as long as the developers follow the rules set forth in the
564 <url name="Debian Machine Usage Policies" id="&url-dmup;">.
565         <p>
566 Generally speaking, you can use these machines for Debian-related purposes
567 as you see fit.  Please be kind to system administrators, and do not use
568 up tons and tons of disk space, network bandwidth, or CPU without first
569 getting the approval of the system administrators.  Usually these machines are run by
570 volunteers.
571         <p>
572 Please take care to protect your Debian passwords and SSH keys installed on
573 Debian machines. Avoid login or upload methods which send passwords over
574 the Internet in the clear, such as telnet, FTP, POP etc.
575         <p>
576 Please do not put any material that doesn't relate to Debian on the Debian
577 servers, unless you have prior permission.
578         <p>
579 The current list of Debian machines is available at
580 <url id="&url-devel-machines;">. That web page contains machine names,
581 contact information, information about who can log in, SSH keys etc.
582         <p>
583 If you have a problem with the operation of a Debian server, and you
584 think that the system operators need to be notified of this problem,
585 the Debian system administrator team is reachable at
586 <email>debian-admin@lists.debian.org</email>.
587         <p>
588 If you have a problem with a certain service, not related to the system
589 administration (such as packages to be removed from the archive,
590 suggestions for the web site, etc.),
591 generally you'll report a bug against a ``pseudo-package''.  See <ref
592 id="submit-bug"> for information on how to submit bugs.
593
594       <sect1 id="servers-bugs">The bugs server
595         <p>
596 <tt>&bugs-host;</tt> is the canonical location for the Bug Tracking
597 System (BTS).  If you plan on doing some statistical analysis or
598 processing of Debian bugs, this would be the place to do it.  Please
599 describe your plans on &email-debian-devel; before implementing
600 anything, however, to reduce unnecessary duplication of effort or
601 wasted processing time.
602         <p>
603 All Debian developers have accounts on <tt>&bugs-host;</tt>.
604
605       <sect1 id="servers-ftp-master">The ftp-master server
606         <p>
607 The <tt>ftp-master.debian.org</tt> server holds the canonical copy of the Debian
608 archive (excluding the non-US packages). Generally, package uploads
609 go to this server; see <ref id="upload">.
610         <p>
611 Problems with the Debian FTP archive generally need to be reported as
612 bugs against the <package>ftp.debian.org</package> pseudo-package or
613 an email to &email-ftpmaster;, but also see the procedures in
614 <ref id="archive-manip">.
615
616       <sect1 id="servers-non-us">The non-US server
617         <p>
618 The non-US server, <tt>non-us.debian.org</tt>,
619 holds the canonical copy of the non-US part of the Debian archive.
620 If you need to upload a package into one of the non-US sections, upload it
621 to this server; see <ref id="upload-non-us">.
622         <p>
623 Problems with the non-US package archive should generally be submitted as
624 bugs against the <package>nonus.debian.org</package> pseudo-package (notice
625 the lack of hyphen between "non" and "us" in the pseudo-package name
626 &mdash; that's for backwards compatibility). Remember to check whether or
627 not someone else has already reported the problem on the
628 <url id="http://&bugs-host;/nonus.debian.org" name="Bug Tracking System">.
629
630       <sect1 id="servers-www">The www-master server
631         <p>
632 The main web server is <tt>www-master.debian.org</tt>.
633 It holds the official web pages, the face
634 of Debian for most newbies.
635         <p>
636 If you find a problem with the Debian web server, you should generally
637 submit a bug against the pseudo-package,
638 <package>www.debian.org</package>. Remember to check whether or not someone
639 else has already reported the problem on the
640 <url id="http://&bugs-host;/www.debian.org" name="Bug Tracking System">.
641
642       <sect1 id="servers-people">The people web server
643         <p>
644 <tt>people.debian.org</tt> is the server used
645 for developers' own web pages about anything related to Debian.
646         <p>
647 If you have some Debian-specific information which you want to serve
648 on the web, you can do this by putting material in the
649 <file>public_html</file> directory under your home directory on
650 <tt>people.debian.org</tt>.
651 This will be accessible at the URL
652 <tt>http://people.debian.org/~<var>your-user-id</var>/</tt>.
653         <p>
654 You should only use this particular location because it will be backed up,
655 whereas on other hosts it won't.
656         <p>
657 Usually the only reason to use a different host is when you need to publish
658 materials subject to the U.S. export restrictions, in which case you can use
659 one of the other servers located outside the United States, such as the
660 aforementioned <tt>non-us.debian.org</tt>.
661         <p>
662 Send mail to &email-debian-devel; if you have any questions.
663
664       <sect1 id="servers-cvs">The CVS server
665         <p>
666 Our CVS server is located on <tt>cvs.debian.org</tt>.
667         <p>
668 If you need to use a publicly accessible CVS
669 server, for instance, to help coordinate work on a package between
670 many different developers, you can request a CVS area on the server.
671           <p>
672 Generally, <tt>cvs.debian.org</tt> offers a combination of local CVS
673 access, anonymous client-server read-only access, and full
674 client-server access through <prgn>ssh</prgn>.  Also, the CVS area can
675 be accessed read-only via the Web at <url id="&url-cvsweb;">.
676         <p>
677 To request a CVS area, send a request via email to
678 &email-debian-admin;.  Include the name of the requested CVS area,
679 the Debian account that should own the CVS root area, and why you need it.
680
681
682     <sect id="devel-db">The Developers Database
683         <p>
684 The Developers Database, at <url id="&url-debian-db;">, is an LDAP
685 directory for managing Debian developer attributes.  You can use this
686 resource to search the list of Debian developers.
687 Part of this information is also available through
688 the finger service on Debian servers, try
689 <prgn>finger yourlogin@db.debian.org</prgn> to see what it reports.
690         <p>
691 Developers can <url name="log into the database" id="&url-debian-db-login;">
692 to change various information about themselves, such as:
693 <list>
694         <item>forwarding address for your debian.org email
695         <item>subscription to debian-private
696         <item>whether you are on vacation
697         <item>personal information such as your address, country,
698               the latitude and longitude of the place where you live
699               for use in <url name="the world map of Debian developers"
700               id="&url-worldmap;">, phone and fax numbers, IRC nickname
701               and web page
702         <item>password and preferred shell on Debian Project machines
703 </list>
704         <p>
705 Most of the information is not accessible to the public, naturally.
706 For more information please read the online documentation that you can find
707 at <url id="&url-debian-db-doc;">.
708         <p>
709 One can also submit their SSH keys to be used for authorization on the
710 official Debian machines, and even add new *.debian.net DNS entries.
711 Those features are documented at <url id="&url-debian-db-mail-gw;">.
712
713
714     <sect id="archive">The Debian archive
715         <p>
716 The &debian-formal; distribution consists of a lot of packages
717 (<file>.deb</file>'s, currently around &number-of-pkgs;) and a few
718 additional files (such documentation and installation disk images).
719         <p>
720 Here is an example directory tree of a complete Debian archive:
721         <p>
722 &sample-dist-dirtree;
723         <p>
724 As you can see, the top-level directory contains two directories,
725 <file>dists/</file> and <file>pool/</file>. The latter is a &ldquo;pool&rdquo; in which the
726 packages actually are, and which is handled by the archive maintenance
727 database and the accompanying programs. The former contains the
728 distributions, <em>stable</em>, <em>testing</em> and <em>unstable</em>.
729 The <file>Packages</file> and <file>Sources</file> files in the
730 distribution subdirectories can reference files in the <file>pool/</file>
731 directory. The directory tree below each of the distributions is arranged
732 in an identical manner.  What we describe below for <em>stable</em> is
733 equally applicable to the <em>unstable</em> and <em>testing</em>
734 distributions. 
735         <p>
736 <file>dists/stable</file> contains three directories, namely <file>main</file>,
737 <file>contrib</file>, and <file>non-free</file>. 
738         <p>
739 In each of the areas, there is a directory for the source packages
740 (<file>source</file>) and a directory for each supported architecture
741 (<file>binary-i386</file>, <file>binary-m68k</file>, etc.).
742         <p>
743 The <file>main</file> area contains additional directories which holds
744 the disk images and some essential pieces of documentation required
745 for installing the Debian distribution on a specific architecture
746 (<file>disks-i386</file>, <file>disks-m68k</file>, etc.).
747
748
749       <sect1>Sections
750         <p>
751 The <em>main</em> section of the Debian archive is what makes up the
752 <strong>official &debian-formal; distribution</strong>.  The
753 <em>main</em> section is official because it fully complies with all
754 our guidelines.  The other two sections do not, to different degrees;
755 as such, they are <strong>not</strong> officially part of
756 &debian-formal;.
757         <p>
758 Every package in the main section must fully comply with the <url
759 id="&url-dfsg;" name="Debian Free Software Guidelines"> (DFSG) and
760 with all other policy requirements as described in the <url
761 id="&url-debian-policy;" name="Debian Policy Manual">.  The DFSG is
762 our definition of &ldquo;free software.&rdquo;  Check out the Debian Policy
763 Manual for details.
764         <p>
765 Packages in the <em>contrib</em> section have to comply with the DFSG,
766 but may fail other requirements.  For instance, they may depend on
767 non-free packages.
768         <p>
769 Packages which do not conform to the DFSG are placed in the
770 <em>non-free</em> section. These packages are not considered as part
771 of the Debian distribution, though we support their use, and we
772 provide infrastructure (such as our bug-tracking system and mailing
773 lists) for non-free software packages.
774         <p>
775 The <url id="&url-debian-policy;" name="Debian Policy Manual">
776 contains a more exact definition of the three sections. The above
777 discussion is just an introduction.
778         <p>
779 The separation of the three sections at the top-level of the archive
780 is important for all people who want to distribute Debian, either via
781 FTP servers on the Internet or on CD-ROMs: by distributing only the
782 <em>main</em> and <em>contrib</em> sections, one can avoid any legal
783 risks.  Some packages in the <em>non-free</em> section do not allow
784 commercial distribution, for example.
785         <p>
786 On the other hand, a CD-ROM vendor could easily check the individual
787 package licenses of the packages in <em>non-free</em> and include as
788 many on the CD-ROMs as he's allowed to. (Since this varies greatly from
789 vendor to vendor, this job can't be done by the Debian developers.)
790         <p>
791 Note also that the term "section" is also used to refer to categories
792 which simplify the organization and browsing of available packages, e.g.
793 <em>admin</em>, <em>net</em>, <em>utils</em> etc. Once upon a time, these
794 sections (subsections, rather) existed in the form of subdirectories within
795 the Debian archive. Nowadays, these exist only in the "Section" header
796 fields of packages.
797
798
799       <sect1>Architectures
800         <p>
801 In the first days, the Linux kernel was only available for the Intel
802 i386 (or greater) platforms, and so was Debian. But when Linux became
803 more and more popular, the kernel was ported to other architectures,
804 too.
805         <p>
806 The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola
807 680x0 (like Atari, Amiga and Macintoshes), MIPS, and PowerPC.  The
808 Linux 2.2 kernel supports even more architectures, including ARM and
809 UltraSPARC.  Since Linux supports these platforms, Debian decided that
810 it should, too.  Therefore, Debian has ports underway; in fact, we
811 also have ports underway to non-Linux kernel.  Aside from
812 <em>i386</em> (our name for Intel x86), there is <em>m68k</em>,
813 <em>alpha</em>, <em>powerpc</em>, <em>sparc</em>, <em>hurd-i386</em>,
814 <em>arm</em>, <em>ia64</em>, <em>hppa</em>, <em>s390</em>, <em>mips</em>,
815 <em>mipsel</em> and <em>sh</em> as of this writing.
816         <p>
817 &debian-formal; 1.3 is only available as <em>i386</em>.  Debian 2.0
818 shipped for <em>i386</em> and <em>m68k</em> architectures.  Debian 2.1
819 ships for the <em>i386</em>, <em>m68k</em>, <em>alpha</em>, and
820 <em>sparc</em> architectures.  Debian 2.2 added support for the
821 <em>powerpc</em> and <em>arm</em> architectures. Debian 3.0 adds
822 support of five new architectures: <em>ia64</em>, <em>hppa</em>,
823 <em>s390</em>, <em>mips</em> and <em>mipsel</em>.
824         <p>
825 Information for developers or uses about the specific ports are
826 available at the <url id="&url-debian-ports;" name="Debian Ports web
827 pages">.
828
829
830
831       <sect1>Packages
832         <p>
833 There are two types of Debian packages, namely <em>source</em> and
834 <em>binary</em> packages.
835         <p>
836 Source packages consist of either two or three files: a <file>.dsc</file>
837 file, and either a <file>.tar.gz</file> file or both an
838 <file>.orig.tar.gz</file> and a <file>.diff.gz</file> file.
839         <p>
840 If a package is developed specially for Debian and is not distributed
841 outside of Debian, there is just one <file>.tar.gz</file> file which
842 contains the sources of the program.  If a package is distributed
843 elsewhere too, the <file>.orig.tar.gz</file> file stores the so-called
844 <em>upstream source code</em>, that is the source code that's
845 distributed from the <em>upstream maintainer</em> (often the author of
846 the software). In this case, the <file>.diff.gz</file> contains the
847 changes made by the Debian maintainer.
848         <p>
849 The <file>.dsc</file> file lists all the files in the source package together
850 with checksums (<prgn>md5sums</prgn>) and some additional info about
851 the package (maintainer, version, etc.).
852
853
854       <sect1>Distributions
855         <p>
856 The directory system described in the previous chapter is itself
857 contained within <em>distribution directories</em>.  Each
858 distribution is actually contained in the <file>pool</file> directory in the
859 top-level of the Debian archive itself.
860         <p>
861 To summarize, the Debian archive has a root directory within an FTP
862 server.  For instance, at the mirror site,
863 <ftpsite>ftp.us.debian.org</ftpsite>, the Debian archive itself is
864 contained in <ftppath>/debian</ftppath>, which is a common location
865 (another is <file>/pub/debian</file>).
866         <p>
867 A distribution is comprised of Debian source and binary packages, and the
868 respective <file>Sources</file> and <file>Packages</file> index files, containing
869 the header information from all those packages. The former are kept in the
870 <file>pool/</file> directory, while the latter are kept in the <file>dists/</file>
871 directory of the archive (for backwards compatibility).
872
873
874         <sect2 id="sec-dists">Stable, testing, and unstable
875         <p>
876 There are always distributions called <em>stable</em> (residing in
877 <file>dists/stable</file>), one called <em>testing</em> (residing in
878 <file>dists/testing</file>), and one called <em>unstable</em> (residing in
879 <file>dists/unstable</file>). This reflects the development process of the
880 Debian project.
881         <p>
882 Active development is done in the <em>unstable</em> distribution
883 (that's why this distribution is sometimes called the <em>development
884 distribution</em>). Every Debian developer can update his or her
885 packages in this distribution at any time. Thus, the contents of this
886 distribution changes from day-to-day. Since no special effort is done
887 to make sure everything in this distribution is working properly, it is
888 sometimes literally unstable.
889         <p>
890 <ref id="testing"> is generated automatically by taking
891 packages from unstable if they satisfy certain criteria. Those
892 criteria should ensure a good quality for packages within testing.
893 The update to testing is launched each day after the
894 new packages have been installed.
895         <p>
896 After a period of development, once the release manager deems fit, the
897 <em>testing</em> distribution is frozen, meaning that the policies
898 which control how packages move from <em>unstable</em> to <em>testing</em> are
899 tightened.  Packages which are too buggy are removed.  No changes are
900 allowed into <em>testing</em> except for bug fixes.  After some time
901 has elapsed, depending on progress, the <em>testing</em> distribution
902 goes into a `deep freeze', when no changes are made to it except those
903 needed for the installation system.  This is called a &ldquo;test cycle&rdquo;,
904 and it can last up to two weeks. There can be several test cycles,
905 until the distribution is prepared for release, as decided by the
906 release manager.  At the end of the last test cycle, the
907 <em>testing</em> distribution is renamed to <em>stable</em>,
908 overriding the old <em>stable</em> distribution, which is removed at
909 that time (although it can be found at <tt>&archive-host;</tt>).
910         <p>
911 This development cycle is based on the assumption that the
912 <em>unstable</em> distribution becomes <em>stable</em> after passing a
913 period of being in <em>testing</em>.  Even once a distribution is
914 considered stable, a few bugs inevitably remain &mdash; that's why the
915 stable distribution is updated every now and then. However, these
916 updates are tested very carefully and have to be introduced into the
917 archive individually to reduce the risk of introducing new bugs.  You
918 can find proposed additions to <em>stable</em> in the
919 <file>proposed-updates</file> directory.  Those packages in
920 <file>proposed-updates</file> that pass muster are periodically moved as a
921 batch into the stable distribution and the revision level of the
922 stable distribution is incremented (e.g., &lsquo;3.0&rsquo; becomes
923 &lsquo;3.0r1&rsquo;, &lsquo;2.2r4&rsquo; becomes &lsquo;2.2r5&rsquo;, and
924 so forth).
925         <p>
926 Note that development under <em>unstable</em> continues during the
927 freeze period, since the <em>unstable</em> distribution remains in
928 place in parallel with <em>testing</em>.
929
930     <sect2 id="testing">
931         <heading>More information about the testing distribution</heading>
932         <p>
933 The scripts that update the <em>testing</em> distribution are run each
934 day after the installation of the updated packages. They generate the
935 <file>Packages</file> files for the <em>testing</em> distribution, but
936 they do so in an intelligent manner trying to avoid any inconsistency
937 and trying to use only non-buggy packages.
938         <p>
939 The inclusion of a package from <em>unstable</em> is conditional on
940 the following:
941 <list>
942     <item>
943 The package must have been available in <em>unstable</em> for several days;
944 the precise number depends on the upload's urgency field. It
945 is 10 days for low urgency, 5 days for medium urgency and 2 days for high
946 urgency. Those delays may be doubled during a freeze;
947     <item>
948 It must have less release-critical bugs than the version available
949 in <em>testing</em>;
950     <item>
951 It must be available on all architectures on which it has been
952 previously built. <ref id="madison"> may be of interest to
953 check that information;
954     <item>
955 It must not break any dependency of a package that is already available
956 in <em>testing</em>;
957     <item>
958 The packages on which it depends must either be available in <em>testing</em>
959 or they must be accepted into <em>testing</em> at the same time (and they will
960 if they respect themselves all the criteria);
961 </list>
962         <p>
963 To find out whether a package is progressing into testing or not, see the
964 testing script output on the <url name="web page of the testing distribution"
965 id="&url-testing-maint;">, or use the program <prgn>grep-excuses</prgn>
966 which is in the <package>devscripts</package> package. This utility can
967 easily be used in a <manref name="crontab" section="5"> to keep one
968 informed of the progression of their packages into <em>testing</em>.
969         <p>
970 The <file>update_excuses</file> file does not always give the precise reason
971 why the package is refused, one may have to find it on their own by looking
972 what would break with the inclusion of the package. The <url
973 id="&url-testing-maint;" name="testing web page"> gives some more information
974 about the usual problems which may be causing such troubles.
975         <p>
976 Sometimes, some packages never enter <em>testing</em> because the set of
977 inter-relationship is too complicated and can not be sorted out
978 by the scripts. In that case, the release manager must be
979 contacted, and he will force the inclusion of the packages.
980         <p>
981 In general, please refer to the <url name="testing web page"
982 id="&url-testing-maint;"> for more information. It also includes
983 answers to some of the frequently asked questions.
984
985
986         <sect2 id="experimental">Experimental
987           <p>
988 The <em>experimental</em> distribution is a special distribution.
989 It is not a full distribution in the same sense as `stable' and
990 `unstable' are.  Instead, it is meant to be a temporary staging area
991 for highly experimental software where there's a good chance that the
992 software could break your system, or software that's just too unstable
993 even for the <em>unstable</em> distribution (but there is a reason to
994 package it nevertheless).  Users who download and install
995 packages from <em>experimental</em> are expected to have been duly
996 warned.  In short, all bets are off for the <em>experimental</em>
997 distribution.
998           <p>
999 These are the <manref name="sources.list" section="5"> lines for
1000 <em>experimental</em>:
1001 <example>
1002 deb http://ftp.<var>xy</var>.debian.org/debian/ ../project/experimental main
1003 deb-src http://ftp.<var>xy</var>.debian.org/debian/ ../project/experimental main
1004 </example>
1005           <p>
1006 If there is a chance that the software could do grave damage to a system,
1007 it is likely to be better to put it into <em>experimental</em>.
1008 For instance, an experimental compressed file system should probably go
1009 into <em>experimental</em>.
1010           <p>
1011 Whenever there is a new upstream version of a package that introduces new
1012 features but breaks a lot of old ones, it should either not be uploaded, or
1013 be uploaded to <em>experimental</em>. A new, beta, version of some software
1014 which uses completely different configuration can go into
1015 <em>experimental</em>, at the maintainer's discretion. If you are working
1016 on an incompatible or complex upgrade situation, you can also use
1017 <em>experimental</em> as a staging area, so that testers can get early
1018 access.
1019           <p>
1020 Some experimental software can still go into <em>unstable</em>, with a few
1021 warnings in the description, but that isn't recommended because packages
1022 from <em>unstable</em> are expected to propagate to <em>testing</em> and
1023 thus to <em>stable</em>. You should not be afraid to use
1024 <em>experimental</em> since it does not cause any pain to the ftpmasters,
1025 the experimental packages are automatically removed once you upload
1026 the package in <em>unstable</em> with a higher version number.
1027           <p>
1028 New software which isn't likely to damage your system can go directly into
1029 <em>unstable</em>.
1030           <p>
1031 An alternative to <em>experimental</em> is to use your personal web space
1032 on <tt>people.debian.org</tt>.
1033
1034
1035       <sect1 id="codenames">Release code names
1036         <p>
1037 Every released Debian distribution has a <em>code name</em>: Debian
1038 1.1 is called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0,
1039 `hamm'; Debian 2.1, `slink'; Debian 2.2, `potato'; and Debian 3.0, `woody'.  There is also
1040 a ``pseudo-distribution'', called `sid', which is the current
1041 `unstable' distribution; since packages are moved from `unstable' to
1042 `testing' as they approach stability, `sid' itself is never released.
1043 As well as the usual contents of a Debian distribution, `sid' contains
1044 packages for architectures which are not yet officially supported or
1045 released by Debian.  These architectures are planned to be integrated
1046 into the mainstream distribution at some future date.
1047         <p>
1048 Since Debian has an open development model (i.e., everyone can
1049 participate and follow the development) even the `unstable' and `testing'
1050 distributions are distributed to the Internet through the Debian FTP and
1051 HTTP server network. Thus, if we had called the directory which contains
1052 the release candidate version `testing', then we would have to rename it
1053 to `stable' when the version is released, which would cause all FTP
1054 mirrors to re-retrieve the whole distribution (which is quite large).
1055         <p>
1056 On the other hand, if we called the distribution directories
1057 <em>Debian-x.y</em> from the beginning, people would think that Debian
1058 release <em>x.y</em> is available. (This happened in the past, where a
1059 CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0 development
1060 version. That's the reason why the first official Debian release was
1061 1.1, and not 1.0.)
1062         <p>
1063 Thus, the names of the distribution directories in the archive are
1064 determined by their code names and not their release status (e.g.,
1065 `slink').  These names stay the same during the development period and
1066 after the release; symbolic links, which can be changed easily,
1067 indicate the currently released stable distribution.  That's why the
1068 real distribution directories use the <em>code names</em>, while
1069 symbolic links for <em>stable</em>, <em>testing</em>, and
1070 <em>unstable</em> point to the appropriate release directories.
1071
1072
1073     <sect id="mirrors">Debian mirrors
1074         <p>
1075 The various download archives and the web site have several mirrors
1076 available in order to relieve our canonical servers from heavy load.
1077 In fact, some of the canonical servers aren't public, and instead a
1078 first tier of mirrors balances the load. That way, users always access
1079 the mirrors and get used to using them, which allows Debian to better
1080 spread its bandwidth requirements over several servers and networks,
1081 and basically makes users avoid hammering on one primary location.
1082 Note that the first tier of mirrors is as up-to-date as it can be since
1083 they update when triggered from the internal sites (we call this
1084 "push mirroring").
1085         <p>
1086 All the information on Debian mirrors, including a list of the available
1087 public FTP/HTTP servers, can be found at <url id="&url-debian-mirrors;">.
1088 This useful page also includes information and tools which can be helpful if
1089 you are interested in setting up your own mirror, either for internal or
1090 public access.
1091         <p>
1092 Note that mirrors are generally run by third-parties who are
1093 interested in helping Debian.  As such, developers generally do not
1094 have accounts on these machines.
1095
1096
1097     <sect id="incoming-system">
1098         <heading>The Incoming system
1099         <p>
1100 The Incoming system is responsible of collecting updated packages and
1101 installing them in the Debian archive. It consists of a set of
1102 directories and scripts that are installed both on <tt>&ftp-master-host;</tt>
1103 and <tt>&non-us-host;</tt>.
1104         <p>
1105 Packages are uploaded by all the maintainers into a directory called
1106 <file>unchecked</file>. This directory is scanned every 15 minutes by
1107 the <prgn>katie</prgn> script, which verifies the integrity of the uploaded packages and the cryptographic
1108 signatures.  If the package is considered ready to be installed, it
1109 is moved into the <file>accepted</file> directory. If this is the first upload of
1110 the package, it is moved in the <file>new</file> directory, where it waits
1111 for an approval of the ftpmasters. If the package contains files to be installed
1112 "by-hand" it is moved in the <file>byhand</file> directory, where it waits
1113 for a manual installation by the ftpmasters. Otherwise, if any error has been detected,
1114 the package is refused and is moved in the <file>reject</file> directory.
1115         <p>
1116 Once the package is accepted the system sends a confirmation
1117 mail to the maintainer, closes all the bugs marked as fixed by the upload
1118 and the auto-builders may start recompiling it. The package is now publicly
1119 accessible at <url id="&url-incoming;"> (there is no
1120 such URL for packages in the non-US archive) until it is really installed
1121 in the Debian archive. This happens only once a day, the package
1122 is then removed from incoming and installed in the pool along with all
1123 the other packages. Once all the other updates (generating new
1124 <file>Packages</file> and <file>Sources</file> index files for example) have been
1125 made, a special script is called to ask all the primary mirrors to update
1126 themselves.
1127         <p>
1128 The archive maintenance software will also send the OpenPGP/GnuPG signed
1129 <file>.changes</file> file that you uploaded to the appropriate mailing
1130 lists. If a package is released with the <tt>Distribution:</tt> set to
1131 `stable', the announcement is sent to &email-debian-changes;.
1132 If a package is released with <tt>Distribution:</tt> set to `unstable'
1133 or `experimental', the announcement will be posted to
1134 &email-debian-devel-changes; instead.
1135         <p>
1136 All Debian developers have write access to the <file>unchecked</file>
1137 directory in order to upload their packages, they also have that access
1138 to the <file>reject</file> directory in order to remove their bad uploads
1139 or to move some files back in the <file>unchecked</file> directory. But
1140 all the other directories are only writable by the ftpmasters, that is
1141 why you can not remove an upload once it has been accepted.
1142
1143       <sect1 id="delayed-incoming">Delayed incoming
1144         <p>
1145 The <file>unchecked</file> directory has a special <file>DELAYED</file>
1146 subdirectory. It is itself subdivided in nine directories
1147 called <file>1-day</file> to <file>9-day</file>. Packages which are uploaded in
1148 one of those directories will be moved in the real unchecked
1149 directory after the corresponding number of days.
1150 This is done by a script that is run each day and which moves the
1151 packages between the directories. Those which are in "1-day" are
1152 installed in <file>unchecked</file> while the others are moved in the 
1153 adjacent directory (for example, a package in <file>5-day</file> will
1154 be moved in <file>4-day</file>). This feature is particularly useful
1155 for people who are doing non-maintainer uploads. Instead of
1156 waiting before uploading a NMU, it is uploaded as soon as it is
1157 ready but in one of those <file>DELAYED/<var>x</var>-day</file> directories.
1158 That leaves the corresponding number of days for the maintainer
1159 to react and upload another fix themselves if they are not
1160 completely satisfied with the NMU. Alternatively they can remove
1161 the NMU.
1162         <p>
1163 The use of that delayed feature can be simplified with a bit
1164 of integration with your upload tool.  For instance, if you use 
1165 <prgn>dupload</prgn> (see <ref id="dupload">), you can add this
1166 snippet to your configuration file:
1167 <example>
1168 $delay = ($ENV{DELAY} || 7);
1169 $cfg{'delayed'} = {
1170          fqdn => "&ftp-master-host;",
1171          login => "yourdebianlogin",
1172          incoming => "/org/ftp.debian.org/incoming/DELAYED/$delay-day/",
1173          dinstall_runs => 1,
1174          method => "scpb"
1175 };
1176 </example>
1177 Once you've made that change, <prgn>dupload</prgn> can be used to
1178 easily upload a package in one of the delayed directories:
1179 <example>DELAY=5 dupload --to delayed &lt;changes-file&gt;</example>
1180
1181
1182
1183     <sect id="pkg-info">Package information
1184         <p>
1185
1186       <sect1 id="pkg-info-web">On the web
1187         <p>
1188 Each package has several dedicated web pages.
1189 <tt>http://&packages-host;/<var>package-name</var></tt>
1190 displays each version of the package
1191 available in the various distributions.  Each version links to a page
1192 which provides information, including the package description,
1193 the dependencies and package download links.
1194         <p>
1195 The bug tracking system track bugs for each package.  You can
1196 view the bugs of a given package at the URL
1197 <tt>http://&bugs-host;/<var>package-name</var></tt>.
1198
1199       <sect1 id="madison">The <prgn>madison</prgn> utility
1200         <p>
1201 <prgn>madison</prgn> is a command-line utility that is available
1202 on both <tt>&ftp-master-host;</tt> and <tt>&non-us-host;</tt>. It
1203 uses a single argument corresponding to a package name. In result
1204 it displays which version of the package is available for each
1205 architecture and distribution combination. An example will explain
1206 it better.
1207         <p>
1208 <example>
1209 $ madison libdbd-mysql-perl
1210 libdbd-mysql-perl |   1.2202-4 |        stable | source, alpha, arm, i386, m68k, powerpc, sparc
1211 libdbd-mysql-perl |   1.2216-2 |       testing | source, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
1212 libdbd-mysql-perl | 1.2216-2.0.1 |       testing | alpha
1213 libdbd-mysql-perl |   1.2219-1 |      unstable | source, alpha, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc
1214 </example>
1215         <p>
1216 In this example, you can see that the version in <em>unstable</em> differs from
1217 the version in <em>testing</em> and that there has been a binary-only NMU of the
1218 package for the alpha architecture. Each time the package has been
1219 recompiled on most of the architectures.
1220
1221     <sect id="pkg-tracking-system">The Package Tracking System
1222         <p>
1223 The Package Tracking System (PTS) is basically a tool to track by mail
1224 the activity of a source package. You just have to subscribe
1225 to a source package to start getting the mails related to it. 
1226 You get the same mails as the maintainer. Each mail
1227 sent through the PTS is classified and associated to one of
1228 the keyword listed below. This will let you select the mails that
1229 you want to receive.
1230         <p>
1231 By default you will get:
1232 <taglist>
1233     <tag><tt>bts</tt>
1234     <item>
1235 All the bug reports and following discussions.
1236
1237     <tag><tt>bts-control</tt>
1238     <item>
1239 The control mails notifying a status change in one of the bugs.
1240     
1241     <tag><tt>upload-source</tt>
1242     <item>
1243 The confirmation mail from <prgn>katie</prgn> when an uploaded source
1244 package is accepted.
1245
1246     <tag><tt>katie-other</tt>
1247     <item>
1248 Other warning and error mails from <prgn>katie</prgn> (like the
1249 override disparity for the section or priority field).
1250
1251     <tag><tt>default</tt>
1252     <item>
1253 Any non-automatic mail sent to the PTS by people who wanted to
1254 contact the subscribers of the package. This can be done by sending mail
1255 to <tt><var>srcpackage</var>@&pts-host;</tt>. In order to prevent spam,
1256 mails sent to these addresses must contain the header "X-PTS-Approved"
1257 with a non-empty string.
1258
1259
1260     <tag><tt>summary</tt>
1261     <item>
1262 In the future, you may receive regular summary mails to keep you
1263 informed of the package's status (bug statistics, porting overview,
1264 progression in <em>testing</em>, ...).
1265 </taglist>
1266         <p>
1267 You can also decide to receive some more information:
1268 <taglist>
1269     <tag><tt>upload-binary</tt>
1270     <item>
1271 The confirmation mail from <prgn>katie</prgn> when an uploaded binary
1272 package is accepted (to check that your package is recompiled for all
1273 architectures).
1274
1275     <tag><tt>cvs</tt>
1276     <item>
1277 CVS commits if the maintainer has setup a system to forward commit
1278 notification to the PTS.
1279
1280     <tag><tt>ddtp</tt>
1281     <item>
1282 Translations of descriptions or debconf templates
1283 submitted to the Debian Description Translation Project.
1284 </taglist>
1285
1286         <sect1 id="pts-commands">The PTS email interface
1287         <p>
1288 You can control your subscription(s) to the PTS by sending
1289 various commands to <email>pts@qa.debian.org</email>.
1290
1291 <taglist>
1292
1293 <tag><tt>subscribe &lt;srcpackage&gt; [&lt;email&gt;]</tt>
1294 <item>
1295   Subscribes <var>email</var> to communications related to the source package
1296   <var>srcpackage</var>. Sender address is used if the second argument is
1297   not present. If <var>srcpackage</var> is not a valid source package,
1298   you'll get a warning. However if it's a valid binary package, the PTS
1299   will subscribe you to the corresponding source package.
1300
1301 <tag><tt>unsubscribe &lt;srcpackage&gt; [&lt;email&gt;]</tt>
1302 <item>
1303   Removes a previous subscription to the source package <var>srcpackage</var>
1304   using the specified email address or the sender address if the second
1305   argument is left out. 
1306
1307 <tag><tt>which [&lt;email&gt;]</tt>
1308 <item>
1309   Lists all subscriptions for the sender or the email address optionally 
1310   specified.
1311
1312 <tag><tt>keyword [&lt;email&gt;]</tt>
1313 <item>
1314   Tells you the keywords that you are accepting. Each mail sent through
1315   the Package Tracking System is associated to a keyword and you receive
1316   only the mails associated to keywords that you are accepting. Here is
1317   the list of available keywords:
1318   <list>
1319   <item><tt>bts</tt>: mails coming from the Debian Bug Tracking System
1320   <item><tt>bts-control</tt>: reply to mails sent to &email-bts-control;
1321   <item><tt>summary</tt>: automatic summary mails about the state of a package
1322   <item><tt>cvs</tt>: notification of CVS commits
1323   <item><tt>ddtp</tt>: translations of descriptions and debconf templates
1324   <item><tt>upload-source</tt>: announce of a new source upload that
1325         has been accepted
1326   <item><tt>upload-binary</tt>: announce of a new binary-only upload (porting)
1327   <item><tt>katie-other</tt>: other mails from ftpmasters
1328         (override disparity, etc.)
1329   <item><tt>default</tt>: all the other mails (those which aren't "automatic")
1330   </list>
1331
1332 <tag><tt>keyword &lt;srcpackage&gt; [&lt;email&gt;]</tt>
1333 <item>
1334   Same as previous item but for the given source package since
1335   you may select a different set of keywords for each source package.
1336
1337 <tag><tt>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
1338 <item>
1339   Accept (+) or refuse (-) mails associated to the given keyword(s).
1340   Define the list (=) of accepted keywords.
1341
1342 <tag><tt>keyword &lt;srcpackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
1343 <item>
1344   Same as previous item but overrides the keywords list for the
1345   indicated source package.
1346   
1347 <tag><tt>quit | thanks | --</tt>
1348 <item>
1349   Stops processing commands. All following lines are ignored by
1350   the bot.
1351 </taglist>
1352
1353         <sect1 id="pts-mail-filtering">Filtering PTS mails
1354         <p>
1355 Once you are subscribed to a package, you will get the mails sent to
1356 <tt><var>srcpackage</var>@packages.qa.debian.org</tt>. Those mails
1357 have special headers appended to let you filter them in a special
1358 mailbox with <prgn>procmail</prgn>. The added headers are
1359 <tt>X-Loop</tt>, <tt>X-PTS-Package</tt>, <tt>X-PTS-Keyword</tt> and
1360 <tt>X-Unsubscribe</tt>.
1361         <p>
1362 Here is an example of added headers for a source upload notification
1363 on the <package>dpkg</package> package:
1364 <example>
1365 X-Loop: dpkg@&pts-host;
1366 X-PTS-Package: dpkg
1367 X-PTS-Keyword: upload-source
1368 X-Unsubscribe: echo 'unsubscribe dpkg' | mail pts@qa.debian.org
1369 </example>
1370
1371         <sect1 id="pts-cvs-commit">Forwarding CVS commits in the PTS
1372         <p>
1373 If you use a publicly accessible CVS repository for maintaining
1374 your Debian package you may want to forward the commit notification
1375 to the PTS so that the subscribers (possible co-maintainers) can
1376 closely follow the package's evolution.
1377         <p>
1378 It's very easy to setup. Once your CVS repository generates commit
1379 notifications, you just have to make sure it sends a copy of those mails
1380 to <tt><var>srcpackage</var>_cvs@&pts-host;</tt>. Only people who
1381 accepts the <em>cvs</em> keyword will receive the notifications.
1382
1383         <sect1 id="pts-web">The PTS web interface
1384         <p>
1385 The PTS has been extended with a web interface that puts together
1386 many information about each source package. It features many useful
1387 links (BTS, QA stats, contact information, DDTP translation status,
1388 buildd logs) and gathers many more information from various places
1389 (30 latest changelog entries, testing status, ...). It's a very useful
1390 tool if you want to know what's going on with a specific source
1391 package. Furthermore there's a form that let you easily subscribe to
1392 the mail service offered by the PTS.
1393         <p>
1394 You can jump directly to the web page concerning a specific source package
1395 with an url like <tt>http://&pts-host;/<var>srcpackage</var></tt>. Otherwise
1396 you can go through the <url id="http://&pts-host;" name="main page">.
1397         <p>
1398 This web interface has been designed like a portal for the development of
1399 packages: you can add custom content on the pages of your packages. You can
1400 add "static information" (news item that are meant to stay available
1401 indefinitely) and news items in the "latest news" section.
1402         <p>
1403 Static news can be used to indicate:
1404 <list>
1405 <item>the availability of a project hosted on alioth.debian.org for co-maintaining the package
1406 <item>a link to the upstream website
1407 <item>a link to the upstream bugtracker
1408 <item>the existence of an IRC channel dedicated to the software
1409 <item>any other available resource that could be useful in the maintenance of the package
1410 </list>
1411 Usual news item may be used to announce that:
1412 <list>
1413 <item>beta packages are available for test
1414 <item>final packages are expected for next week
1415 <item>the packaging is about to be redone from scratch
1416 <item>backports are available
1417 <item>the maintainer is on vacation (if he wishes to publish this information)
1418 <item>a NMU is being worked on
1419 <item>something important will affect the package
1420 </list>
1421         <p>
1422 Both kind of news are generated in a similar manner: you just have to send a mail
1423 either to <email>pts-static-news@qa.debian.org</email> or to
1424 <email>pts-news@qa.debian.org</email>. The mail should indicate which package is
1425 concerned by the news by giving the name of the source package in a
1426 <tt>X-PTS-Package</tt> mail header or in a <tt>Package</tt> pseudo-header (like the
1427 BTS reports). If an URL is available in the <tt>X-PTS-Url</tt> mail header or in
1428 the <tt>Url</tt> pseudo-header, then the result is a link to that URL instead
1429 of a complete news item.
1430         <p>
1431 Some examples of valid mails used to generate news item in the PTS are following. The first one
1432 adds a link to the cvsweb interface of debian-cd in the "Static information" section.
1433 <example>
1434 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
1435 To: pts-static-news@qa.debian.org
1436 Subject: Browse debian-cd CVS repository with cvsweb
1437
1438 Package: debian-cd
1439 Url: http://cvs.debian.org/debian-cd/
1440 </example>
1441 The second one is an announce sent to a mailing list which is also sent
1442 to the PTS so that it is published on the PTS web page of the package. Note the
1443 use of the BCC field to avoid answers sent to the PTS by mistake ...
1444 <example>
1445 From: Raphael Hertzog &lt;hertzog@debian.org&gt;
1446 To: debian-gtk-gnome@lists.debian.org
1447 Bcc: pts-news@qa.debian.org
1448 Subject: Galeon 2.0 backported for woody
1449 X-PTS-Package: galeon
1450
1451 Hello gnomers !
1452
1453 I'm glad to announce that galeon has been backported for woody. You'll find
1454 everything here:
1455 ...
1456 </example>
1457         <p>
1458 Think twice before adding a news to the PTS because you won't be able to
1459 remove it later and you wan't be able to edit it either. The only thing that you
1460 can do is send a second news that will deprecate the information contained in
1461 the first news.
1462
1463     <sect id="ddpo">Developer's packages overview
1464         <p>
1465 A QA (quality assurance) web portal is available at <url
1466             id="&url-ddpo;"> which displays a table listing all the packages
1467 of a single developer (including those where the party is listed as
1468 a co-maintainer). The table gives a good summary about the developer's 
1469 packages: number of bugs by severity, list of available versions in each
1470 distribution, testing status and much more including links to any other
1471 useful information.
1472         <p>
1473 It is a good idea to look up your own data regularly so that
1474 you don't forget any open bug, and so that you don't forget which
1475 packages are under your responsibility.
1476
1477
1478    <chapt id="pkgs">Managing Packages
1479         <p>
1480 This chapter contains information related to creating, uploading,
1481 maintaining, and porting packages.
1482
1483
1484     <sect id="newpackage">New packages
1485         <p>
1486 If you want to create a new package for the Debian distribution, you
1487 should first check the <url id="&url-wnpp;" name="Work-Needing and
1488 Prospective Packages (WNPP)"> list. Checking the WNPP list ensures that
1489 no one is already working on packaging that software, and that effort is
1490 not duplicated. Read the <url id="&url-wnpp;" name="WNPP web pages"> for
1491 more information.
1492         <p>
1493 Assuming no one else is already working on your prospective package,
1494 you must then submit a bug report (<ref id="submit-bug">) against the
1495 pseudo-package <package>wnpp</package> 
1496 describing your plan to create a new package, including, but not
1497 limiting yourself to, a description of the package, the license of the
1498 prospective package and the current URL where it can be downloaded
1499 from.
1500         <p>
1501 You should set the subject of the bug to ``ITP: <var>foo</var>
1502 -- <var>short description</var>'', substituting the name of the new
1503 package for <var>foo</var>.  The severity of the bug report must be set
1504 to <em>wishlist</em>. If you feel it's necessary, send a copy to
1505 &email-debian-devel; by putting the address in the <tt>X-Debbugs-CC:</tt> header
1506 of the message (no, don't use <tt>CC:</tt>, because that way the message's subject
1507 won't indicate the bug number).
1508         <p>
1509 Please include a <tt>Closes: bug#<var>nnnnn</var></tt> entry on the
1510 changelog of the new package in order for the bug report to be
1511 automatically closed once the new package is installed on the archive
1512 (<ref id="upload-bugfix">).
1513         <p>
1514 There are a number of reasons why we ask maintainers to announce their
1515 intentions:
1516           <list compact>
1517             <item>
1518 It helps the (potentially new) maintainer to tap into the experience
1519 of people on the list, and lets them know if anyone else is working
1520 on it already.
1521             <item>
1522 It lets other people thinking about working on the package know that
1523 there already is a volunteer, so efforts may be shared.
1524             <item>
1525 It lets the rest of the maintainers know more about the package than
1526 the one line description and the usual changelog entry ``Initial release''
1527 that gets posted to <tt>debian-devel-changes</tt>.
1528             <item>
1529 It is helpful to the people who live off unstable (and form our first
1530 line of testers).  We should encourage these people.
1531             <item>
1532 The announcements give maintainers and other interested parties a
1533 better feel of what is going on, and what is new, in the project.
1534           </list>
1535
1536
1537     <sect id="changelog-entries">Recording changes in the package
1538           <p>
1539 Changes that you make to the package need to be recorded in the
1540 <file>debian/changelog</file>.  These changes should provide a concise
1541 description of what was changed, why (if it's in doubt), and note if
1542 any bugs were closed.  They also record when the package was
1543 completed.  This file will be installed in
1544 <file>/usr/share/doc/<var>package</var>/changelog.Debian.gz</file>, or
1545 <file>/usr/share/doc/<var>package</var>/changelog.gz</file> for native
1546 packages.
1547           <p>
1548 The <file>debian/changelog</file> file conforms to a certain structure,
1549 with a number of different fields.  One field of note, the
1550 <em>distribution</em>, is described in <ref id="distribution">.  More
1551 information about the structure of this file can be found in
1552 the Debian Policy section titled "<file>debian/changelog</file>".
1553           <p>
1554 Changelog entries can be used to automatically close Debian bugs when
1555 the package is installed into the archive.  See <ref
1556 id="upload-bugfix">.
1557           <p>
1558 It is conventional that the changelog entry notating of a package that
1559 contains a new upstream version of the software looks like this:
1560 <example>
1561   * new upstream version
1562 </example>
1563           <p>
1564 There are tools to help you create entries and finalize the
1565 <file>changelog</file> for release &mdash; see <ref id="devscripts">
1566 and <ref id="dpkg-dev-el">.
1567           <p>
1568 See also <ref id="bpp-debian-changelog">.
1569
1570
1571     <sect id="sanitycheck">Testing the package
1572         <p>
1573 Before you upload your package, you should do basic testing on it.  At
1574 a minimum, you should try the following activities (you'll need to
1575 have an older version of the same Debian package around):
1576 <list>
1577               <item>
1578 Install the package and make sure the software works, or upgrade the
1579 package from an older version to your new version if a Debian package
1580 for it already exists.
1581               <item>
1582 Run <prgn>lintian</prgn> over the package.  You can run
1583 <prgn>lintian</prgn> as follows: <tt>lintian -v
1584 <var>package-version</var>.changes</tt>. This will check the source
1585 package as well as the binary package.  If you don't understand the
1586 output that <prgn>lintian</prgn> generates, try adding the <tt>-i</tt>
1587 switch, which will cause <prgn>lintian</prgn> to output a very verbose
1588 description of the problem.
1589                 <p>
1590 Normally, a package should <em>not</em> be uploaded if it causes lintian
1591 to emit errors (they will start with <tt>E</tt>).
1592                 <p>
1593 For more information on <prgn>lintian</prgn>, see <ref id="lintian">.
1594               <item>
1595 Optionally run <ref id="debdiff"> to analyze changes from an older version,
1596 if one exists.
1597               <item>
1598 Downgrade the package to the previous version (if one exists) &mdash; this
1599 tests the <file>postrm</file> and <file>prerm</file> scripts.
1600               <item>
1601 Remove the package, then reinstall it.
1602             </list>
1603
1604
1605     <sect id="sourcelayout">Layout of the source package
1606         <p>
1607 There are two types of Debian source packages:
1608         <list>
1609           <item>the so-called <em>native</em> packages, where there is no
1610                 distinction between the original sources and the patches
1611                 applied for Debian
1612           <item>the (more common) packages where there's an original source
1613                 tarball file accompanied by another file that contains the
1614                 patches applied for Debian
1615         </list>
1616         <p>
1617 For the native packages, the source package includes a Debian source control
1618 file (<tt>.dsc</tt>) and the source tarball (<tt>.tar.gz</tt>). A source
1619 package of a non-native package includes a Debian source control file, the
1620 original source tarball (<tt>.orig.tar.gz</tt>) and the Debian patches
1621 (<tt>.diff.gz</tt>).
1622         <p>
1623 Whether a package is native or not is determined when it is built by
1624 <manref name="dpkg-buildpackage" section="1">. The rest of this section
1625 relates only to non-native packages.
1626         <p>
1627 The first time a version is uploaded which corresponds to a particular
1628 upstream version, the original source tar file should be uploaded and
1629 included in the <file>.changes</file> file.  Subsequently, this very same
1630 tar file should be used to build the new diffs and <file>.dsc</file>
1631 files, and will not need to be re-uploaded.
1632         <p>
1633 By default, <prgn>dpkg-genchanges</prgn> and
1634 <prgn>dpkg-buildpackage</prgn> will include the original source tar
1635 file if and only if the Debian revision part of the source version
1636 number is 0 or 1, indicating a new upstream version.  This behavior
1637 may be modified by using <tt>-sa</tt> to always include it or
1638 <tt>-sd</tt> to always leave it out.
1639         <p>
1640 If no original source is included in the upload, the original
1641 source tar-file used by <prgn>dpkg-source</prgn> when constructing the
1642 <file>.dsc</file> file and diff to be uploaded <em>must</em> be
1643 byte-for-byte identical with the one already in the archive.
1644
1645
1646     <sect id="distribution">Picking a distribution
1647         <p>
1648 Each upload needs to specify which distribution the package is intended
1649 for. The package build process extracts this information from the first
1650 line of the <file>debian/changelog</file> file and places it in the
1651 <tt>Distribution</tt> field of the <tt>.changes</tt> file.
1652         <p>
1653 There are several possible values for this field: `stable', `unstable',
1654 `testing-proposed-updates' and `experimental'. Normally, packages are
1655 uploaded into <em>unstable</em>.
1656         <p>
1657 Actually, there are two other possible distributions: `stable-security' and
1658 `testing-security', but read <ref id="bug-security"> for more information on
1659 those.
1660         <p>
1661 It is technically possible to upload a package into several distributions
1662 at the same time but it usually doesn't make sense to use that feature
1663 because the dependencies of the package may vary with the distribution.
1664 In particular, it never makes sense to combine the <em>experimental</em>
1665 distribution with anything else (see <ref id="experimental">).
1666
1667         <sect1 id="upload-stable">
1668           <heading>Special case: uploads to the <em>stable</em> distribution</heading>
1669           <p>
1670 Uploading to <em>stable</em> means that the package will be placed into the
1671 <file>stable-proposed-updates</file> directory of the Debian archive for further
1672 testing before it is actually included in <em>stable</em>.
1673           <p>
1674 Extra care should be taken when uploading to <em>stable</em>. Basically, a
1675 package should only be uploaded to stable if one of the following happens:
1676 <list>
1677         <item>a truly critical functionality problem
1678         <item>the package becomes uninstallable
1679         <item>a released architecture lacks the package
1680 </list>
1681 <p>
1682 In the past, uploads to <em>stable</em> were used to address security
1683 problems as well.  However, this practice is deprecated, as uploads
1684 used for Debian security advisories are automatically copied to the
1685 appropriate <file>proposed-updates</file> archive when the advisory is
1686 released.  See <ref id="bug-security"> for detailed information on
1687 handling security problems.
1688           <p>
1689 It is discouraged to change anything else in the package that isn't
1690 important, because even trivial fixes can cause bugs later on.
1691           <p>
1692 Packages uploaded to <em>stable</em> need to be compiled on systems running
1693 <em>stable</em>, so that their dependencies are limited to the libraries
1694 (and other packages) available in <em>stable</em>; for example, a package
1695 uploaded to <em>stable</em> that depends on a library package that only
1696 exists in unstable will be rejected. Making changes to dependencies of other
1697 packages (by messing with <tt>Provides</tt> or shlibs files), possibly making
1698 those other packages uninstallable, is strongly discouraged.
1699           <p>
1700 The Release Team (which can be reached at &email-debian-release;) will
1701 regularly evaluate the uploads in <em>stable-proposed-updates</em> and decide if
1702 your package can be included in <em>stable</em>. Please be clear (and
1703 verbose, if necessary) in your changelog entries for uploads to
1704 <em>stable</em>, because otherwise the package won't be considered for
1705 inclusion.
1706
1707         <sect1 id="upload-t-p-u">
1708           <heading>Special case: uploads to <em>testing-proposed-updates</em></heading>
1709           <p>
1710 The testing distribution is fed with packages from unstable according to the rules
1711 explained in <ref id="testing">. However, the release manager may stop the testing
1712 scripts when he wants to freeze the distribution. In that case, you may want to
1713 upload to <em>testing-proposed-updates</em> to provide fixed packages during the freeze.
1714           <p>
1715 Keep in mind that packages uploaded there are not automatically processed, they
1716 have to go through the hands of the release manager. So you'd better have a good
1717 reason to upload there. In order to know what a good reason is in the
1718 release manager's eyes, you should read the instructions that he regularly
1719 gives on &email-debian-devel-announce;.
1720           <p>
1721 You should not upload to <em>testing-proposed-updates</em> when you can update your
1722 packages through <em>unstable</em>. If you can't (for example because you have a
1723 newer development version in unstable), you may use it but it is recommended to ask
1724 the authorization of the release manager before.
1725
1726
1727     <sect id="upload">Uploading a package
1728
1729         <sect1 id="upload-ftp-master">Uploading to <tt>ftp-master</tt>
1730           <p>
1731 To upload a package, you need a personal account on
1732 <ftpsite>&ftp-master-host;</ftpsite>, which you should have as an
1733 official maintainer. If you use <prgn>scp</prgn> or <prgn>rsync</prgn>
1734 to transfer the files, place them into &us-upload-dir;;
1735 if you use anonymous FTP to upload, place them into
1736 &upload-queue;.
1737           <p>
1738 If you want to use feature described in <ref id="delayed-incoming">,
1739 you'll have to upload to <tt>ftp-master</tt>.  It is the only upload
1740 point that supported delayed incoming.
1741           <p>
1742 Please note that you should transfer
1743 the changes file last.  Otherwise, your upload may be rejected because the
1744 archive maintenance software will parse the changes file and see that not
1745 all files have been uploaded.  If you don't want to bother with transferring
1746 the changes file last, you can simply copy your files to a temporary
1747 directory on <tt>ftp-master</tt> and then move them to
1748 &us-upload-dir;.
1749           <p>
1750 <em>Note:</em> Do not upload to <tt>ftp-master</tt> cryptographic
1751 packages which belong to <em>contrib</em> or <em>non-free</em>. Uploads of
1752 such software should go to <tt>non-us</tt> (see <ref
1753 id="upload-non-us">). Furthermore packages containing code that is
1754 patent-restricted by the United States government can not be uploaded to
1755 <tt>ftp-master</tt>; depending on the case they may still be uploaded to
1756 <file>non-US/non-free</file> (it's in non-free because of distribution issues
1757 and not because of the license of the software). If you can't upload it to
1758 <tt>ftp-master</tt>, then neither can you upload it to the overseas upload
1759 queues on <tt>chiark</tt> or <tt>erlangen</tt>. If you are not sure
1760 whether U.S. patent controls or cryptographic controls apply to your
1761 package, post a message to &email-debian-devel; and ask.
1762           <p>
1763 You may also find the Debian packages <ref id="dupload"> or
1764 <ref id="dput"> useful
1765 when uploading packages.  These handy programs help automate the
1766 process of uploading packages into Debian.
1767           <p>
1768 After uploading your package, you can check how the archive
1769 maintenance software will process it by running <prgn>dinstall</prgn>
1770 on your changes file:
1771 <example>dinstall -n foo.changes</example>
1772           <p>
1773 Note that <prgn>dput</prgn> can do this for you automatically.
1774
1775         <sect1 id="upload-non-us">Uploading to <tt>non-US</tt>
1776           <p>
1777 As discussed above, export controlled software should not be uploaded
1778 to <tt>ftp-master</tt>.  Instead, upload the package to
1779 <ftpsite>non-us.debian.org</ftpsite>, placing the files in
1780 &non-us-upload-dir; (again, both <ref id="dupload"> and <ref
1781 id="dput"> can do this for you if invoked properly). By default,
1782 you can use the same account/password that works on
1783 <tt>ftp-master</tt>.  If you use anonymous FTP to upload, place the
1784 files into &upload-queue;.
1785           <p>
1786 You can check your upload the same way it's done on <tt>ftp-master</tt>,
1787 with:
1788 <example>dinstall -n foo.changes</example>
1789           <p>
1790 Note that U.S. residents or citizens are subject to restrictions on
1791 export of cryptographic software. As of this writing, U.S. citizens
1792 are allowed to export some cryptographic software, subject to
1793 notification rules by the U.S. Department of Commerce.  However, this
1794 restriction has been waived for software which is already available
1795 outside the U.S.  Therefore, any cryptographic software which belongs
1796 in the <em>main</em> section of the Debian archive and does not depend
1797 on any package outside of <em>main</em> (e.g., does not depend on
1798 anything in <em>non-US/main</em>) can be uploaded to <tt>ftp-master</tt>
1799 or its queues, described above.
1800           <p>
1801 Debian policy does not prevent upload to non-US by U.S. residents or
1802 citizens, but care should be taken in doing so. It is recommended that
1803 developers take all necessary steps to ensure that they are not
1804 breaking current US law by doing an upload to non-US, <em>including
1805 consulting a lawyer</em>.
1806           <p>
1807 For packages in <em>non-US/main</em>, <em>non-US/contrib</em>,
1808 developers should at least follow the <url id="&url-u.s.-export;"
1809 name="procedure outlined by the US Government">.  Maintainers of
1810 <em>non-US/non-free</em> packages should further consult the <url
1811 id="&url-notification-of-export;" name="rules on notification of
1812 export"> of non-free software.
1813           <p>
1814 This section is for information only and does not constitute legal
1815 advice. Again, it is strongly recommended that U.S. citizens and
1816 residents consult a lawyer before doing uploads to non-US.
1817
1818
1819         <sect1>Uploads via <tt>chiark</tt>
1820           <p>
1821 If you have a slow network connection to <tt>ftp-master</tt>, there are
1822 alternatives.  One is to upload files to <file>Incoming</file> via a
1823 upload queue in Europe on <tt>chiark</tt>. For details connect to
1824 <url id="&url-chiark-readme;">.
1825           <p>
1826 <em>Note:</em> Do not upload packages containing software that is
1827 export-controlled by the United States government to the queue on
1828 <tt>chiark</tt>.  Since this upload queue goes to <tt>ftp-master</tt>, the
1829 prescription found in <ref id="upload-ftp-master"> applies here as well.
1830           <p>
1831 The program <prgn>dupload</prgn> comes with support for uploading to
1832 <tt>chiark</tt>; please refer to the documentation that comes with the
1833 program for details.
1834
1835
1836         <sect1>Uploads via <tt>erlangen</tt>
1837           <p>
1838 Another upload queue is available in Germany: just upload the files
1839 via anonymous FTP to <url id="&url-upload-erlangen;">.
1840           <p>
1841 The upload must be a complete Debian upload, as you would put it into
1842 <tt>ftp-master</tt>'s <file>Incoming</file>, i.e., a <file>.changes</file> files
1843 along with the other files mentioned in the <file>.changes</file>. The
1844 queue daemon also checks that the <file>.changes</file> is correctly
1845 signed with GnuPG or OpenPGP by a Debian developer, so that no bogus files can find
1846 their way to <tt>ftp-master</tt> via this queue. Please also make sure that
1847 the <tt>Maintainer</tt> field in the <file>.changes</file> contains
1848 <em>your</em> e-mail address. The address found there is used for all
1849 replies, just as on <tt>ftp-master</tt>.
1850           <p>
1851 There's no need to move your files into a second directory after the
1852 upload, as on <tt>chiark</tt>. And, in any case, you should get a
1853 mail reply from the queue daemon explaining what happened to your
1854 upload. Hopefully it should have been moved to <tt>ftp-master</tt>, but in
1855 case of errors you're notified, too.
1856           <p>
1857 <em>Note:</em> Do not upload packages containing software that is
1858 export-controlled by the United States government to the queue on
1859 <tt>erlangen</tt>.  Since this upload queue goes to <tt>ftp-master</tt>, the
1860 prescription found in <ref id="upload-ftp-master"> applies here as well.
1861           <p>
1862 The program <prgn>dupload</prgn> comes with support for uploading to
1863 <tt>erlangen</tt>; please refer to the documentation that comes with
1864 the program for details.
1865
1866
1867         <sect1>Other upload queues
1868           <p>
1869 Another upload queue is available which is based in the US, and is a
1870 good backup when there are problems reaching <tt>ftp-master</tt>.  You can
1871 upload files, just as in <tt>erlangen</tt>, to <url
1872 id="&url-upload-samosa;">.
1873           <p>
1874 An upload queue is available in Japan: just upload the files via
1875 anonymous FTP to <url id="&url-upload-jp;">.
1876
1877
1878       <sect1 id="upload-notification">
1879         <heading>Notification that a new package has been installed</heading>
1880         <p>
1881 The Debian archive maintainers are responsible for handling package
1882 uploads.  For the most part, uploads are automatically handled on a
1883 daily basis by the archive maintenance tools, <prgn>katie</prgn>.
1884 Specifically, updates to existing packages to
1885 the `unstable' distribution are handled automatically. In other cases,
1886 notably new packages, placing the uploaded package into the
1887 distribution is handled manually. When uploads are handled manually,
1888 the change to the archive may take up to a month to occur. Please be
1889 patient.
1890         <p>
1891 In any case, you will receive an email notification indicating that the
1892 package has been added to the archive, which also indicates which bugs will
1893 be closed by the upload.  Please examine this notification carefully,
1894 checking if any bugs you meant to close didn't get triggered.
1895         <p>
1896 The installation notification also includes information on what
1897 section the package was inserted into.  If there is a disparity, you
1898 will receive a separate email notifying you of that.  Read on below.
1899         <p>
1900 Note also that if you upload via queues, the queue daemon software will
1901 also send you a notification by email.
1902
1903     <sect id="override-file">Determining section and priority of a package
1904         <p>
1905 The <file>debian/control</file> file's <tt>Section</tt> and
1906 <tt>Priority</tt> fields do not actually specify where the file will
1907 be placed in the archive, nor its priority.  In order to retain the
1908 overall integrity of the archive, it is the archive maintainers who
1909 have control over these fields.  The values in the
1910 <file>debian/control</file> file are actually just hints.
1911         <p>
1912 The archive maintainers keep track of the canonical sections and
1913 priorities for packages in the <em>override file</em>.  If there is a
1914 disparity between the <em>override file</em> and the package's fields
1915 as indicated in <file>debian/control</file>, then you will receive an
1916 email noting the divergence when the package is installed into the
1917 archive.  You can either correct your <file>debian/control</file> file
1918 for your next upload, or else you may wish to make a change in the
1919 <em>override file</em>.
1920         <p>
1921 To alter the actual section that a package is put in, you need to
1922 first make sure that the <file>debian/control</file> in your package
1923 is accurate.  Next, send an email &email-override; or submit a bug
1924 against <package>ftp.debian.org</package> requesting that the section
1925 or priority for your package be changed from the old section or
1926 priority to the new one.  Be sure to explain your reasoning.
1927         <p>
1928 For more information about <em>override files</em>, see <manref
1929 name="dpkg-scanpackages" section="8"> and
1930 <url id="&url-bts-devel;#maintincorrect">.
1931         <p>
1932 Note also that the term "section" is used for the separation of packages
1933 according to their licensing, e.g. <em>main</em>, <em>contrib</em> and
1934 <em>non-free</em>. This is described in another section, <ref id="archive">.
1935
1936
1937     <sect id="bug-handling">Handling bugs
1938         <p>
1939 Every developer has to be able to work with the Debian <url name="bug
1940 tracking system" id="&url-bts;">. This includes knowing how to file bug
1941 reports properly (see <ref id="submit-bug">), how to update them and
1942 reorder them, and how to process and close them.
1943         <p>
1944 The bug tracking system's features interesting to developers are described
1945 in the <url id="&url-bts-devel;" name="BTS documentation for developers">.
1946 This includes closing bugs, sending followup messages, assigning severities,
1947 tags, marking bugs as forwarded and other issues.
1948         <p>
1949 Operations such as reassigning bugs to other packages, merging separate
1950 bug reports about the same issue, or reopening bugs when they are
1951 prematurely closed, are handled using the so-called control mail server.
1952 All of the commands available in this server are described in the
1953 <url id="&url-bts-control;" name="BTS control server documentation">.
1954
1955       <sect1 id="bug-monitoring">Monitoring bugs
1956         <p>
1957 If you want to be a good maintainer, you should periodically check the
1958 <url id="&url-bts;" name="Debian bug tracking system (BTS)"> for your
1959 packages.  The BTS contains all the open bugs against your packages.
1960 You can check them by browsing this page:
1961 <tt>http://&bugs-host;/<var>yourlogin</var>@debian.org</tt>.
1962         <p>
1963 Maintainers interact with the BTS via email addresses at
1964 <tt>&bugs-host;</tt>.  Documentation on available commands can be
1965 found at <url id="&url-bts;">, or, if you have installed the
1966 <package>doc-debian</package> package, you can look at the local files
1967 &file-bts-docs;.
1968         <p>
1969 Some find it useful to get periodic reports on open bugs.  You can add
1970 a cron job such as the following if you want to get a weekly email
1971 outlining all the open bugs against your packages:
1972 <example>
1973 # ask for weekly reports of bugs in my packages
1974 &cron-bug-report;
1975 </example>
1976 Replace <var>address</var> with your official Debian
1977 maintainer address.
1978
1979       <sect1 id="bug-answering">Responding to bugs
1980         <p>
1981 When responding to bugs, make sure that any discussion you have about
1982 bugs are sent both to
1983 the original submitter of the bug, and the bug itself (e.g.,
1984 <email>123@&bugs-host;</email>). If you're writing a new
1985 mail and you don't remember the submitter email address, you can
1986 use the <email>123-submitter@&bugs-host;</email> email to
1987 contact the submitter <em>and</em> to record your mail within the
1988 bug log (that means you don't need to send a copy of the mail to
1989 <email>123@&bugs-host;</email>).
1990         <p>
1991 If you get a bug which mentions "FTBFS", that means "Fails to build
1992 from source".  Porters frequently use this acronym.
1993         <p>
1994 Once you've dealt with a bug report (e.g. fixed it), mark it as
1995 <em>done</em> (close it) by sending an explanation message to
1996 <email>123-done@&bugs-host;</email>. If you're fixing a bug by
1997 changing and uploading the package, you can automate bug closing as
1998 described in <ref id="upload-bugfix">.
1999         <p>
2000 You should <em>never</em> close bugs via the bug server <tt>close</tt>
2001 command sent to &email-bts-control;.  If you do so, the original
2002 submitter will not receive any information about why the bug was
2003 closed.
2004
2005       <sect1 id="bug-housekeeping">Bug housekeeping
2006         <p>
2007 As a package maintainer, you will often find bugs in other packages or
2008 have bugs reported against your packages which are actually bugs in
2009 other packages. The bug tracking system's features interesting to developers
2010 are described in the <url id="&url-bts-devel;" name="BTS documentation for
2011 Debian developers">. Operations such as reassigning, merging, and tagging
2012 bug reports are described in the <url id="&url-bts-control;" name="BTS
2013 control server documentation">. This section contains
2014 some guidelines for managing your own bugs, based on the collective
2015 Debian developer experience.
2016         <p>
2017 Filing bugs for problems that  you find in other packages is one of
2018 the "civic obligations" of maintainership, see <ref id="submit-bug">
2019 for details. However, handling the bugs in your own packages is
2020 even more important.
2021         <p>
2022 Here's a list of steps that you may follow to handle a bug report:
2023 <enumlist>
2024     <item>
2025 Decide whether the report corresponds to a real bug or not. Sometimes
2026 users are just calling a program in the wrong way because they haven't
2027 read the documentation. If you diagnose this, just close the bug with
2028 enough information to let the user correct his problem (give pointers
2029 to the good documentation and so on). If the same report comes up
2030 again and again you may ask yourself if the documentation is good
2031 enough or if the program shouldn't detect its misuse in order to
2032 give an informative error message. This is an issue that may need
2033 to be brought to the upstream author.
2034     <p>
2035 If the bug submitter disagree with your decision to close the bug,
2036 they may reopen it until you find an agreement on how to handle it.
2037 If you don't find any, you may want to tag the bug <tt>wontfix</tt>
2038 to let people know that the bug exists but that it won't be corrected.
2039 If this situation is unacceptable, you (or the submitter) may want to
2040 require a decision of the technical committee by reassigning the bug
2041 to <package>tech-ctte</package> (you may use the clone command of
2042 the BTS if you wish to keep it reported against your package). Before
2043 doing so, please read the <url id="&url-tech-ctte;" name="recommended procedure">.
2044     <item>
2045 If the bug is real but it's caused by another package, just reassign
2046 the bug the right package. If you don't know which package it should
2047 be reassigned to, you may either ask for help on &email-debian-devel; or
2048 reassign it to <package>debian-policy</package> to let them decide which
2049 package is in fault.
2050     <p>
2051 Sometimes you also have to adjust the severity of the bug so that it
2052 matches our definition of the severity. That's because people tend to
2053 inflate the severity of bugs to make sure their bugs are fixed quickly.
2054 Some bugs may even be dropped to wishlist severity when the requested
2055 change is just cosmetic.
2056     <item>
2057 The bug submitter may have forgotten to provide some information, in that
2058 case you have to ask him the information required. You may use the
2059 <tt>moreinfo</tt> tag to mark the bug as such. Moreover if you can't
2060 reproduce the bug, you tag it <tt>unreproducible</tt>. Anyone who
2061 can reproduce the bug is then invited to provide more information
2062 on how to reproduce it. After a few months, if this information has not
2063 been sent by someone, the bug may be closed.
2064     <item>
2065 If the bug is related to the packaging, you just fix it. If you are not
2066 able to fix it yourself, then tag the bug as <tt>help</tt>. You can
2067 also ask for help on &email-debian-devel; or &email-debian-qa;. If it's an
2068 upstream problem, you have to forward it to the upstream author.
2069 Forwarding a bug is not enough, you have to check at each release if
2070 the bug has been fixed or not. If it has, you just close it, otherwise
2071 you have to remind the author about it. If you have the required skills
2072 you can prepare a patch that fixes the bug and that you send at the
2073 same time to the author. Make sure to send the patch in the BTS and to
2074 tag the bug as <tt>patch</tt>.
2075     <item>
2076 If you have fixed a bug in your local copy, or if a fix has been
2077 committed to the CVS repository, you may tag the bug as
2078 <tt>pending</tt> to let people know that the bug is corrected and that
2079 it will be closed with the next upload (add the <tt>closes:</tt> in
2080 the <file>changelog</file>). This is particularly useful if you
2081 are several developers working on the same package.
2082     <item>
2083 Once a corrected package is available in the <em>unstable</em>
2084 distribution, you can close the bug. This can be done automatically,
2085 read <ref id="upload-bugfix">.
2086 </enumlist>
2087
2088       <sect1 id="upload-bugfix">When bugs are closed by new uploads
2089         <p>
2090 As bugs and problems are fixed your packages, it is your
2091 responsibility as the package maintainer to close the bug.  However,
2092 you should not close the bug until the package which fixes the bug has
2093 been accepted into the Debian archive.  Therefore, once you get
2094 notification that your updated package has been installed into the
2095 archive, you can and should close the bug in the BTS.
2096         <p>
2097 However, it's possible to avoid having to manually close bugs after the
2098 upload &mdash; just list the fixed bugs in your <file>debian/changelog</file>
2099 file, following a certain syntax, and the archive maintenance software
2100 will close the bugs for you. For example:
2101
2102 <example>
2103 acme-cannon (3.1415) unstable; urgency=low
2104
2105   * Frobbed with options (closes: Bug#98339)
2106   * Added safety to prevent operator dismemberment, closes: bug#98765,
2107     bug#98713, #98714.
2108   * Added man page. Closes: #98725.
2109 </example>
2110
2111 Technically speaking, the following Perl regular expression describes
2112 how bug closing changelogs are identified:
2113 <example>
2114   /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig
2115 </example>
2116
2117 We prefer the <tt>closes: #<var>XXX</var></tt> syntax, as it is the
2118 most concise entry and the easiest to integrate with the text of the
2119 <file>changelog</file>.
2120         <p>
2121 If you happen to mistype a bug number or forget a bug in the changelog
2122 entries, don't hesitate to undo any damage the error caused. To reopen
2123 wrongly closed bugs, send an <tt>reopen <var>XXX</var></tt> command to
2124 the bug tracking system's control address, &email-bts-control;.  To
2125 close any remaining bugs that were fixed by your upload, email the
2126 <file>.changes</file> file to <email>XXX-done@&bugs-host;</email>,
2127 where <var>XXX</var> is your bug number.
2128         <p>
2129 Bear in mind that it is not obligatory to close bugs using the
2130 changelog as described above.  If you simply want to close bugs that
2131 don't have anything to do with an upload you made, do it by emailing
2132 an explanation to <email>XXX-done@&bugs-host;</email>.  Do
2133 <strong>not</strong> close bugs in the changelog entry of a version if
2134 the changes in that version of the package doesn't have any bearing on
2135 the bug.
2136           <p>
2137 For general information on how to write your changelog entries, see
2138 <ref id="bpp-debian-changelog">.
2139
2140
2141       <sect1 id="bug-security">Handling security-related bugs
2142         <p>
2143 Due to their sensitive nature, security-related bugs must be handled
2144 carefully.  The Debian Security Team exists to coordinate this
2145 activity, keeping track of outstanding security problems, helping
2146 maintainers with security problems or fix them themselves, sending
2147 security advisories, and maintaining security.debian.org.
2148
2149 <!-- information about the security database goes here once it's ready -->
2150 <!-- (mdz) -->
2151
2152 <p>
2153 When you become aware of a security-related bug in a Debian package,
2154 whether or not you are the maintainer, collect pertinent information
2155 about the problem, and promptly contact the security team at
2156 &email-security-team; as soon as possible.  Useful information
2157 includes, for example:
2158
2159 <list compact>
2160   <item>What versions of the package are known to be affected by the
2161   bug.  Check each version that is present in a supported Debian
2162   release, as well as testing and unstable.
2163
2164   <item>The nature of the fix, if any is available (patches are
2165   especially helpful)
2166
2167   <item>Any fixed packages that you have prepared yourself (send only
2168   the <tt>.diff.gz</tt> and <tt>.dsc</tt> files and read <ref
2169   id="bug-security-building"> first)
2170
2171   <item>Any assistance you can provide to help with testing (exploits,
2172   regression testing, etc.)
2173
2174   <item>Any information needed for the advisory (see <ref
2175   id="bug-security-advisories">)
2176
2177 </list>
2178
2179         <sect2 id="bug-security-confidentiality">Confidentiality
2180           <p>
2181 Unlike most other activities within Debian, information about security
2182 issues must sometimes be kept private for a time.
2183 This allows software distributors to coordinate their disclosure in
2184 order to minimize their users' exposure.  Whether this is the
2185 case depends on the nature of the problem and corresponding fix, and
2186 whether it is already a matter of public knowledge.
2187
2188 <p>
2189 There are a few ways a developer can learn of a security problem:
2190
2191 <list compact>
2192     <item>he notices it on a public forum (mailing list, web site, etc.)
2193     <item>someone files a bug report
2194     <item>someone informs him via private email
2195 </list>
2196
2197  In the first two cases, the information is public and it is important
2198  to have a fix as soon as possible. In the last case, however, it
2199  might not be public information. In that case there are a few
2200  possible options for dealing with the problem:
2201
2202 <list>
2203   <item>If the security exposure is minor, there is sometimes no need
2204   to keep the problem a secret and a fix should be made and released.
2205
2206   <item>If the problem is severe, it is preferable to share the
2207   information with
2208   other vendors and coordinate a release. The security team keeps
2209   contacts with the various organizations and individuals and can take
2210   care of that.
2211 </list>
2212
2213 <p>
2214  In all cases if the person who reports the problem asks that it not
2215  be disclosed, such requests should be honored, with the obvious
2216  exception of informing the security team in order that a fix may be
2217  produced for a stable release of Debian.  When sending confidential
2218  information to the security team, be sure to mention this fact.
2219
2220 <p>
2221 Please note that if secrecy is needed you may not upload a fix to
2222 unstable (or anywhere else, such as a public CVS repository).  It is
2223 not sufficient to obfuscate the details of the change, as the code
2224 itself is public, and can (and will) be examined by the general public.
2225
2226 <p>
2227 There are two reasons for releasing information even though secrecy is
2228 requested: the problem has been known for a while, or that the problem
2229 or exploit has become public.
2230
2231         <sect2 id="bug-security-advisories">Security Advisories
2232           <p>
2233 Security advisories are only issued for the current, released stable
2234 distribution, and <em>not</em> for testing or unstable.  When released,
2235 advisories
2236 are sent to the &email-debian-security-announce;
2237
2238 mailing list and posted on <url
2239 id="&url-debian-security-advisories;" name="the security web page">.
2240 Security advisories are written and posted by the security
2241 team. However they certainly do not mind if a
2242 maintainer can supply some of the information for them, or write part
2243 of the text. Information that should be in an advisory includes:
2244
2245 <list compact>
2246   <item>A description of the problem and its scope, including:
2247     <list>
2248        <item>The type of problem (privilege escalation, denial of
2249   service, etc.)
2250        <item>What privileges may be gained, and by whom (if any)
2251        <item>How it can be exploited
2252        <item>Whether it is remotely or locally exploitable
2253        <item>How the problem was fixed
2254     </list>
2255
2256   This information allows users to assess the threat to their systems.
2257
2258   <item>Version numbers of affected packages
2259   <item>Version numbers of fixed packages
2260   <item>Information on where to obtain the updated packages
2261   (usually from the Debian security archive)
2262   <item>References to upstream advisories, <url
2263   id="http://cve.mitre.org" name="CVE"> identifiers, and any other
2264   information useful in cross-referencing the vulnerability
2265 </list>
2266
2267          <sect2 id="bug-security-building">
2268             <heading>Preparing packages to address security issues</heading>
2269          <p>
2270 One way that you can assist the security team in their duties is to
2271 provide them with fixed packages suitable for a security advisory for
2272 the stable
2273 Debian release.
2274          <p>
2275  When an update is made to the stable release, care must be taken to
2276  avoid changing system behavior or introducing new bugs.  In order to
2277  do this, make as few changes as possible to fix the bug.  Users and
2278  administrators rely on the exact behavior of a release once it is
2279  made, so any change that is made might break someone's system.  This
2280  is especially true of libraries: make sure you never change the API or
2281  ABI, no matter how small the change.
2282 <p>
2283 This means that moving to a new upstream version is not a good
2284 solution.  Instead, the relevant changes should be back-ported to the
2285 version present in the current stable Debian release. Generally,
2286 upstream maintainers are willing to help if needed.  If not, the
2287 Debian security team may be able to help.
2288 <p>
2289 In some cases, it is not possible to back-port a security fix, for
2290 example when large amounts of source code need to be modified or
2291 rewritten.  If this happens, it may be necessary to move to a new
2292 upstream version.  However, this is only done in extreme situations,
2293 and you must always coordinate that with the security team beforehand.
2294 <p>
2295 Related to this is another important guideline: always test your
2296 changes.  If you have an exploit available, try it and see if it
2297 indeed succeeds on the unpatched package and fails on the fixed
2298 package.  Test other, normal actions as well, as sometimes a security
2299 fix can break seemingly unrelated features in subtle ways.
2300 <p>
2301 Review and test your changes as much as possible.  Check the
2302 differences from the previous version repeatedly
2303 (<prgn>interdiff</prgn> from the <package>patchutils</package> package
2304 and <prgn>debdiff</prgn> from <package>devscripts</package> are useful
2305 tools for this, see <ref id="debdiff">).
2306 <p>
2307 When packaging the fix, keep the following points in mind:
2308
2309 <list>
2310     <item>Make sure you target the right distribution in your
2311     <file>debian/changelog</file>. For stable this is <tt>stable-security</tt> and for
2312     testing this is <tt>testing-security</tt>, and for the previous
2313     stable release, this is <tt>oldstable-security</tt>. Do not target
2314     <var>distribution</var>-proposed-updates!
2315
2316     <item>Make descriptive, meaningful changelog entries.  Others will
2317     rely on them to determine whether a particular bug was fixed.
2318     Whenever possible, include an external reference, preferably a CVE
2319     identifier, so that it can be cross-referenced.
2320
2321     <item>Make sure the version number is proper. It must be greater
2322     than the current package, but less than package versions in later
2323     distributions.  If in doubt, test it with <tt>dpkg
2324     --compare-versions</tt>.  For <em>testing</em>, there must be
2325     a higher version in <em>unstable</em>. If there is none yet (for example,
2326     if <em>testing</em> and <em>unstable</em> have the same version) you must upload a
2327     new version to unstable first.
2328
2329     <item>Do not make source-only uploads if your package has any
2330     binary-all packages (do not use the <tt>-S</tt> option to
2331     <prgn>dpkg-buildpackage</prgn>).  The <prgn>buildd</prgn> infrastructure will
2332     not build those. This point applies to normal package uploads as
2333     well.
2334
2335     <item>If the upstream source has been uploaded to
2336     security.debian.org before (by a previous security update), build
2337     the upload without the upstream source (<tt>dpkg-buildpackage
2338     -sd</tt>).  Otherwise, build with full source
2339     (<tt>dpkg-buildpackage -sa</tt>).
2340
2341     <item>Be sure to use the exact same <file>*.orig.tar.gz</file> as used in the
2342     normal archive, otherwise it is not possible to move the security
2343     fix into the main archives later.
2344
2345     <item>Be sure to build the package on a clean
2346     system which only has packages installed from the distribution you
2347     are building for. If you do not have such a system yourself, you
2348     can use a debian.org machine (see <ref id="server-machines">)
2349     or setup a chroot (see <ref id="pbuilder"> and
2350     <ref id="debootstrap">).
2351 </list>
2352
2353       <sect2 id="bug-security-upload">Uploading the fixed package
2354 <p>
2355 <em>DO NOT</em> upload a package to the security upload queue
2356 (oldstable-security, stable-security, etc.) without
2357 prior authorization from the security team.  If the package does not
2358 exactly meet the team's requirements, it will cause many problems and
2359 delays in dealing with the unwanted upload.
2360 <p>
2361 <em>DO NOT</em> upload your fix to proposed-updates without
2362 coordinating with the security team.  Packages from
2363 security.debian.org will be copied into the proposed-updates directory
2364 automatically.  If a package with the same or a higher version number
2365 is already installed into the archive, the security update will be
2366 rejected by the archive system.  That way, the stable distribution
2367 will end up without a security update for this package instead.
2368 <p>
2369 Once you have created and tested the new package and it has been
2370 approved by the security team, it needs to be uploaded so that it can
2371 be installed in the archives. For security uploads, the place to
2372 upload to is
2373 <tt>ftp://security.debian.org/pub/SecurityUploadQueue/</tt> .
2374
2375 <p>
2376 Once an upload to the security queue has been accepted, the package
2377 will automatically be rebuilt for all architectures and stored for
2378 verification by the security team.
2379
2380 <p>
2381 Uploads which are waiting for acceptance or verification are only
2382 accessible by the security team. This is necessary since there might
2383 be fixes for security problems that cannot be disclosed yet.
2384
2385 <p>
2386 If a member of the security team accepts a package, it will be
2387 installed on security.debian.org as well as the proper
2388 <var>distribution</var>-proposed-updates on ftp-master or in the non-US
2389 archive.
2390
2391     <sect id="archive-manip">
2392       <heading>Moving, removing, renaming, adopting, and orphaning
2393       packages</heading>
2394       <p>
2395 Some archive manipulation operations are not automated in the Debian
2396 upload process.  These procedures should be manually followed by
2397 maintainers.  This chapter gives guidelines in what to do in these
2398 cases.
2399
2400       <sect1 id="moving-pkgs">Moving packages
2401         <p>
2402 Sometimes a package will change its section.  For instance, a
2403 package from the `non-free' section might be GPL'd in a later version,
2404 in which case, the package should be moved to `main' or
2405 `contrib'.<footnote> See the <url id="&url-debian-policy;"
2406 name="Debian Policy Manual"> for guidelines on what section a package
2407 belongs in.
2408           </footnote>
2409         <p>
2410 If you need to change the section for one of your packages, change the
2411 package control information to place the package in the desired
2412 section, and re-upload the package (see the <url id="&url-debian-policy;"
2413 name="Debian Policy Manual"> for details). If your new section is
2414 valid, it will be moved automatically. If it does not, then contact
2415 the ftpmasters in order to understand what happened.
2416         <p>
2417 If, on the other hand, you need to change the <em>subsection</em> of
2418 one of your packages (e.g., ``devel'', ``admin''), the procedure is
2419 slightly different.  Correct the subsection as found in the control
2420 file of the package, and re-upload that.  Also, you'll need to get the
2421 override file updated, as described in <ref id="override-file">.
2422
2423
2424       <sect1 id="removing-pkgs">Removing packages
2425         <p>
2426 If for some reason you want to completely remove a package (say, if it
2427 is an old compatibility library which is no longer required), you
2428 need to file a bug against <tt>ftp.debian.org</tt> asking that the
2429 package be removed.  Make sure you indicate which distribution the
2430 package should be removed from. Normally, you can only have packages
2431 removed from <em>unstable</em> and <em>experimental</em>.  Packages
2432 are not removed from <em>testing</em> directly. Rather, they will be
2433 removed automatically after the package has been removed from
2434 <em>unstable</em> and no package in <em>testing</em> depends on it.
2435         <p>
2436 You also have to detail the reasons justifying that request. This is to
2437 avoid unwanted removals and to keep a trace of why a package has been
2438 removed. For example, you can provide the name of the package that
2439 supersedes the one to be removed.
2440         <p>
2441 Usually you only ask the removal of a package maintained by yourself.
2442 If you want to remove another package, you have to get the approval
2443 of its last maintainer.
2444         <p>
2445 If in doubt concerning whether a package is disposable, email
2446 &email-debian-devel; asking for opinions.  Also of interest is the
2447 <prgn>apt-cache</prgn> program from the <package>apt</package>
2448 package.  When invoked as <tt>apt-cache showpkg
2449 <var>package</var></tt>, the program will show details for
2450 <var>package</var>, including reverse depends.
2451         <p>
2452 Once the package has been removed, the package's bugs should be handled.
2453 They should either be reassigned to another package in the case where
2454 the actual code has evolved into another package (e.g. <tt>libfoo12</tt>
2455 was removed because <tt>libfoo13</tt> supersedes it) or closed if the
2456 software is simply no more part of Debian.
2457
2458         <sect2>Removing packages from <file>Incoming</file>
2459           <p>
2460 In the past, it was possible to remove packages from <file>incoming</file>.
2461 However, with the introduction of the new incoming system, this is no longer
2462 possible.  Instead, you have to upload a new revision of your package with
2463 a higher version as the package you want to replace.  Both versions will be
2464 installed in the archive but only the higher version will actually be
2465 available in <em>unstable</em> since the previous version will immediately
2466 be replaced by the higher.  However, if you do proper testing of your
2467 packages, the need to replace a package should not occur too often anyway.
2468
2469       <sect1>Replacing or renaming packages
2470         <p>
2471 Sometimes you made a mistake naming the package and you need to rename
2472 it.  In this case, you need to follow a two-step process.  First, set
2473 your <file>debian/control</file> file to replace and conflict with the
2474 obsolete name of the package (see the <url id="&url-debian-policy;"
2475 name="Debian Policy Manual"> for details).  Once you've uploaded
2476 the package and the package has moved into the archive, file a bug
2477 against <tt>ftp.debian.org</tt> asking to remove the package with the
2478 obsolete name. Do not forget to properly reassign the package's bugs
2479 at the same time.
2480         <p>
2481 At other times, you may make a mistake in constructing your package and
2482 wish to replace it. The only way to do this is to increase the version
2483 number and upload a new version. The old version will be expired in
2484 the usual manner.  Note that this applies to each part of your package,
2485 including the sources: if you wish to replace the upstream source tarball
2486 of your package, you will need to upload it with a different version. An
2487 easy possibility is to replace <file>foo_1.00.orig.tar.gz</file> with
2488 <file>foo_1.00+0.orig.tar.gz</file>. This restriction gives each file
2489 on the ftp site a unique name, which helps to ensure consistency across the
2490 mirror network.
2491
2492       <sect1 id="orphaning">Orphaning a package
2493         <p>
2494 If you can no longer maintain a package, you need to inform the others
2495 about that, and see that the package is marked as orphaned.
2496 You should set the package maintainer to <tt>Debian QA Group
2497 &orphan-address;</tt> and submit a bug report
2498 against the pseudo package <package>wnpp</package>.  The bug report should be
2499 titled <tt>O: <var>package</var> -- <var>short description</var></tt>
2500 indicating that the package is now orphaned.  The severity of the bug
2501 should be set to <em>normal</em>. If you feel it's necessary, send a copy
2502 to &email-debian-devel; by putting the address in the X-Debbugs-CC: header
2503 of the message (no, don't use CC:, because that way the message's subject
2504 won't indicate the bug number).
2505         <p>
2506 If the package is especially crucial to Debian, you should instead submit
2507 a bug against <package>wnpp</package> and title it <tt>RFA: <var>package</var> --
2508 <var>short description</var></tt> and set its severity to
2509 <em>important</em>. <tt>RFA</tt> stands for <em>Request For Adoption</em>.
2510 Definitely copy the message to debian-devel in this case, as described
2511 above.
2512         <p>
2513 Read instructions on the <url id="&url-wnpp;" name="WNPP web pages">
2514 for more information.
2515
2516       <sect1 id="adopting">Adopting a package
2517         <p>
2518 A list of packages in need of a new maintainer is available at in the
2519 <url name="Work-Needing and Prospective Packages list (WNPP)"
2520 id="&url-wnpp;">. If you wish to take over maintenance of any of the
2521 packages listed in the WNPP, please take a look at the aforementioned
2522 page for information and procedures.
2523         <p>
2524 It is not OK to simply take over a package that you feel is neglected
2525 &mdash; that would be package hijacking.  You can, of course, contact the
2526 current maintainer and ask them if you may take over the package.
2527 If you have reason to believe a maintainer has gone AWOL
2528 (absent without leave), see <ref id="mia-qa">.
2529         <p>
2530 Generally, you may not take over the package without the assent of the
2531 current maintainer. Even if they ignore you, that is still not grounds to
2532 take over a package. Complaints about maintainers should be brought up on
2533 the developers' mailing list. If the discussion doesn't end with a positive
2534 conclusion, and the issue is of a technical nature, consider bringing it to
2535 the attention of the technical committee (see the <url name="technical
2536 committee web page" id="&url-tech-ctte;"> for more information).
2537         <p>
2538 If you take over an old package, you probably want to be listed as the
2539 package's official maintainer in the bug system. This will happen
2540 automatically once you upload a new version with an updated
2541 <tt>Maintainer:</tt> field, although it can take a few hours after the
2542 upload is done. If you do not expect to upload a new version for a while,
2543 you can use <ref id="pkg-tracking-system"> to get the bug reports. However,
2544 make sure that the old maintainer has no problem with the fact that
2545 they will continue to receive the bugs during that time.
2546
2547
2548     <sect id="porting">Porting and being ported
2549       <p>
2550 Debian supports an ever-increasing number of architectures.  Even if
2551 you are not a porter, and you don't use any architecture but one, it
2552 is part of your duty as a maintainer to be aware of issues of
2553 portability.  Therefore, even if you are not a porter, you should read
2554 most of this chapter.
2555       <p>
2556 Porting is the act of building Debian packages for architectures that
2557 is different from the original architecture of the package
2558 maintainer's binary package.  It is a unique and essential activity.
2559 In fact, porters do most of the actual compiling of Debian packages.
2560 For instance, for a single <em>i386</em> binary package, there must be
2561 a recompile for each architecture, which amounts to
2562 &number-of-arches; more builds.
2563
2564
2565       <sect1 id="kind-to-porters">Being kind to porters
2566         <p>
2567 Porters have a difficult and unique task, since they are required to
2568 deal with a large volume of packages.  Ideally, every source package
2569 should build right out of the box.  Unfortunately, this is often not
2570 the case.  This section contains a checklist of ``gotchas'' often
2571 committed by Debian maintainers &mdash; common problems which often stymie
2572 porters, and make their jobs unnecessarily difficult.
2573         <p>
2574 The first and most important watchword is to respond quickly to bug or
2575 issues raised by porters.  Please treat porters with courtesy, as if
2576 they were in fact co-maintainers of your package (which in a way, they
2577 are).  Please be tolerant of succinct or even unclear bug reports,
2578 doing your best to hunt down whatever the problem is.
2579         <p>
2580 By far, most of the problems encountered by porters are caused by
2581 <em>packaging bugs</em> in the source packages.  Here is a checklist
2582 of things you should check or be aware of.
2583
2584 <enumlist>
2585             <item>
2586 Make sure that your <tt>Build-Depends</tt> and
2587 <tt>Build-Depends-Indep</tt> settings in <file>debian/control</file>
2588 are set properly.  The best way to validate this is to use the
2589 <package>debootstrap</package> package to create an unstable chroot
2590 environment (see <ref id="debootstrap">).
2591 Within that chrooted environment, install the
2592 <package>build-essential</package> package and any package
2593 dependencies mentioned in <tt>Build-Depends</tt> and/or
2594 <tt>Build-Depends-Indep</tt>.  Finally, try building your package
2595 within that chrooted environment.  These steps can be automated
2596 by the use of the <prgn>pbuilder</prgn> program which is provided by
2597 the package of the same name (see <ref id="pbuilder">).
2598                 <p>
2599 If you can't set up a proper chroot, <prgn>dpkg-depcheck</prgn> may be
2600 of assistance (see <ref id="dpkg-depcheck">).
2601                 <p>
2602 See the <url id="&url-debian-policy;" name="Debian Policy
2603 Manual"> for instructions on setting build dependencies.
2604             <item>
2605 Don't set architecture to a value other than ``all'' or ``any'' unless
2606 you really mean it.  In too many cases, maintainers don't follow the
2607 instructions in the <url id="&url-debian-policy;" name="Debian Policy
2608 Manual">.  Setting your architecture to ``i386'' is usually incorrect.
2609             <item>
2610 Make sure your source package is correct.  Do <tt>dpkg-source -x
2611 <var>package</var>.dsc</tt> to make sure your source package unpacks
2612 properly.  Then, in there, try building your package from scratch with
2613 <prgn>dpkg-buildpackage</prgn>.
2614             <item>
2615 Make sure you don't ship your source package with the
2616 <file>debian/files</file> or <file>debian/substvars</file> files.
2617 They should be removed by the `clean' target of
2618 <file>debian/rules</file>.
2619             <item>
2620 Make sure you don't rely on locally installed or hacked configurations
2621 or programs.  For instance, you should never be calling programs in
2622 <file>/usr/local/bin</file> or the like.  Try not to rely on programs
2623 be setup in a special way.  Try building your package on another
2624 machine, even if it's the same architecture.
2625             <item>
2626 Don't depend on the package you're building already being installed (a
2627 sub-case of the above issue).
2628             <item>
2629 Don't rely on the compiler being a certain version, if possible.  If
2630 not, then make sure your build dependencies reflect the restrictions,
2631 although you are probably asking for trouble, since different
2632 architectures sometimes standardize on different compilers.
2633             <item>
2634 Make sure your debian/rules contains separate ``binary-arch'' and
2635 ``binary-indep'' targets, as the Debian Policy Manual requires.
2636 Make sure that both targets work independently, that is, that you can
2637 call the target without having called the other before. To test this,
2638 try to run <tt>dpkg-buildpackage -B</tt>.
2639           </enumlist>
2640
2641
2642       <sect1 id="porter-guidelines">Guidelines for porter uploads
2643         <p>
2644 If the package builds out of the box for the architecture to be ported
2645 to, you are in luck and your job is easy.  This section applies to
2646 that case; it describes how to build and upload your binary package so
2647 that it is properly installed into the archive.  If you do have to
2648 patch the package in order to get it to compile for the other
2649 architecture, you are actually doing a source NMU, so consult <ref
2650 id="nmu-guidelines"> instead.
2651         <p>
2652 For a porter upload, no changes are being made to the source.  You do
2653 not need to touch any of the files in the source package.  This
2654 includes <file>debian/changelog</file>.
2655         <p>
2656 The way to invoke <prgn>dpkg-buildpackage</prgn> is as
2657 <tt>dpkg-buildpackage -B -m<var>porter-email</var></tt>.  Of course,
2658 set <var>porter-email</var> to your email address.  This will do a
2659 binary-only build of only the architecture-dependent portions of the
2660 package, using the `binary-arch' target in <file>debian/rules</file>.
2661
2662         <sect2 id="binary-only-nmu">
2663           <heading>Recompilation or binary-only NMU</heading>
2664         <p>
2665 Sometimes the initial porter upload is problematic because the environment
2666 in which the package was built was not good enough (outdated or obsolete
2667 library, bad compiler, ...). Then you may just need to recompile it in
2668 an updated environment. However, you have to bump the version number in
2669 this case, so that the old bad package can be replaced in the Debian archive
2670 (<prgn>katie</prgn> refuses to install new packages if they don't have a
2671 version number greater than the currently available one).  Despite the
2672 required modification of the changelog, these are called binary-only NMUs
2673 &mdash; there is no need in this case to trigger all other architectures
2674 to consider themselves out of date or requiring recompilation.
2675         <p>
2676 Such recompilations require special ``magic'' version numbering, so that
2677 the archive maintenance tools recognize that, even though there is a
2678 new Debian version, there is no corresponding source update.  If you
2679 get this wrong, the archive maintainers will reject your upload (due
2680 to lack of corresponding source code).
2681         <p>
2682 The ``magic'' for a recompilation-only NMU is triggered by using the
2683 third-level number on the Debian part of the version.  For instance,
2684 if the latest version you are recompiling against was version
2685 ``2.9-3'', your NMU should carry a version of ``2.9-3.0.1''.  If the
2686 latest version was ``3.4-2.1'', your NMU should have a version number
2687 of ``3.4-2.1.1''.
2688
2689
2690         <sect2 id="source-nmu-when-porter">
2691           <heading>When to do a source NMU if you are a porter</heading>
2692           <p>
2693 Porters doing a source NMU generally follow the guidelines found in
2694 <ref id="nmu">, just like non-porters.  However, it is expected that
2695 the wait cycle for a porter's source NMU is smaller than for a
2696 non-porter, since porters have to cope with a large quantity of
2697 packages.
2698 Again, the situation varies depending on the distribution they are
2699 uploading to.
2700
2701 <!-- 
2702 FIXME: commented out until I can work out how to upload to testing directly
2703
2704   Crucial fixes (i.e., changes need to get a source
2705 package to compile for a released-targeted architecture) can be
2706 uploaded with <em>no</em> waiting period for the `frozen' distribution.
2707  -->
2708           <p>
2709 However, if you are a porter doing an NMU for `unstable', the above
2710 guidelines for porting should be followed, with two variations.
2711 Firstly, the acceptable waiting period &mdash; the time between when the
2712 bug is submitted to the BTS and when it is OK to do an NMU &mdash; is seven
2713 days for porters working on the unstable distribution.  This period
2714 can be shortened if the problem is critical and imposes hardship on
2715 the porting effort, at the discretion of the porter group.  (Remember,
2716 none of this is Policy, just mutually agreed upon guidelines.)
2717           <p>
2718 Secondly, porters doing source NMUs should make sure that the bug they
2719 submit to the BTS should be of severity `serious' or greater.  This
2720 ensures that a single source package can be used to compile every
2721 supported Debian architecture by release time.  It is very important
2722 that we have one version of the binary and source package for all
2723 architecture in order to comply with many licenses.
2724           <p>
2725 Porters should try to avoid patches which simply kludge around bugs in
2726 the current version of the compile environment, kernel, or libc.
2727 Sometimes such kludges can't be helped.  If you have to kludge around
2728 compilers bugs and the like, make sure you <tt>#ifdef</tt> your work
2729 properly; also, document your kludge so that people know to remove it
2730 once the external problems have been fixed.
2731           <p>
2732 Porters may also have an unofficial location where they can put the
2733 results of their work during the waiting period.  This helps others
2734 running the port have the benefit of the porter's work, even during
2735 the waiting period.  Of course, such locations have no official
2736 blessing or status, so buyer, beware.
2737
2738
2739       <sect1 id="porter-automation">
2740           <heading>Porting infrastructure and automation</heading>
2741           <p>
2742 There is infrastructure and several tools to help automate the package
2743 porting. This section contains a brief overview of this automation and
2744 porting to these tools; see the package documentation or references for
2745 full information.</p>
2746
2747           <sect2>
2748             <heading>Mailing lists and web pages</heading>
2749             <p>
2750 Web pages containing the status of each port can be found at <url
2751 id="&url-debian-ports;">.
2752             <p>
2753 Each port of Debian has a mailing list.  The list of porting mailing
2754 lists can be found at <url id="&url-debian-port-lists;">.  These lists
2755 are used to coordinate porters, and to connect the users of a given
2756 port with the porters.</p>
2757           </sect2>
2758
2759           <sect2>
2760             <heading>Porter tools</heading>
2761             <p>
2762 Descriptions of several porting tools can be found in <ref
2763 id="tools-porting">.</p>
2764           </sect2>
2765
2766           <sect2 id="buildd">
2767             <heading><package>buildd</package></heading>
2768             <p>
2769 The <package>buildd</package> system is used as a distributed,
2770 client-server build distribution system.  It is usually used in
2771 conjunction with <em>auto-builders</em>, which are ``slave'' hosts
2772 which simply check out and attempt to auto-build packages which need
2773 to be ported.  There is also an email interface to the system, which
2774 allows porters to ``check out'' a source package (usually one which
2775 cannot yet be auto-built) and work on it.
2776           <p>
2777 <package>buildd</package> is not yet available as a package; however,
2778 most porting efforts are either using it currently or planning to use
2779 it in the near future.  The actual automated builder is packaged as
2780 <package>sbuild</package>, see its description in <ref id="sbuild">.
2781 The complete <package>buildd</package> system also collects a number of as yet unpackaged
2782 components which are currently very useful and in use continually,
2783 such as <prgn>andrea</prgn> and
2784 <prgn>wanna-build</prgn>.
2785           <p>
2786 Some of the data produced by <package>buildd</package> which is
2787 generally useful to porters is available on the web at <url
2788 id="&url-buildd;">.  This data includes nightly updated information
2789 from <prgn>andrea</prgn> (source dependencies) and
2790 <package>quinn-diff</package> (packages needing recompilation).
2791           <p>
2792 We are quite proud of this system, since it has so
2793 many possible uses.  Independent development groups can use the system for
2794 different sub-flavors of Debian, which may or may not really be of
2795 general interest (for instance, a flavor of Debian built with <prgn>gcc</prgn>
2796 bounds checking).  It will also enable Debian to recompile entire
2797 distributions quickly.
2798           </sect2>
2799
2800
2801     <sect id="nmu">Non-Maintainer Uploads (NMUs)
2802       <p>
2803 Under certain circumstances it is necessary for someone other than the
2804 official package maintainer to make a release of a package.  This is
2805 called a non-maintainer upload, or NMU.
2806        <p>
2807 Debian porters, who compile packages for different architectures,
2808 occasionally do binary-only NMUs as part of their porting activity
2809 (see <ref id="porting">).  Another reason why NMUs are done is when a
2810 Debian developers needs to fix another developers' packages in order to
2811 address serious security problems or crippling bugs, especially during
2812 the freeze, or when the package maintainer is unable to release a fix
2813 in a timely fashion.
2814       <p>
2815 This chapter contains information providing guidelines for when and
2816 how NMUs should be done.  A fundamental distinction is made between
2817 source and binary-only NMUs, which is explained in the next section.
2818
2819       <sect1 id="nmu-terms">Terminology
2820         <p>
2821 There are two new terms used throughout this section: ``binary-only NMU''
2822 and ``source NMU''.  These terms are used with specific technical
2823 meaning throughout this document.  Both binary-only and source NMUs are
2824 similar, since they involve an upload of a package by a developer who
2825 is not the official maintainer of that package.  That is why it's a
2826 <em>non-maintainer</em> upload.
2827         <p>
2828 A source NMU is an upload of a package by a developer who is not the
2829 official maintainer, for the purposes of fixing a bug in the package.
2830 Source NMUs always involves changes to the source (even if it is just
2831 a change to <file>debian/changelog</file>).  This can be either a
2832 change to the upstream source, or a change to the Debian bits of the
2833 source.  Note, however, that source NMUs may also include
2834 architecture-dependent packages, as well as an updated Debian diff.
2835         <p>
2836 A binary-only NMU is a recompilation and upload of a binary package
2837 for a given architecture.  As such, it is usually part of a porting
2838 effort.  A binary-only NMU is a non-maintainer uploaded binary version
2839 of a package, with no source changes required.  There are many cases
2840 where porters must fix problems in the source in order to get them to
2841 compile for their target architecture; that would be considered a
2842 source NMU rather than a binary-only NMU.  As you can see, we don't
2843 distinguish in terminology between porter NMUs and non-porter NMUs.
2844         <p>
2845 Both classes of NMUs, source and binary-only, can be lumped by the
2846 term ``NMU''.  However, this often leads to confusion, since most
2847 people think ``source NMU'' when they think ``NMU''.  So it's best to
2848 be careful.  In this chapter, if we use the unqualified term ``NMU'',
2849 we refer to any type of non-maintainer upload NMUs, whether source and
2850 binary, or binary-only.
2851
2852
2853       <sect1 id="nmu-who">Who can do an NMU
2854         <p>
2855 Only official, registered Debian maintainers can do binary or source
2856 NMUs.  An official maintainer is someone who has their key in the
2857 Debian key ring.  Non-developers, however, are encouraged to download
2858 the source package and start hacking on it to fix problems; however,
2859 rather than doing an NMU, they should just submit worthwhile patches
2860 to the Bug Tracking System.  Maintainers almost always appreciate
2861 quality patches and bug reports.
2862
2863
2864       <sect1 id="nmu-when">When to do a source NMU
2865         <p>
2866 Guidelines for when to do a source NMU depend on the target
2867 distribution, i.e., stable, unstable, or experimental.  Porters have
2868 slightly different rules than non-porters, due to their unique
2869 circumstances (see <ref id="source-nmu-when-porter">).
2870         <p>
2871 When a security bug is detected, the security team may do an NMU.
2872 Please refer to <ref id="bug-security"> for more information.
2873         <p>
2874 During the release cycle (see <ref id="sec-dists">), NMUs which fix
2875 serious or higher severity bugs are encouraged and accepted.  Even
2876 during this window, however, you should endeavor to reach the current
2877 maintainer of the package; they might be just about to upload a fix
2878 for the problem.  As with any source NMU, the guidelines found in <ref
2879 id="nmu-guidelines"> need to be followed. Special exceptions are made
2880 for <ref id="qa-bsp">.
2881         <p>
2882 Uploading bug fixes to unstable by non-maintainers should only be done
2883 by following this protocol:
2884         <p>
2885 <list>
2886             <item>
2887 Make sure that the package's bugs that the NMU is meant to address are all
2888 filed in the Debian Bug Tracking System (BTS).
2889 If they are not, submit them immediately.
2890             <item>
2891 Wait a few days the response from the maintainer. If you don't get
2892 any response, you may want to help him by sending the patch that fixes
2893 the bug. Don't forget to tag the bug with the "patch" keyword.
2894             <item>
2895 Wait a few more days. If you still haven't got an answer from the
2896 maintainer, send him a mail announcing your intent to NMU the package.
2897 Prepare an NMU as described in <ref id="nmu-guidelines">, test it
2898 carefully on your machine (cf. <ref id="sanitycheck">).
2899 Double check that your patch doesn't have any unexpected side effects.
2900 Make sure your patch is as small and as non-disruptive as it can be.  
2901             <item>
2902 Upload your package to incoming in <file>DELAYED/7-day</file> (cf.
2903 <ref id="delayed-incoming">), send the final patch to the maintainer via
2904 the BTS, and explain to them that they have 7 days to react if they want
2905 to cancel the NMU.
2906             <item>
2907 Follow what happens, you're responsible for any bug that you introduced
2908 with your NMU. You should probably use <ref id="pkg-tracking-system"> (PTS)
2909 to stay informed of the state of the package after your NMU.
2910 </list>
2911         <p>
2912 At times, the release manager or an organized group of developers can
2913 announce a certain period of time in which the NMU rules are relaxed.
2914 This usually involves shortening the period during which one is to wait
2915 before uploading the fixes, and shortening the DELAYED period. It is
2916 important to notice that even in these so-called "bug squashing party"
2917 times, the NMU'er has to file bugs and contact the developer first,
2918 and act later.
2919
2920       <sect1 id="nmu-guidelines">How to do a source NMU
2921         <p>
2922 The following applies to porters insofar as they are playing the dual
2923 role of being both package bug-fixers and package porters.  If a
2924 porter has to change the Debian source archive, automatically their
2925 upload is a source NMU and is subject to its rules.  If a porter is
2926 simply uploading a recompiled binary package, the rules are different;
2927 see <ref id="porter-guidelines">.
2928         <p>
2929 First and foremost, it is critical that NMU patches to source should
2930 be as non-disruptive as possible.  Do not do housekeeping tasks, do
2931 not change the name of modules or files, do not move directories; in
2932 general, do not fix things which are not broken.  Keep the patch as
2933 small as possible.  If things bother you aesthetically, talk to the
2934 Debian maintainer, talk to the upstream maintainer, or submit a bug.
2935 However, aesthetic changes must <em>not</em> be made in a non-maintainer
2936 upload.
2937
2938
2939         <sect2 id="nmu-version">Source NMU version numbering
2940           <p>
2941 Whenever you have made a change to a package, no matter how trivial,
2942 the version number needs to change.  This enables our packing system
2943 to function.
2944           <p>
2945 If you are doing a non-maintainer upload (NMU), you should add a new
2946 minor version number to the <var>debian-revision</var> part of the
2947 version number (the portion after the last hyphen).  This extra minor
2948 number will start at `1'.  For example, consider the package `foo',
2949 which is at version 1.1-3.  In the archive, the source package control
2950 file would be <file>foo_1.1-3.dsc</file>.  The upstream version is
2951 `1.1' and the Debian revision is `3'.  The next NMU would add a new
2952 minor number `.1' to the Debian revision; the new source control file
2953 would be <file>foo_1.1-3.1.dsc</file>.
2954           <p>
2955 The Debian revision minor number is needed to avoid stealing one of
2956 the package maintainer's version numbers, which might disrupt their
2957 work.  It also has the benefit of making it visually clear that a
2958 package in the archive was not made by the official maintainer.
2959           <p>
2960 If there is no <var>debian-revision</var> component in the version
2961 number then one should be created, starting at `0.1'.  If it is
2962 absolutely necessary for someone other than the usual maintainer to
2963 make a release based on a new upstream version then the person making
2964 the release should start with the <var>debian-revision</var> value
2965 `0.1'.  The usual maintainer of a package should start their
2966 <var>debian-revision</var> numbering at `1'. 
2967
2968
2969         <sect2 id="nmu-changelog">
2970           <heading>Source NMUs must have a new changelog entry</heading>
2971           <p>
2972 A non-maintainer doing a source NMU must create a changelog entry,
2973 describing which bugs are fixed by the NMU, and generally why the NMU
2974 was required and what it fixed.  The changelog entry will have the
2975 non-maintainer's email address in the log entry and the NMU version
2976 number in it.
2977           <p>
2978 By convention, source NMU changelog entries start with the line
2979 <example>
2980   * Non-maintainer upload
2981 </example>
2982
2983
2984         <sect2 id="nmu-patch">Source NMUs and the Bug Tracking System
2985           <p>
2986 Maintainers other than the official package maintainer should make as
2987 few changes to the package as possible, and they should always send a
2988 patch as a unified context diff (<tt>diff -u</tt>) detailing their
2989 changes to the Bug Tracking System.
2990           <p>
2991 What if you are simply recompiling the package? If you just need to
2992 recompile it for a single architecture, then you may do a binary-only
2993 NMU as described in <ref id="binary-only-nmu"> which doesn't require any
2994 patch to be sent. If you want the package to be recompiled for all
2995 architectures, then you do a source NMU as usual and you will have to
2996 send a patch.
2997           <p>
2998 If the source NMU (non-maintainer upload) fixes some existing bugs,
2999 these bugs should be tagged <em>fixed</em> in the Bug Tracking
3000 System rather than closed.  By convention, only the official package
3001 maintainer or the original bug submitter are allowed to close bugs.
3002 Fortunately, Debian's archive system recognizes NMUs and thus marks
3003 the bugs fixed in the NMU appropriately if the person doing the NMU
3004 has listed all bugs in the changelog with the <tt>Closes:
3005 bug#<var>nnnnn</var></tt> syntax (see <ref id="upload-bugfix"> for
3006 more information describing how to close bugs via the changelog).
3007 Tagging the bugs <em>fixed</em> ensures that everyone knows that the
3008 bug was fixed in an NMU; however the bug is left open until the
3009 changes in the NMU are incorporated officially into the package by
3010 the official package maintainer.
3011           <p>
3012 Also, after doing an NMU, you have to open a new bug and include a
3013 patch showing all the changes you have made. Alternatively you can send
3014 that information to the existing bugs that are fixed by your NMU.
3015 The normal maintainer will either apply the patch or employ an alternate
3016 method of fixing the problem.  Sometimes bugs are fixed independently
3017 upstream, which is another good reason to back out an NMU's patch.
3018 If the maintainer decides not to apply the NMU's patch but to release a
3019 new version, the maintainer needs to ensure that the new upstream version
3020 really fixes each problem that was fixed in the non-maintainer release.
3021           <p>
3022 In addition, the normal maintainer should <em>always</em> retain the
3023 entry in the changelog file documenting the non-maintainer upload.
3024
3025
3026         <sect2 id="nmu-build">Building source NMUs
3027           <p>
3028 Source NMU packages are built normally.  Pick a distribution using the
3029 same rules as found in <ref id="distribution">, follow the other
3030 prescriptions in <ref id="upload">.
3031           <p>
3032 Make sure you do <em>not</em> change the value of the maintainer in
3033 the <file>debian/control</file> file.  Your name as given in the NMU entry of
3034 the <file>debian/changelog</file> file will be used for signing the
3035 changes file.
3036
3037       <sect1 id="ack-nmu">Acknowledging an NMU
3038         <p>
3039 If one of your packages has been NMU'ed, you have to incorporate the
3040 changes in your copy of the sources. This is easy, you just have
3041 to apply the patch that has been sent to you. Once this is done, you
3042 have to close the bugs that have been tagged fixed by the NMU. You
3043 can either close them manually by sending the required mails to the
3044 BTS or by adding the required <tt>closes: #nnnn</tt> in the changelog
3045 entry of your next upload.
3046         <p>
3047 In any case, you should not be upset by the NMU. An NMU is not a
3048 personal attack against the maintainer. It is a proof that
3049 someone cares enough about the package and that they were willing to help
3050 you in your work, so you should be thankful. You may also want to
3051 ask them if they would be interested to help you on a more frequent
3052 basis as co-maintainer or backup maintainer
3053 (see <ref id="collaborative-maint">).
3054
3055
3056     <sect id="collaborative-maint">
3057         <heading>Collaborative maintenance</heading>
3058         <p>
3059 "Collaborative maintenance" is a term describing the sharing of Debian
3060 package maintenance duties by several people.  This collaboration is
3061 almost always a good idea, since it generally results in higher quality and
3062 faster bug fix turnaround time.  It is strongly recommended that
3063 packages in which a priority of <tt>Standard</tt> or which are part of
3064 the base set have co-maintainers.</p>
3065         <p>
3066 Generally there is a primary maintainer and one or more
3067 co-maintainers.  The primary maintainer is the whose name is listed in
3068 the <tt>Maintainer</tt> field of the <file>debian/control</file> file.
3069 Co-maintainers are all the other maintainers.</p>
3070         <p>
3071 In its most basic form, the process of adding a new co-maintainer is
3072 quite easy:<list>
3073             <item>
3074               <p>
3075 Setup the co-maintainer with access to the sources you build the
3076 package from.  Generally this implies you are using a network-capable
3077 version control system, such as <prgn>CVS</prgn> or
3078 <prgn>Subversion</prgn>.</p>
3079             </item>
3080             <item>
3081               <p>
3082 Add the co-maintainer's correct maintainer name and address to the
3083 <tt>Uploaders</tt> field in the global part of the
3084 <file>debian/control</file> file.
3085 <example>
3086 Uploaders: John Buzz &lt;jbuzz@debian.org&gt;, Adam Rex &lt;arex@debian.org&gt;
3087 </example>
3088 </p>
3089             </item>
3090             <item>
3091               <p>
3092 Using the PTS (<ref id="pkg-tracking-system">), the co-maintainers
3093 should subscribe themselves to the appropriate source package.</p>
3094             </item>
3095           </list></p>
3096       </sect>
3097
3098
3099
3100   <chapt id="best-pkging-practices">
3101     <heading>Best Packaging Practices</heading>
3102     <p>
3103 Debian's quality is largely due to the <url id="&url-debian-policy;"
3104 name="Debian Policy">, which defines explicit baseline requirements
3105 which all Debian packages must fulfill.  Yet there is also a shared
3106 history of experience which goes beyond the Debian Policy, an
3107 accumulation of years of experience in packaging.  Many very
3108 talented people have created great tools, tools which help you, the
3109 Debian maintainer, create and maintain excellent packages.
3110     <p>
3111 This chapter provides some best practices for Debian developers.  All
3112 recommendations are merely that, and are not requirements or policy.
3113 These are just some subjective hints, advice and pointers collected
3114 from Debian developers.  Feel free to pick and choose whatever works
3115 best for you.
3116
3117     <sect id="bpp-debian-rules">
3118         <heading>Best practices for <file>debian/rules</file></heading>