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