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