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