chiark / gitweb /
"Interim releases": if you NMU a new upstream version (0.1), run
[developers-reference.git] / developers-reference.sgml
1 <!doctype debiandoc system [
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 ]>
6 <debiandoc>
7 <!--
8  TODO:
9   - bugs in upstream versions should be reported upstream!
10   - porter instructions - - volunteers needed for this x86-centric
11     maintainer!
12   - add information on how to get accounts on different architectures
13   - talk about CVS access
14  -->
15
16   <book>
17
18       <title>Debian Developer's Reference
19       <author>Adam P. Harris, current maintainer <email/aph@debian.org/
20       <author>Christian Schwarz <email/schwarz@debian.org/
21       <author>Ian Jackson <email/ijackson@gnu.ai.mit.edu/
22       <version>ver. &version;, &date;
23
24       <copyright>
25         <copyrightsummary><!-- this tag not working right -->
26         <p>
27 Copyright &copy;1998 Adam P. Harris.  Copyright &copy;1997,1998
28 Christian Schwarz.
29         <p>
30 This manual is free software; you may redistribute it and/or modify it
31 under the terms of the GNU General Public License as published by the
32 Free Software Foundation; either version 2, or (at your option) any
33 later version.
34         <p>
35 This is distributed in the hope that it will be useful, but
36 <em>without any warranty</em>; without even the implied warranty of
37 merchantability or fitness for a particular purpose.  See the GNU
38 General Public License for more details.
39         <p>
40 A copy of the GNU General Public License is available as
41 <tt>/usr/doc/copyright/GPL</tt> in the Debian GNU/Linux distribution
42 or on the World Wide Web at <url
43 id="http://www.gnu.org/copyleft/gpl.html" name="the GNU website">.
44 You can also obtain it by writing to the Free Software Foundation,
45 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
46
47     <toc sect>
48
49     <chapt id="scope">Scope of This Document
50       <p>
51 The purpose of this document is to provide an overview of the
52 recommended procedures and the available resources for Debian
53 developers.
54       <p>
55 The procedures discussed within include how to become a maintainer
56 (<ref id="new-maintainer">); how to upload new packages (<ref
57 id="upload">); how and when to do interim releases of other
58 maintainer's packages (<ref id="nmu">); how to move, remove, or orphan
59 packages (<ref id="archive-manip">); and how to handle bug reports
60 (<ref id="bug-handling">).
61       <p>
62 The resources discussed in this reference include the mailing lists
63 and servers (<ref id="servers">); a discussion of the structure of the
64 Debian archive (<ref id="archive">); explanation of the different
65 servers which accept package uploads (<ref id="upload-master">); and a
66 discussion of resources which an help maintainers with the quality of
67 their packages (<ref id="tools">).
68       <p>
69 It should be clear that this reference does not discuss the technical
70 details of the Debian package nor how to generate Debian packages;
71 that information is discussed in the <url
72 id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
73 name="Debian Packaging Manual">.  Nor does this reference detail the
74 standards to which Debian software must comply; that information can
75 be found in the <url id="http://www.debian.org/doc/debian-policy/"
76 name="Debian Policy Manual">.
77
78
79     <chapt id="new-maintainer">Applying to Become a Maintainer
80         
81       <sect>Getting started
82         <p>
83 So, you've read all the documentation, you understand what everything
84 in the <package/hello/ example package is for, and you're about to
85 Debianize your favourite piece of software.  How do you actually
86 become a Debian developer so that your work can be incorporated into
87 the Project?
88         <p>
89 Firstly, subscribe to <email/debian-devel@lists.debian.org/ if you
90 haven't already.  Send the word <tt/subscribe/ in the <em/Subject/ of
91 an email to <email/debian-devel-REQUEST@lists.debian.org/.  In case of
92 problems, contact the list administrator at
93 <email/listmaster@lists.debian.org/.  More information on available
94 mailing lists can be found in <ref id="mailing-lists">.
95         <p>
96 You should subscribe and lurk for a bit before doing any coding, and
97 you should post about your intentions to work on something to avoid
98 duplicated effort.
99         <p>
100 Another good list to subscribe to is
101 <email/debian-mentors@lists.debian.org/.  See <ref id="mentors"> for
102 details.  The IRC channel <tt/#debian/ on the Linux People IRC network 
103 (i.e., <tt/irc.debian.org/) can also be helpful.
104
105
106       <sect>Registering as a Debian developer
107         <p>
108 Before you decide to register with the Debian Project, you will need
109 to read the <url id="http://www.debian.org/social_contract"
110 name="Debian Social Contract">.  Registering as a developer means that
111 you agree with and pledge to uphold the Debian Social Contract; it is
112 very important that maintainers are in accord with the essential ideas
113 behind Debian GNU/Linux.  Reading the <url
114 id="http://www.gnu.org/gnu/manifesto.html" name="GNU Manifesto"> would
115 also be a good idea.
116         <p>
117 The process of registering as a developer is a process of verifying
118 your identity and intentions.  As the number of people working on
119 Debian GNU/Linux has grown to over 400 people and our systems are used
120 in several very important places we have to be careful about being
121 compromised.  Therefore, we need to verify new maintainers before we
122 can give them accounts on our servers and letting them upload
123 packages.
124         <p>
125 Registration requires that the following information be sent to
126 <email/new-maintainer@debian.org/ as part of the registration
127 application:
128 <list>
129             <item>
130 Your name.
131             <item>
132 Your preferred login name on <tt/master/ (seven characters or
133 less<footnote>It is not clear to the author why logins on
134 <tt>master</tt> cannot be eight characters or greater.  If anyone can
135 clarify why, I would appreciate it.</footnote>), as well as the email
136 address at which you'd prefer to be subscribed to
137 <email/debian-private@lists.debian.org/ (typically this will be either
138 your primary mail address or your new <tt>debian.org</tt> address).
139             <item>
140 A phone number where we can call you.  Remember that the new
141 maintainer team usually calls during evening hours to save on long
142 distance tolls.  Please do not give a work number, unless you are
143 generally there in the evening.
144             <item>
145 A statement of intention, that is, what package(s) you intend to work
146 on, which Debian port you will be assisting, or how you intend to
147 contribute to Debian.
148             <item>
149 A statement that you have read and agree to uphold the <url
150 id="http://www.debian.org/social_contract" name="Debian Social
151 Contract">.
152             <item>
153 Some mechanism by which we can verify your real-life identity. For
154 example, any of the following mechanisms would suffice:
155 <list>
156                   <item>
157 A PGP key signed by any well-known signature, such as:
158 <list>
159                         <item>
160 Any current Debian developer you have met <em/in real life/.
161                         <item>
162 Any formal certification service (such as Verisign, etc.) that
163 verifies your identity.  A certification that verifies your email
164 address, and not you identity, is not sufficient.
165                       </list>
166                   <item>
167 Alternatively, you may identify yourself with a scanned (or physically
168 mailed) copy of any formal documents certifying your identity (such as
169 a birth certificate, national ID card, U.S. Driver's License, etc.).
170 If emailed, please sign the mail with your PGP key.
171                 </list>
172           </list>
173         <p>
174 If you do not have a PGP key yet, generate one. Every developer needs
175 a PGP key in order to sign and verify package uploads. You should read
176 the PGP manual, since it has much important information which is
177 critical to its security.  Many more security failures are due to
178 human error than to software failure or high-powered spy techniques.
179         <p>
180 Our standard is to use <prgn>pgp</prgn> version 2.x.  You can use
181 <prgn/pgp/ version 5, if and only if you make an RSA key.  Note that
182 we are also working with the <prgn/gpg/ team so that we can have a
183 free alternative to PGP; however, this may take a little bit of time.
184         <p>
185 Your PGP key must be at least 1024 bits long.  There is no reason to
186 use a smaller key, and doing so would be much less secure.  Your key
187 must be signed with at least your own user ID.  This prevents user ID
188 tampering.  You can do it by executing <tt>pgp -ks
189 <var/your_userid/</tt>.
190         <p>
191 If your PGP key isn't on public PGP key servers such as
192 <tt>pgp.net</tt>, please read the documentation available locally
193 <tt>/usr/doc/pgp/keyserv.doc</tt>.  That document contains
194 instructions on how to put your key on the public key servers.
195         <p>
196 Due to export restrictions by the United States government some Debian
197 packages, including PGP, have been moved to an ftp site outside of the
198 United States. You can find the current locations of those packages on
199 <ftpsite/ftp.debian.org/ or <ftpsite/ftp.us.debian.org/ in the
200 <ftppath>/pub/debian/README.non-US</ftppath> file.
201         <p>
202 Some countries restrict the use of cryptographic software by their
203 citizens.  This need not impede one's activities as a Debian package
204 maintainer however, as it may be perfectly legal to use cryptographic
205 products for authentication, rather than encryption purposes (as is
206 the case in France).  The Debian Project does not require the use of
207 cryptography <em/qua/ cryptography in any manner.  If you live in a
208 country where use of cryptography even for authentication is forbidden
209 then please contact us so we can make special arrangements.
210         <p>
211 Once you have all your information ready, and your public key is
212 available on public key servers, send a message to
213 <email/new-maintainer@debian.org/ to register as an offical Debian
214 developer so that you will be able to upload your packages.  This
215 message must contain all the information discussed above.  The message
216 must also contain your PGP or RSA public key (extracted using <tt>pgp
217 -kxa</tt> in the case of PGP) for the database of keys which is
218 distributed from <ftpsite/ftp.debian.org/ in
219 <ftppath>/pub/debian/doc/debian-keyring.tar.gz</ftppath>, or the
220 <package/debian-keyring/ package.  Please be sure to sign your
221 request message with your chosen PGP or RSA key.
222         <p>
223 Once this information is received and processed, you should be
224 contacted with information about your new Debian maintainer account.
225 If you don't hear anything within 7-14 days, please send a followup
226 message asking if your original application was received.  Do not
227 re-send your original application, that will just confuse the
228 new-maintainer team. Please be patient, especially near release
229 points; mistakes do occasionally happen, and people do sometimes run
230 out of volunteer time.
231
232
233       <sect id="mentors">Debian Mentors
234         <p>
235 A mailing list called <email/debian-mentors@lists.debian.org/ which
236 has been set up for novice maintainers who seek help with initial
237 packaging and other developer-related issues.  Every new developer is
238 invited to subscribe to that list (see <ref id="mailing-lists"> for
239 details).
240         <p>
241 Those who prefer one-on-one help (e.g., via private email) should
242 also post to that list and an experienced developer will volunteer to
243 help.
244
245
246     <chapt id="servers">Mailing Lists and Servers
247
248       <sect id="mailing-lists">Mailing lists
249         <p>
250 The mailing list server is at <tt/lists.debian.org/.  Mail
251 <tt/debian-<var/foo/-REQUEST@lists.debian.org/, where
252 <tt/debian-<var/foo// is the name of the list, with the word
253 <tt/subscribe/ in the <em/Subject/ to subscribe to the list or
254 <tt/unsubscribe/ to unsubscribe.  More detailed instructions on how to
255 subscribe and unsubscribe to the mailing lists can be found at <url
256 id="http://www.debian.org/MailingLists/subscribe">, <url
257 id="ftp://ftp.debian.org/debian/doc/mailing-lists.txt"> or locally in
258 <tt>/usr/doc/debian/mailing-lists.txt</tt> if you have the
259 <package>doc-debian</package> package installed.
260         <p>
261 When replying to messages on the mailing list, please do not send a
262 carbon copy (<tt/CC/) to the original poster unless they explicitly
263 request to be copied.  Anyone who posts to a mailing list should read
264 it to see the responses.
265         <p>
266 In addition, all messages should usually only be sent to one of the
267 following mailing lists: <email/debian-devel@lists.debian.org/,
268 <email/debian-policy@lists.debian.org/,
269 <email/debian-user@lists.debian.org/,
270 <email/debian-announce@lists.debian.org/, or
271 <email/debian-devel-announce@lists.debian.org/.  Additional mailing
272 lists are available for special purposes; see <url
273 id="http://www.debian.org/MailingLists/subscribe">.  Cross-posting
274 (sending the same message to multiple lists) is discouraged.
275         <p>
276 <email/debian-private@lists.debian.org/ is a special mailing lists for
277 private discussions amongst Debian developers.  It is meant to be used
278 for posts which for whatever reason should not be published
279 publically.  As such, it is a low volume list, and users are urged not
280 to use <email/debian-private@lists.debian.org/ unless it is really
281 necessary.  Moreover, do <em/not/ forward email from that list to
282 anyone.
283         <p>
284 As ever on the net, please trim down the quoting of articles you're
285 replying to.  In general, please adhere to the usual conventions for
286 posting messages.
287         <p>
288 Online archives of mailing lists are available at <url
289 id="http://www.debian.org/Lists-Archives/">.
290
291
292       <sect id="servers-master">The master server
293         <p>
294 The master server, <tt/master.debian.org/, holds the canonical copy
295 of the Debian archive (excluding the non-U.S. packages). Generally,
296 package uploads go to this server; see <ref id="upload">. 
297         <p>
298 <tt/master.debian.org/ is the canonical location for the Bug Tracking
299 System (BTS).  If you plan on doing some statistical analysis or
300 processing of Debian bugs, this would be the place to do it.  Please
301 describe your plans on <email/debian-devel@lists.debian.org/ before
302 implementing anything, however, to reduce unnecessary duplication of
303 effort or wasted processing time.
304         <p>
305 All Debian developers have accounts on <tt/master.debian.org/.  Please
306 take care to protect your password to this machine.  Try to avoid
307 login or upload methods which send passwords over the Internet in the
308 clear.
309         <p>
310 If you find a problem with <tt/master.debian.org/ such as disk full,
311 suspicious activity, or whatever, send an email to
312 <email>debian-admin@debian.org</email>.
313
314       <sect id="servers-ftp">The FTP servers
315         <p>
316
317       <sect id="servers-www">The WWW servers
318         <p>
319 The main web server, <tt/www.debian.org/, is also known as
320 <tt/va.debian.org/.  All developers are given accounts on this
321 machine.
322         <p>
323 If you have some Debian-specific information which you want to serve
324 up on the web, you can do do this by putting material in the
325 <tt>public_html</tt> directory under your home directory.  You can do
326 this on either <tt/va.debian.org/ or <tt/master.debian.org/.  Any
327 material you put in those areas are accessible via the URLs
328 <tt>http://www.debian.org/~<var>user-id</var>/</tt> and
329 <tt>http://master.debian.org/~<var>user-id</var>/</tt>, respectively.
330 Generally, you'll want to use <tt/va/, for the <tt/www.debian.org/
331 address, although in some cases you may need to put it on <tt/master/.
332 Please do not put any material on Debian servers not relating to
333 Debian, unless you have prior permission. Send mail to
334 <email/debian-devel@lists.debian.org/ if you have any questions.
335         <p>
336 If you find a problem with the Debian web server, you should generally
337 submit a bug against the pseudo-package,
338 <package>www.debian.org</package>.  First check whether or not someone
339 else has already reported the problem on the <url
340 id="http://www.debian.org/Bugs/db/pa/lwww.debian.org.html" name="Bug
341 Tracking System">.
342
343       <sect id="servers-cvs">The CVS server
344         <p>
345 <tt/cvs.debian.org/ is also known as <tt/va.debian.org/, discussed
346 above.  If you need the use of a publically accessible CVS server, for
347 instance, to help coordinate work on a package between many different
348 developers, you can request a CVS area on the server.  Generally,
349 <tt/cvs.debian.org/ offers a combination of local CVS access,
350 anonymous client-server read-only access, and full client-server
351 access through <prgn>ssh</prgn>.
352         <p>
353 To request a CVS area, send a request via email to
354 <email>debian-admin@debian.org</email>.
355
356
357       <sect id="servers-mirrors">Mirrors of Debian servers
358         <p>
359 The web and FTP servers have several mirrors available.  Please do not
360 put heavy load on the canonical FTP or web servers.  Ideally, the
361 canonical servers only mirror out to a first tier of mirrors, and all
362 user access is to the mirrors.  This allows Debian to better spread
363 its bandwidth requirements over several servers and networks.  Note
364 that newer push mirroring techniques ensure that mirrors are as
365 up-to-date as they can be.
366         <p>
367 The main web page listing the available public FTP (and, usually,
368 HTTP) servers can be found at <url
369 id="http://www.debian.org/distrib/ftplist">.  More information
370 concerning Debian mirrors can be found at <url
371 id="http://www.debian.org/devel/mirror/">.  This useful page includes
372 information and tools which can be helpful if you are interested in
373 setting up your own mirror, either for internal or public access.
374         <p>
375 Note that mirrors are generally run by third-parties who are
376 interested in helping Debian.  As such, developers generally do not
377 have accounts on these machines.
378         <p>
379 Please do not mirror off of <tt/master.debian.org/.  This host already
380 has too much load.  Check the sites above for information, or email
381 <email/debian-devel@lists.debian.org/.
382
383     <chapt id="archive">The Debian Archive
384
385       <sect>Overview
386         <p>
387 The Debian GNU/Linux distribution consists of a lot of Debian packages
388 (<tt/.deb/'s, currently more than 1500) and a few additional files
389 (documentation, installation disk images, etc.).
390         <p>
391 Here is an example directory tree of a complete Debian distribution:
392         <p>
393 <example>
394 main/
395 main/binary-all/
396 main/binary-all/admin/
397 main/binary-all/base/
398 main/binary-all/comm/
399 main/binary-all/devel/
400      ...
401 main/binary-i386/
402 main/binary-i386/admin/
403 main/binary-i386/base/
404      ...
405 main/binary-m68k
406 main/binary-m68k/admin/
407 main/binary-m68k/base/
408      ...
409 main/source/
410 main/source/admin/
411 main/source/base/
412      ...
413 main/disks-i386/
414 main/disks-m68k/
415      ...
416
417 contrib/
418 contrib/binary-all/
419 contrib/binary-i386/
420 contrib/binary-m68k/
421      ...
422 contrib/source/
423
424 non-free/
425 non-free/binary-all/
426 non-free/binary-i386/
427 non-free/binary-m68k/
428          ...
429 non-free/source/
430 </example>
431         <p>
432 As you can see, the top-level directory of the distribution contains
433 three directories, namely <em>main</>, <em>contrib</>, and
434 <em>non-free</>. These directories are called <em>sections</>.
435         <p>
436 In each section, there is a directory with the source packages
437 (source), a directory for each supported architecture
438 (<tt/binary-i386/, <tt/binary-m68k/, etc.), and a directory for
439 architecture independent packages (<tt/binary-all/).
440         <p>
441 The <em/main/ section contains additional directories which holds the
442 disk images and some essential pieces of documentation required for
443 installing the Debian distribution on a specific architecture
444 (<tt/disks-i386/, <tt/disks-m68k/, etc.).
445         <p>
446 The <em/binary/ and <em/source/ directories are divided further into
447 <em/subsections/.
448
449
450       <sect>Sections
451         <p>
452 The <em>main</em> section is what makes up the <em>official Debian
453 GNU/Linux distribution</>.  The <em/main/ section is official because
454 it fully complies with all our guidelines.  The other two sections do
455 not, to different degrees; as such, they are not officially part of
456 Debian.
457         <p>
458 Every package in the main section must fully comply with the <url
459 id="http://www.debian.org/social_contract#guidelines" name="Debian
460 Free Software Guidelines"> (DFSG) and with all other policy
461 requirements as described in the <url
462 id="http://www.debian.org/doc/debian-policy/" name="Debian Policy
463 Manual">.  The DFSG is our definition of ``free software.'' Check out
464 the Debian Policy Manual for details.
465         <p>
466 The packages which do not apply to the DFSG are placed in the
467 <em/non-free/ section. These packages are not considered as part of
468 the Debian distribution, though we support their use, and we provide
469 infrastructure (such as our bug-tracking system and mailing lists) for
470 non-free software packages.
471         <p>
472 Packages in the <em/contrib/ section have to comply with the DFSG, but
473 may fail other requirements.  For instance, they may depend on
474 non-free packages.
475         <p>
476 The <url id="http://www.debian.org/doc/debian-policy/" name="Debian
477 Policy Manual"> contains a more exact definition of the three
478 sections. The above discussion is just an introduction.
479         <p>
480 The separation of the three sections at the top-level of the archive
481 is important for all people who want to distribute Debian, either via
482 FTP servers on the Internet or on CD-ROMs: by distributing only the
483 <em/main/ and <em/contrib/ sections, one can avoid any legal risks.
484 Some packages in the <em/non-free/ section do not allow commercial
485 distribution, for example.
486         <p>
487 On the other hand, a CD-ROM vendor could easily check the individual
488 package licenses of the packages in <em/non-free/ and include as many
489 on the CD-ROMs as he's allowed. (Since this varies greatly from vendor
490 to vendor, this job can't be done by the Debian developers.)
491
492
493       <sect>Architectures
494         <p>
495 In the first days, the Linux kernel was only available for the Intel
496 i386 (or greater) platforms, and so was Debian. But when Linux became
497 more and more popular, the kernel was ported to other architectures,
498 too.
499         <p>
500 The Linux 2.0 kernel supports Intel x86, DEC Alpha, Sparc, M68000
501 machines (like Atari and Amiga), MIPS, and PowerPC.  Newer kernels
502 support more architectures, including ARM, UltraSparc, and MIPS.
503 Since Linux supports these platforms, Debian decided that it should,
504 too.  Therefore, Debian has ports underway.  Aside from <em>i386</em>
505 (our name for Intel x86), there is <em>m68k</em>, <em>alpha</em>,
506 <em>ppc</em>, <em>sparc</em>, <em>hurd-i386</em>, and <em>arm</em> as
507 of this writing.
508
509         <p>
510 Debian GNU/Linux 1.3 is only available as <em>i386</em>.  Debian 2.0
511 supports <em>i386</em> and <em>m68k</em> architectures.  The next
512 version of Debian is likely to also support all these, in addition to
513 <em>alpha</em>, <em>ppc</em>, and <em>sparc</em> architectures.
514
515
516       <sect>Subsections
517         <p>
518 The sections <em/main/, <em/contrib/, and <em/non-free/ are split into
519 <em/subsections/ to simplify the installation process and the
520 maintainance of the archive.  Subsections are not formally defined,
521 excepting perhaps for the `base' subsection.  Subsections exist simply
522 to simplify the organization and browsing of available packages.
523 Please check the current Debian distribution to see which sections are
524 available.
525
526
527
528       <sect>Packages
529         <p>
530 There are two types of Debian packages, namely <em/source/ and
531 <em/binary/ packages.
532         <p>
533 Source packages consist of either two or three files: a <tt/.dsc/
534 file, and either a <tt/.tar.gz/ file or both an <tt/.orig.tar.gz/ and
535 a <tt/.diff.gz/ file.
536         <p>
537 If a package is developed specially for Debian and is not distributed
538 outside of Debian, there is just one <tt/.tar.gz/ file which contains
539 the sources of the program.  If a package is distributed elsewhere
540 too, the <tt/.orig.tar.gz/ file stores the so-called <em/upstream
541 source code/, that is the source code that's distributed from the
542 <em/upstream maintainer/ (often the author of the software). In this
543 case, the <tt/.diff.gz/ contains the changes made by the Debian
544 maintainer.
545         <p>
546 The <tt/.dsc/ lists all the files in the source package together with
547 checksums (md5sums) and some additional info about the package
548 (maintainer, version, etc.).
549
550
551       <sect>Distribution directories
552         <p>
553 The directory system described in the previous chapter, are themselves
554 contained within <em/distribution directories/.  Every distribution is
555 contained in the <tt/dists/ directory in the top-level of the Debian
556 archive itself (the symlinks from the top-level directory to the
557 distributions themselves are for backwards compatability and are
558 deprecated).
559         <p>
560 To summarize, the Debian archive has a root directory within an FTP
561 server.  For instance, at the mirror site,
562 <ftpsite>ftp.us.debian.org</ftpsite>, the Debian archive itself is
563 contained in <ftppath>/debian</ftppath>, which is a common location
564 (another is <ftppath>/pub/debian</ftppath>).
565         <p>
566 Within that archive root, the actual distributions are contained in
567 the <tt/dists/ directory.  Here is an overview of the layout:
568         <p>
569 <example>
570 <var>archive root</var>/dists/<var>distribution</var>/<var>section</var>/<var>architecture</var>/<var>subsection</var>/<var>packages</var>
571 </example>
572
573 Extrapolating from this layout, you know that to find the i386 base
574 packages for the distribution <em/slink/, you would look in
575 <ftppath>/debian/dists/slink/main/binary-i386/base/</ftppath>.
576
577         <sect1>Stable, unstable, and sometimes frozen
578         <p>
579 There is always a distribution called <em/stable/ (residing in
580 <tt>dists/stable</tt>) and one called <em/unstable/ (residing in
581 <tt>dists/unstable</tt>). This reflects the development process of the
582 Debian project.
583         <p>
584 Active development is done in the <em/unstable/ distribution (that's
585 why this distribution is sometimes called the <em/development
586 distribution/). Every Debian developer can update his or her packages
587 in this distribution at any time. Thus, the contents of this
588 distribution change from day-to-day. Since no special effort is done
589 to test this distribution, it is sometimes ``unstable.''
590         <p>
591 After a period of development, the <em/unstable/ distribution is
592 copied in a new distribution directory, called <em/frozen/. When that
593 occurs, no changes are allowed to the frozen distribution except bug
594 fixes; that's why it's called ``frozen.''  After another month or a
595 little longer, the <em/frozen/ distribution is renamed to <em/stable/,
596 overriding the old <em/stable/ distribution, which is removed at that
597 time.
598         <p>
599 This development cycle is based on the assumption that the
600 <em/unstable/ distribution becomes <em/stable/ after passing a period
601 of testing as <em/frozen/.  Even once a distribution is considered
602 stable, a few bugs inevitably remain--that's why the stable
603 distribution is updated every now and then. However, these updates are
604 tested very carefully and have to be introduced into the archive
605 individually to reduce the risk of introducing new bugs.  You can find
606 proposed additions to <em/stable/ in the <tt/proposed-updates/
607 directory.  Those packages in <tt/proposed-updates/ that pass muster
608 are periodically moved as a batch into the stable distribution and the
609 revision level of the stable distribution is incremented (e.g., `1.3'
610 becomes `1.3r1', `2.0r2' becomes `2.0r3', and so forth).
611         <p>
612 Note that development under <em/unstable/ is continued during the
613 ``freeze'' period, since a new <em/unstable/ distribution is be
614 created when the older <em/unstable/ is moved to <em/frozen/.
615 Another wrinkle is that when the <em/frozen/ distribution is offically 
616 released, the old stable distribution is completely removed from the
617 Debian archives (although you can still find it from servers which
618 serve up older, obsolete distributions).
619         <p>
620 In summary, there is always a <em/stable/ and an <em/unstable/
621 distribution available, and the <em/frozen/ distribution shows up for
622 a month or so from time to time.
623
624
625         <sect1>Experimental
626           <p>
627 The <em/experimental/ distribution is a specialty distribution.  It is
628 not a full distribution in the same sense that `stable' and `unstable'
629 are.  Instead, it is meant to be a temporary staging area for highly
630 experimental software where there's a good chance that the software
631 could break your system.  Users who download and install packages from
632 <em/experimental/ are expected to have been duly warned.  In short,
633 all bets are off for the <em/experimental/ distribution.
634           <p>
635 Developers should be very selective in the use of the
636 <em/experimental/ distribution.  Even if a package is highly unstable,
637 it could well still go into <em/unstable/; just state a few warnings
638 in the description.  However, if there is a chance that the software
639 could do grave damage to a system, it might be better to put it into
640 <em/experimental/.
641           <p>
642 For instance, an experimental encrypted file system should probably go
643 into experimental.  A new, beta, version of some software which uses
644 completely different configuration might go into experimental at the
645 maintainer's discretion.  New software which isn't likely to damage
646 your system can go into <em/unstable/.
647
648
649       <sect id="codenames">Release code names
650         <p>
651 Every released Debian distribution has a <em/code name/: Debian 1.1 is
652 called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0,
653 `hamm'; Debian 2.1, `slink'; and Debian 2.2, `potato'.  There is
654 also a ``pseudo-distribution'', called `sid' which is contains
655 packages for architectures which are not yet officially supported or
656 released by Debian.  These architectures are planned to be integrated
657 into the mainstream distribution at some future date.
658         <p>
659 Since the Debian has an open development model (i.e., everyone can
660 participate and follow the development) even the unstable distribution
661 is distributed via the Internet on the Debian FTP and HTTP server
662 network. Thus, if we had called the directory which contains the
663 development version `unstable', then we would have to rename it
664 to `stable' when the version is released, which would cause all FTP
665 mirrors to re-retrieve the whole distribution (which is already very
666 large!).
667         <p>
668 On the other hand, if we called the distribution directories
669 <em>Debian-x.y</em> from the beginning, people would think that Debian
670 release <em>x.y</> is available. (This happened in the past, where a
671 CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0 development
672 version. That's the reason why the first official Debian release was
673 1.1, and not 1.0.)
674         <p>
675 Thus, the names of the distribution directories in the archive are
676 determined by their code names and not their release status (i.e.,
677 `slink').  These names stay the same during the development period
678 and after the release; symbolic links, which can be changed, are made
679 to indicate the currently released stable distribution.  That's why
680 the real distribution directories use the <em/code names/ and symbolic
681 links for <em/stable/, <em/unstable/, and <em/frozen/ point to the
682 appropriate release directories.
683
684
685     <chapt id="upload">Package uploads
686
687       <sect>Announcing new packages
688         <p>
689 If you want to create a new package for the Debian distribution, you
690 should first check the <url
691 id="http://www.debian.org/doc/prospective-packages.html"
692 name="Work-Needing and Prospective Packages (WNPP)"> list.  Checking
693 the WNPP ensures that no one is already working on packaging that
694 software, and that effort is not duplicated. Assuming no one else is
695 already working on your prospective package, you must then send a
696 short email to <email/debian-devel@lists.debian.org/ describing your
697 plan to create a new package.  You should set the subject of the email
698 to ``intent to package <var/foobar/'', substituting the name of the new
699 package for <var/foobar/.
700         <p>
701 There are a number of reasons why we ask maintainers to follow these
702 steps:
703           <list compact>
704             <item>
705 It helps the (potentially new) maintainer to tap into the experience
706 of people on the list, and lets them know if any one else is working
707 on it already.
708             <item>
709 It lets other people thinking about working on the package know that
710 there already is a volunteer, and efforts may be shared.  The ``intent
711 to package'' message to <email/debian-devel@lists.debian.org/ will be
712 picked up the the WNPP maintainer, and your intention will be
713 published in subsequent versions of the WNPP document.
714             <item>
715 It lets the rest of the maintainers know more about the package than
716 the one line description and the changelog entry ``Initial version''
717 that generally gets posted to <tt/debian-devel-changes/ by default.
718             <item>
719 It is helpful to the people who live off unstable (and form our first
720 line of testers); we should encourage these people.
721             <item>
722 The announcements give maintainers and other interested parties a
723 better feel of what is going on, and what is new, in the project.
724           </list>
725
726
727       <sect id="uploading">Uploading a package
728
729         <sect1>Generating the changes file
730           <p>
731 When a package is uploaded to the Debian FTP archive, it must be
732 accompanied by a <tt/.changes/ file, which gives directions to the
733 archive maintainers for its handling.  This is usually generated by
734 <prgn/dpkg-genchanges/ during the normal package build process.
735           <p>
736 The changes file is a control file with the following fields:
737           <p>
738 <list compact>
739               <item><tt/Format/
740               <item><tt/Date/
741               <item><tt/Source/
742               <item><tt/Binary/
743               <item><tt/Architecture/
744               <item><tt/Version/
745               <item><tt/Distribution/
746               <item><tt/Urgency/
747               <item><tt/Maintainer/
748               <item><tt/Description/
749               <item><tt/Changes/
750               <item><tt/Files/
751             </list>
752           <p>
753 All of these fields are mandatory for a Debian upload.  See the list
754 of control fields in the <url
755 id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
756 name="Debian Packaging Manual"> for the contents of these fields.
757 Only the <tt/Distribution/ field is discussed here, since it relates
758 to the archive maintenance policies.
759
760         <sect1 id="upload-dist">Picking a distribution
761           <p>
762 Notably, the <tt/Distribution/ field, which originates from the
763 <tt>debian/changelog</tt> file, indicates which distribution the
764 package is intended for.  There are four possible values for this
765 field: `stable', `unstable', `frozen', or `experimental'; these values
766 can also be combined.  For instance, if you have a crucial security
767 fix release of a package, and the package has not diverged between the
768 <em/stable/ and <em/unstable/ distributions, then you might put
769 `stable unstable' in the <tt>changelog</tt>'s <tt/Distribution/ field.
770 Or, if Debian has been frozen, and you want to get a bug-fix release
771 into <em/frozen/, you would set the distribution to `frozen unstable'.
772 (See <ref id="upload-frozen"> for more information on when to upload to
773 <em/frozen/.)  Note that setting the distribution to `stable' means
774 that the package will be placed into the <tt>proposed-updates</tt>
775 directory of the Debian archive for further testing before it is
776 actually included in <em/stable/.  Also note that it never makes sense
777 to combine the <em/experimental/ distribution with anything else.
778           <p>
779 The first time a version is uploaded which corresponds to a particular
780 upstream version the original source tar file should be uploaded and
781 included in the <tt/.changes/ file; subsequent times the very same tar
782 file should be used to build the new diffs and <tt/.dsc/ files, and it
783 need not then be uploaded.
784           <p>
785 By default <prgn/dpkg-genchanges/ and <prgn/dpkg-buildpackage/ will
786 include the original source tar file if and only if the Debian
787 revision part of the source version number is <tt/0/ or <tt/1/,
788 indicating a new upstream version.  This behaviour may be modified by
789 using <tt/-sa/ to always include it or <tt/-sd/ to always leave it
790 out.
791           <p>
792 If no original source is included in the upload then the original
793 source tar-file used by <prgn/dpkg-source/ when constructing the
794 <tt/.dsc/ file and diff to be uploaded <em/must/ be byte-for-byte
795 identical with the one already in the archive.  If there is some
796 reason why this is not the case then the new version of the original
797 source should be uploaded, possibly by using the <tt/-sa/ flag.
798
799           <sect2 id="upload-frozen">Uploading to <em/frozen/
800             <p>
801 The Debian freeze is a crucial time for Debian.  It is our chance to
802 synchronize and stabilize our distribution as a whole.  Therefore,
803 care must be taken when uploading to <em/frozen/.
804             <p>
805 It is tempting to always try to get the newest release of software
806 into the release.  However, it's much more important that the system
807 as a whole is stable and works as expected.
808             <p>
809 The watchword for uploading to <em/frozen/ is <strong>no new
810 code</strong>.  This is a difficult thing to quantify, so here are
811 some guidelines:
812             <p>
813 <list>
814                 <item>
815 Fixes for bugs of severity <em/critical/, <em/grave/, or
816 <em/important/ severity are always allowed for those packages that
817 must exist in the final release
818                 <item>
819 <em/critical/, <em/grave/, and <em/important/ bug fixes are only
820 allowed for non-necessary packages if they don't add any new features
821                 <item>
822 normal bug fixes are allowed (though discouraged) on all packages if
823 and only if there are no new features
824                 <item>
825 wishlist fixes are not allowed (they are, after all, not really bugs)
826                 <item>
827 documentation bug fixes are allowed, since good documentation is
828 important
829               </list>
830             <p>
831 Remember, there is statistically a 15% chance that every bug fix will
832 introduce a new bug.  The introduction and discovery of new bugs
833 either delays release or weakens the final product.  There is little
834 correlation between the severity of the original bug and the severity
835 of the introduced bug.
836
837
838
839         <sect1 id="upload-checking">Checking the package prior to upload
840           <p>
841 Before you upload your package, you should do basic testing on it.
842 Make sure you try the following activities (you'll need to have an
843 older version of the Debian package around).
844 <list>
845               <item>
846 Install the package and make sure the software works, or upgrade the
847 package from an older version to your new version if a Debian package
848 for it already exists.
849               <item>
850 Run <prgn/lintian/ over the package.  You can run <prgn/lintian/ as
851 follows: <tt>lintian -v <var>package-NN</var>.changes</tt>. This will
852 check the source package as well as the binary package.  If you don't
853 understand the output that <prgn/lintian/ generates, try adding the
854 <tt/-i/ switch, which will cause <prgn/lintian/ to output a very
855 verbose description of the problem.
856                 <p>
857 Normally, a package should <em/not/ be uploaded if it causes lintian
858 to emit errors (they will start with <tt/E/).
859                 <p>
860 For more information on <prgn/lintian/, see <ref id="lintian">.
861               <item>
862 Downgrade the package to the previous version (if one exists) -- this
863 tests the <tt/postrm/ and <tt/prerm/ scripts.
864               <item>
865 Remove the package, then reinstall it.
866             </list>
867
868
869         <sect1 id="upload-master">Uploading to <tt/master/
870           <p>
871 To upload a package, you need a personal account on
872 <ftpsite>master.debian.org</ftpsite>.  All maintainers should already
873 have this account, see <ref id="servers-master">.  You can use either
874 <prgn/ssh/ or <prgn/ftp/ to transfer the files.  In either case, the
875 files need to be placed into
876 <ftppath>/home/Debian/ftp/private/project/Incoming</ftppath>.  (You
877 cannot upload to Incoming on master using anonymous FTP -- you must
878 use your user-name and password.)
879           <p>
880 <em/Note:/ Do not upload packages containing software that is
881 export-controlled by the United States government to <tt/master/, or
882 to the overseas upload queues on <tt/chiark/ or <tt/erlangen/.  This
883 prohibition covers almost all cryptographic software, and even
884 sometimes software that contains ``hooks'' to cryptographic software,
885 such as electronic mail readers that support PGP encryption and
886 authentication.  Uploads of such software should go to <tt/non-us/
887 (see below).  If you are not sure whether U.S. export controls apply
888 to your package, post a message to
889 <email/debian-devel@lists.debian.org/ and ask.
890           <p>
891 You may also find the Debian package <package/dupload/ useful when
892 uploading packages.  This handy program is distributed with defaults
893 for uploading via <prgn/ftp/ to <tt/master/, <tt/chiark/, and
894 <tt/erlangen/.  It can also be configured to use <prgn/ssh/.  See
895 <manref name="dupload" section="1"> and <manref name="dupload"
896 section="5"> for more information.
897
898
899         <sect1>Uploads via <tt/chiark/
900           <p>
901 If you have a slow network connection to <tt/master/, there are
902 alternatives.  One is to upload files to <tt/Incoming/ via a
903 cron-driven upload queue in Europe on <tt/chiark/. For details connect
904 to <ftpsite>ftp.chiark.greenend.org.uk</ftpsite> using anonymous FTP
905 and read
906 <ftppath>/pub/debian/private/project/README.how-to-upload</ftppath>.
907           <p>
908 <em/Note:/ Do not upload packages containing software that is
909 export-controlled by the United States government to the queue on
910 <tt/chiark/.  Since this upload queue goes to <tt/master/, the
911 prescription found in <ref id="upload-master"> applies here as well.
912           <p>
913 The program <tt/dupload/ supports uploads to <tt/chiark/; please refer
914 to the documentation that comes with the program for details.
915
916
917         <sect1>Uploads via <tt/erlangen/
918           <p>
919 Another cron-driven upload queue is available in Germany: just upload
920 the files via anonymous FTP to <url
921 id="ftp://ftp.uni-erlangen.de/pub/Linux/debian/UploadQueue">.
922           <p>
923 The upload must be a complete Debian upload, as you would put it into
924 <tt/master/'s <tt/Incoming/, i.e., a <tt/.changes/ files along with the
925 other files mentioned in the <tt/.changes/. The queue daemon also
926 checks that the <tt/.changes/ is correctly PGP-signed by a Debian
927 developer, so that no bogus files can find their way to <tt/master/
928 via the queue. Please also make sure that the <tt/Maintainer/ field
929 in the <tt/.changes/ contains <em/your/ e-mail address. The address
930 found there is used for all replies, just as on <tt/master/.
931           <p>
932 There's no need to move your files into a second directory after the
933 upload as on <tt/chiark/. And, in any case, you should get some mail
934 reply from the queue daemon what happened to your upload. Hopefully it
935 should have been moved to <tt/master/, but in case of errors you're
936 notified, too.
937           <p>
938 <em/Note:/ Do not upload packages containing software that is
939 export-controlled by the United States government to the queue on
940 <tt/erlangen/.  Since this upload queue goes to <tt/master/, the
941 prescription found in <ref id="upload-master"> applies here as well.
942           <p>
943 The program <prgn/dupload/ supports uploads to <tt/erlangen/; please refer
944 to the documentation that comes with the program for details.
945
946
947         <sect1>Uploading to the non-us server
948           <p>
949 To upload a package to the <em/non-us/ server you just have to
950 transfer the files via anonymous ftp to <url
951 id="ftp://non-us.debian.org/pub/debian-non-US/Incoming">.  Note, that
952 the <tt>.changes</tt> file must have a valid PGP signature from one of
953 the keys of the developers key-ring.
954
955
956       <sect>Announcing package uploads
957         <p>
958 When a package is uploaded an announcement should be posted to one of
959 the ``debian-changes'' lists. The announcement should give the (source)
960 package name and version number, and a very short summary of the
961 changes, in the <em/Subject/ field, and should contain the PGP-signed
962 <tt/.changes/ file.  Some additional explanatory text may be added
963 before the start of the <tt/.changes/ file.
964         <p>
965 If a package is released with the <tt/Distribution:/ set to
966 `stable', the announcement is sent to
967 <email/debian-changes@lists.debian.org/.  If a package is released
968 with <tt/Distribution:/ set to `unstable', `experimental', or
969 `frozen' (when present), the announcement should be posted to
970 <email/debian-devel-changes@lists.debian.org/ instead.
971         <p>
972 On occasion, it is necessary to upload a package to both the
973 <em/stable/ and <em/unstable/ distributions; this is done by putting
974 both distributions in the <tt/Distribution:/ line.  In such a case the
975 upload announcement should go to both of the above mailing lists.
976         <p>
977 The <prgn/dupload/ program is clever enough to determine for itself
978 where the announcement should go, and will automatically mail the
979 announcement to the right list.  See <ref id="dupload">.
980
981       <sect id="upload-notification">Notification that a new package has been installed
982         <p>
983 The Debian archive maintainers are responsible for handling package
984 uploads.  For the most part, uploads are automatically handled on a
985 daily basis by an archive maintenance tool called <prgn/dinstall/.
986 Specifically, updates to existing packages to the `unstable'
987 distribution are handled automatically. In other cases, notably new
988 packages, placing the uploaded package into the distribution is
989 handled manually. When uploads are handled manually, the change to the
990 archive may take up to a week to occur (please be patient).
991         <p>
992 In any case, you will receive notification indicating that the package
993 has been uploaded via email.  Please examine this notification
994 carefully.  You may notice that the package didn't go into the section
995 you thought you set it to go into.  Read on for why.
996
997         <sect1 id="override-file">The override file
998           <p>
999 The <tt>debian/control</tt> file's <tt/Section/ and <tt/Priority/
1000 fields do not actually specify where the file will be placed in the
1001 archive, nor its priority.  In order to retain the overall integrity
1002 of the archive, it is the archive maintainers who have control over
1003 these fields.  The values in the <tt>debian/control</tt> file are
1004 actually just hints.
1005           <p>
1006 The archive maintainers keep track of the cannonical sections and
1007 priorities for packages in the <em/override file/.  Sometimes the
1008 <em/override file/ needs correcting.  Simply changing the pacakge's
1009 <tt>control</tt> file is not going to work.  Instead, you should email
1010 <email/override-change@debian.org/ or submit a bug against
1011 <package/ftp.debian.org/.
1012           <p>
1013 For more information about <em/override files/, see
1014 <manref name="dpkg-scanpackages" section="8">, 
1015 <tt>/usr/doc/debian/bug-log-mailserver.txt</tt>, and
1016 <tt>/usr/doc/debian/bug-maint-info.txt</tt>.
1017
1018
1019       <sect id="nmu">Interim releases
1020         <p>
1021 Under certain circumstances it is necessary for someone other than the
1022 usual package maintainer to make a release of a package.  For example,
1023 a porter for another architecture may have to make some small changes
1024 to the source package and does not wish to wait with uploading their
1025 release until the main maintainer has incorporated the patch, or a
1026 serious security problem or bug may have come to light requiring
1027 immediate attention.
1028         <p>
1029 When a security bug is detected a fixed package should be uploaded as
1030 soon as possible. In this case, the Debian Security Managers should
1031 get in contact with the package maintainer to make sure a fixed
1032 package is uploaded within a reasonable time (less than 48 hours). If
1033 the package maintainer cannot provide a fixed package fast enough or
1034 if he/she cannot be reached in time, the Security Manager may upload a
1035 fixed package.
1036         <p>
1037 When someone other than the usual maintainer releases a package they
1038 should add a new component to the <var/debian-revision/ component of
1039 the version number--that is, the portion after the (last) hyphen.
1040 This extra component will start at `1'.  This is to avoid
1041 `stealing' one of the usual maintainer's version numbers, possibly
1042 disrupting their work.  If there is no <var/debian-revision/ component
1043 in the version number then one should be created, starting at `1'.
1044         <p>
1045 If it is absolutely necessary for someone other than the usual
1046 maintainer to make a release based on a new upstream version then the
1047 person making the release should start with the <var/debian-revision/
1048 value `0.1'.  The usual maintainer of a package should start their
1049 <var/debian-revision/ numbering at `1'.  Note that if you do this,
1050 you'll have to invoke <prgn>dpkg-buildpackage</prgn> with the <tt/-sa/
1051 switch to force the build system to pick up the new source package
1052 (normally it only looks for Debian revisions of '0' or '1').
1053         <p>
1054 Maintainers other than the usual package maintainer should make as few
1055 changes to the package as possible, and they should always send a
1056 unified context diff (<tt/diff -u/) detailing their changes to the bug
1057 tracking system properly flagged with the correct package so that the
1058 usual maintainer is kept aware of the situation.
1059         <p>
1060 If the non-maintainer upload (as known as an ``NMU'') fixes some
1061 existing bugs, the bug reports should not be closed.  Technically,
1062 only the official package maintainer or the original bug submitter are
1063 allowed to close bugs. However, the person making the non-maintainer
1064 release should send a short message to the bug tracking system to all
1065 the fixed bugs explaining that they have been fixed.  Using
1066 <email/control@bugs.debian.org/, the party doing the NMU should also
1067 set the severity of the bugs fixed in the NMU to `fixed'.  This
1068 ensures that everyone knows that the bug was fixed in an NMU; however
1069 the bug is left open until the changes in the NMU are incorporated
1070 "officially" into the package by the official package maintainer.
1071         <p>
1072 The normal maintainer should do at least one of the following:
1073           <list compact>
1074             <item>
1075 apply the diff,
1076             <item>
1077 read the diff and decide on each part of it themselves, or
1078             <item>
1079 if the maintainer decides not to apply the patch but to release a new
1080 version, read the description of the changes to the next upstream
1081 version and ensure that they fix each problem that was fixed in the
1082 non-maintainer release.
1083           </list>
1084         <p>
1085 In addition, the normal maintainer should <em/always/ include an entry
1086 in the changelog file documenting the non-maintainer upload.
1087
1088
1089       <sect>Maintainer changes
1090         <p>
1091 Periodically, a listing of packages in need of new maintainers will be
1092 sent to <email/debian-devel@lists.debian.org</email> list. This list
1093 is also available at in the Work-Needing and Prospective Packages
1094 document (WNPP), <url
1095 id="ftp://ftp.debian.org/debian/doc/package-developer/prospective-packages.html">
1096 and at <url id="http://www.debian.org/doc/prospective-packages.html">.
1097 If you wish to take over maintenance of any of the packages listed in
1098 the WNPP, or if you can no longer maintain a packages you have, or you
1099 simply want to know if any one is working on a new package, send a
1100 message to <email/wnpp@debian.org/.
1101
1102         <p>
1103 If you take over an old package, you probably want to be listed as the
1104 package's official maintainer in the bug system. This will happen
1105 automatically once you upload a new version with an updated
1106 <tt/Maintainer:/ field. If you do not expect to upload a new version
1107 for a while, send an email to <email/override-change@debian.org/ so
1108 that bug reports will go to you.
1109
1110
1111
1112     <chapt id="archive-manip">Moving, Removing, Renaming, and Orphaning Packages
1113       <p>
1114 Some archive manipulation operation are not automated in the Debian
1115 upload process.  This chapter gives guidelines in what to do in these
1116 cases.
1117
1118       <sect>Moving packages
1119         <p>
1120 Sometimes a package will change either its section or its subsection.
1121 For instance, a package from the `non-free' section might be GPL'd in
1122 a later version; in this case you should consider moving it to `main'
1123 or `contrib' (see the <url
1124 id="http://www.debian.org/doc/debian-policy/" name="Debian Policy
1125 Manual"> for guidelines).
1126         <p>
1127 In this case, it is sufficient to edit the package control information
1128 normally and re-upload the package (see the <url
1129 id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
1130 name="Debian Packaging Manual"> for
1131 details).  Carefully examine the installation log sent to you when the
1132 package is installed into the archive.  If for some reason the old
1133 location of the package remains, file a bug against
1134 <tt/ftp.debian.org/ asking that the old location be removed.  Give
1135 details on what you did, since it might be a <prgn/dinstall/ bug.
1136
1137
1138       <sect>Removing packages
1139         <p>
1140 If for some reason you want to completely remove a package (say, if it
1141 is an old compatibility library which is not longer required), you
1142 need to file a bug against <tt/ftp.debian.org/ asking that the
1143 package be removed.  Make sure you indicate which distribution the
1144 package should be removed from.
1145         <p>
1146 If in doubt concerning whether a package is disposable, email
1147 <email/debian-devel@lists.debian.org/ asking for opinions.
1148
1149
1150       <sect>Replacing or renaming packages
1151         <p>
1152 Sometimes you made a mistake naming the package and you need to rename
1153 it.  In this case, you need to follow a two-step process.  First, set
1154 your <tt>debian/control</tt> file to replace and conflict with the
1155 obsolete name of the package (see the <url
1156 id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
1157 name="Debian Packaging Manual"> for details).  Once you've uploaded
1158 that package, and the package has moved into the archive, file a bug
1159 against <tt/ftp.debian.org/ asking to remove the package with the
1160 obsolete name.
1161
1162
1163       <sect>Orphaning a package
1164         <p>
1165 If you can no longer maintain a package, then you should set the
1166 package maintainer to <tt>Debian QA
1167 &lt;debian-qa@lists.debian.org&gt;</tt> and email
1168 <email/wnpp@debian.org/ indicating that the package is now orphaned.
1169 If the package is especially crucial to Debian, you should instead
1170 email <email/debian-devel@lists.debian.org/ asking for a new
1171 maintainer.
1172
1173
1174     <chapt id="bug-handling">Handling Bug Reports
1175
1176       <sect>Monitoring bugs
1177         <p>
1178 If you want to be a good maintainer, you should periodically check the
1179 <url id="http://www.debian.org/Bugs/" name="Debian bug tracking system
1180 (BTS)"> for your packages.  The BTS contains all the open bugs against 
1181 your packages.
1182         <p>
1183 Maintainers interact with the BTS via email addresses at
1184 <tt/bugs.debian.org/.  Documentation on available commands can be
1185 found at <url id="http://www.debian.org/Bugs/">, or, if you have
1186 installed the <package/debian-doc/ package, you can look at the local
1187 files <tt>/usr/doc/debian/bug-*</tt>.
1188         <p>
1189 Often as a package maintainer, you find bugs in other packages or else
1190 have bugs reported to your packages which need to be reassigned.  The
1191 BTS instructions can tell you how to do this.  Make sure the bug is
1192 not already filed against a package.  Try to do a good job reporting a
1193 bug and redirecting it to the proper location.  For extra credit, you
1194 can go through other packages, merging bugs which are reported more
1195 than once, or setting bug severities to `fixed'when they have already
1196 been fixed.  Note that when you are neither the bug submitter nor the
1197 package maintainer, you are not empowered to actually close the bug
1198 (unless you secure permission from the maintainer).
1199
1200
1201       <sect>When bugs are closed by new uploads
1202         <p>
1203 If you fix a bug in your packages, it is your responsibility as the
1204 package maintainer to close the bug when it has been fixed.  However,
1205 you should not close the bug until the package which fixes the bug has
1206 been accepted into the Debian archive.  Therefore, once you get
1207 notification that your updated package has been installed into the
1208 archive, you can and should close the bug in the BTS.
1209         <p>
1210 Again, see the BTS documentation for details on how to do this.
1211 Often, it is sufficient to mail the <tt/.changes file to
1212 <email/<var/XXX/-done@bugs.debian.org/, where <var/XXX/ is your bug
1213 number.
1214
1215       <sect id="lintian-reports">Lintian reports
1216         <p>
1217 You should periodically get the new <package/lintian/ from `unstable' and
1218 check over all your packages.  Alternatively you can check for your
1219 maintainer email address at the <url
1220 id="http://www.debian.org/lintian/" name="online lintian report">.
1221 That report, which is updated automatically, contains <prgn/lintian/
1222 reports against the latest version of the distribution (usually from
1223 'unstable') using the latest <package/lintian/.
1224
1225
1226       <sect>Reporting lots of bugs at once
1227         <p>
1228 If you report more then 10 bugs on the same topic at once, it is
1229 recommended that you send a message to
1230 <email/debian-devel@lists.debian.org/ describing your intention before
1231 submitting the report. This will allow other developers to verify
1232 that the bug is a real problem. In addition, it will help prevent
1233 a situation in which several maintainers start filing the same bug
1234 report simultaneously.
1235         <p>
1236 Note that when sending lots of bugs on the same subject, you should
1237 send the bug report to <email/maintonly@bugs.debian.org/ so that the
1238 bug report is not forwarded to the bug distribution mailing list.
1239
1240
1241     <chapt id="tools">Overview of Debian Maintainer Tools
1242       <p>
1243 This section contains a rough overview of the tools available to
1244 maintainers.  These tools are meant to help convenience developers and 
1245 free their time for critical tasks.  
1246       <p>
1247 Some people prefer to use high-level package maintenance tools and
1248 some do not.  Debian is officially agnostic on this issue; any tool
1249 which gets the job done is fine.  Therefore, this section is not meant
1250 to stipulate to anyone which tools they should use or how they should
1251 go about with their duties of maintainership.  Nor is it meant to
1252 endorse any particular tool to the exclusion of a competing tool.
1253       <p>
1254 Most of the descriptions of these packages come from the actual
1255 package descriptions themselves.
1256
1257       <sect id="dpkg-dev">
1258         <heading><package/dpkg-dev/
1259         <p>
1260 <package/dpkg-dev/ contains the tools (including
1261 <prgn/dpkg-source/) required to unpack, build and upload Debian source
1262 packages.  These utilities contain the fundamental, low-level
1263 functionality required to create and manipulated packages; as such,
1264 they are required for any Debian maintainer.
1265
1266       <sect id="lintian">
1267         <heading><package/lintian/
1268         <p>
1269 <package/Lintian/ dissects Debian packages and reports bugs and
1270 policy violations. It contains automated checks for many aspects of
1271 Debian policy as well as some checks for common errors.  The use of
1272 <package/lintian/ has already been discussed in <ref
1273 id="upload-checking"> and <ref id="lintian-reports">.
1274
1275       <sect id="debhelper">
1276         <heading><package/debhelper/
1277         <p>
1278 <package/debhelper/ is a collection of programs that can be used in
1279 <tt>debian/rules</tt> to automate common tasks related to building
1280 binary Debian packages. Programs are included to install various files
1281 into your package, compress files, fix file permissions, integrate
1282 your package with the Debian menu system.
1283         <p>
1284 Unlike <package/debmake/, <package/debhelper/ is broken into
1285 several small, granular commands which act in a consistent manner.  As
1286 such, it allows a greater granularity of control than
1287 <package/debmake/.
1288
1289       <sect id="debmake">
1290         <heading><package/debmake/
1291         <p>
1292 <package/debmake/, a pre-cursor to <package/debhelper/, is a
1293 less granular <tt>debian/rules</tt> assistant. It includes two main
1294 programs: <prgn>deb-make</prgn>, which can be used to help a
1295 maintainer convert a regular (non-Debian) source archive into a Debian
1296 source package; and <prgn>debstd</prgn>, which incorporates in one big
1297 shot the same sort of automated functions that one finds in
1298 <package/debhelper/.
1299
1300       <sect id="cvs-buildpackage">
1301         <heading><package/cvs-buildpackage/
1302         <p>
1303 <package/cvs-buildpackage/ provides the capability to inject or
1304 import Debian source packages into a CVS repository, build a Debian
1305 package from the CVS repository, and helps in integrating upstream
1306 changes into the repository.
1307         <p>
1308 These utilities provide an infrastructure to facilitate the use of CVS
1309 by Debian maintainers. This allows one to keep separate CVS branches
1310 of a package for <em/stable/, <em/unstable/, and possibly
1311 <em/experimental/ distributions, along with the other benefits of a
1312 version control system.
1313
1314       <sect id="dupload">
1315         <heading><package/dupload/
1316         <p>
1317 <package/dupload/ is a package and a script to automagically upload
1318 Debian packages to the Debian archive, to log the upload, and to send
1319 mail about the upload of a package.  You can configure it for new
1320 upload locations or methods.
1321
1322   </book>
1323 </debiandoc>
1324
1325 <!-- Keep this comment at the end of the file
1326 Local variables:
1327 mode: sgml
1328 sgml-omittag:t
1329 sgml-shorttag:t
1330 sgml-minimize-attributes:nil
1331 sgml-always-quote-attributes:t
1332 sgml-indent-step:2
1333 sgml-indent-data:nil
1334 sgml-parent-document:nil
1335 sgml-exposed-tags:nil
1336 sgml-local-catalogs:nil
1337 sgml-local-ecat-files:nil
1338 End:
1339 -->