chiark / gitweb /
add stuff for dinstall bug closing; note alternate names for DSA
[developers-reference.git] / developers-reference.sgml
1 <!DOCTYPE debiandoc PUBLIC "-//DebianDoc//DTD DebianDoc//EN" [
2   <!-- include version information so we don't have to hard code it
3        within the document -->
4   <!entity % versiondata SYSTEM "version.ent"> %versiondata;
5   <!-- common, language independant entities -->
6   <!entity % commondata  SYSTEM "common.ent" > %commondata;
7   <!-- CVS revision of this document -->
8   <!entity cvs-rev "$Revision: 1.37 $">
9
10   <!-- if you are translating this document, please notate the RCS
11        revision of the developers reference here -->
12   <!--
13     <!entity cvs-en-rev "X.YY">
14     -->
15 ]>
16 <debiandoc>
17 <!--
18  TODO:
19   - bugs in upstream versions should be reported upstream!
20   - add information on how to get accounts on different architectures
21   - talk about CVS access, other ways to submit problems
22   - add information on how you can contribute w/o being an official
23     developer
24   - "official port maintainer" ? (cf. glibc-pre2.1)
25  -->
26
27   <book>
28
29       <title>Debian Developer's Reference
30       <author>Adam Di Carlo, current maintainer <email>aph@debian.org</email>
31       <author>Christian Schwarz <email>schwarz@debian.org</email>
32       <author>Ian Jackson <email>ijackson@gnu.ai.mit.edu</email>
33       <version>ver. &version;, &date;
34
35       <copyright>
36         <copyrightsummary>
37 copyright &copy;1998, 1999 Adam Di Carlo</copyrightsummary>
38         <copyrightsummary>
39 copyright &copy;1997, 1998 Christian Schwarz</copyrightsummary>
40         <p>
41 This manual is free software; you may redistribute it and/or modify it
42 under the terms of the GNU General Public License as published by the
43 Free Software Foundation; either version 2, or (at your option) any
44 later version.
45         <p>
46 This is distributed in the hope that it will be useful, but
47 <em>without any warranty</em>; without even the implied warranty of
48 merchantability or fitness for a particular purpose.  See the GNU
49 General Public License for more details.
50         <p>
51 A copy of the GNU General Public License is available as &file-GPL; in
52 the Debian GNU/Linux distribution or on the World Wide Web at <url
53 id="&url-gpl;" name="the GNU website">.  You can also obtain it by
54 writing to the &fsf-addr;.
55
56     <toc detail="sect2">
57
58     <chapt id="scope">Scope of This Document
59       <p>
60 The purpose of this document is to provide an overview of the
61 recommended procedures and the available resources for Debian
62 developers.
63       <p>
64 The procedures discussed within include how to become a maintainer
65 (<ref id="new-maintainer">); how to upload new packages (<ref
66 id="upload">); how and when to do ports and interim releases of other
67 maintainers' packages (<ref id="nmu">); how to move, remove, or orphan
68 packages (<ref id="archive-manip">); and how to handle bug reports
69 (<ref id="bug-handling">).
70       <p>
71 The resources discussed in this reference include the mailing lists
72 and servers (<ref id="servers">); a discussion of the structure of the
73 Debian archive (<ref id="archive">); explanation of the different
74 servers which accept package uploads (<ref id="upload-master">); and a
75 discussion of resources which can help maintainers with the quality of
76 their packages (<ref id="tools">).
77       <p>
78 It should be clear that this reference does not discuss the technical
79 details of the Debian package nor how to generate Debian packages;
80 that information is discussed in the <url id="&url-pkg-manual;"
81 name="Debian Packaging Manual">.  Nor does this reference detail the
82 standards to which Debian software must comply; that information can
83 be found in the <url id="&url-debian-policy;" name="Debian Policy
84 Manual">.
85       <p>
86 Furthermore, this document is <em>not an expression of formal
87 policy</em>.  It contains documentation for the Debian system, and
88 generally agreed-upon best practices.
89
90
91     <chapt id="new-maintainer">Applying to Become a Maintainer
92         
93       <sect>Getting started
94         <p>
95 So, you've read all the documentation, you understand what everything
96 in the <package>hello</package> example package is for, and you're about to
97 Debianize your favourite piece of software.  How do you actually
98 become a Debian developer so that your work can be incorporated into
99 the Project?
100         <p>
101 Firstly, subscribe to &email-debian-devel; if you haven't already.
102 Send the word <tt>subscribe</tt> in the <em>Subject</em> of an email
103 to &email-debian-devel-req;.  In case of problems, contact the list
104 administrator at &email-listmaster;.  More information on available
105 mailing lists can be found in <ref id="mailing-lists">.
106         <p>
107 You should subscribe and lurk (that is, read without posting) for a
108 bit before doing any coding, and you should post about your intentions
109 to work on something to avoid duplicated effort.
110         <p>
111 Another good list to subscribe to is &email-debian-mentors;.  See <ref
112 id="mentors"> for details.  The IRC channel <tt>#debian</tt> on the
113 Linux People IRC network (e.g., <tt>irc.debian.org</tt>) can also be
114 helpful.
115
116
117       <sect id="registering">Registering as a Debian developer
118         <p>
119 Before you decide to register with the Debian Project, you will need
120 to read the <url id="&url-social-contract;" name="Debian Social
121 Contract">.  Registering as a developer means that you agree with and
122 pledge to uphold the Debian Social Contract; it is very important that
123 maintainers are in accord with the essential ideas behind Debian
124 GNU/Linux.  Reading the <url id="&url-gnu-manifesto;" name="GNU
125 Manifesto"> would also be a good idea.
126         <p>
127 The process of registering as a developer is a process of verifying
128 your identity and intentions.  As the number of people working on
129 Debian GNU/Linux has grown to over &number-of-maintainers; people and
130 our systems are used in several very important places we have to be
131 careful about being compromised.  Therefore, we need to verify new
132 maintainers before we can give them accounts on our servers and
133 letting them upload packages.
134         <p>
135 Registration requires that the following information be sent to
136 &email-new-maintainer; as part of the registration application:
137 <list>
138             <item>
139 Your name.
140             <item>
141 Your preferred login name on <tt>master</tt> (eight characters or
142 less), as well as the email address at which you'd prefer to be
143 subscribed to &email-debian-private; (typically this will be either
144 your primary mail address or your new <tt>debian.org</tt> address).
145             <item>
146 A phone number where we can call you.  Remember that the new
147 maintainer team usually calls during evening hours to save on long
148 distance tolls.  Please do not give a work number, unless you are
149 generally there in the evening.
150             <item>
151 A statement of intention, that is, what package(s) you intend to work
152 on, which Debian port you will be assisting, or how you intend to
153 contribute to Debian.
154             <item>
155 A statement that you have read and agree to uphold the <url
156 id="&url-social-contract;" name="Debian Social Contract">.
157             <item>
158 Some mechanism by which we can verify your real-life identity. For
159 example, any of the following mechanisms would suffice:
160 <list>
161                   <item>
162 An OpenPGP key signed by any well-known signature, such as:
163 <list>
164                         <item>
165 Any current Debian developer you have met <em>in real life</em>.
166                         <item>
167 Any formal certification service (such as Verisign, etc.) that
168 verifies your identity.  A certification that verifies your email
169 address, and not you identity, is not sufficient.
170                       </list>
171                   <item>
172 Alternatively, you may identify yourself with a scanned (or physically
173 mailed) copy of any formal documents certifying your identity (such as
174 a birth certificate, national ID card, U.S. Driver's License, etc.).
175 If emailed, please sign the mail with your OpenPGP key.
176                 </list>
177           </list>
178         <p>
179 If you do not have an OpenPGP key yet, generate one. Every developer
180 needs a OpenPGP key in order to sign and verify package uploads. You
181 should read the manual for the software you are using, since it has
182 much important information which is critical to its security.  Many
183 more security failures are due to human error than to software failure
184 or high-powered spy techniques.  See <ref id="key-maint"> for more
185 information on maintianing your public key.
186         <p>
187 Debian uses the <prgn>GNU Privacy Guard</prgn> (package
188 <package>gnupg</package> version 1 or better as its baseline standard.
189 You can use some other implementation of OpenPGP as well.  Note that
190 OpenPGP is a open standard based on <url id="&url-rfc2440;" name="RFC
191 2440">.
192         <p>
193 The recommended public key algorithm for use in Debian development
194 work is the DSA (sometimes call ``DSS'' or ``DH/ElGamal'').  Other key
195 types may be used however.  Your key length must be at least 1024
196 bits; there is no reason to use a smaller key, and doing so would be
197 much less secure.  Your key must be signed with at least your own user
198 ID; this prevents user ID tampering.  <prgn>gpg</prgn> does this
199 automatically.
200         <p>
201 Also remember that one of the names on your key must match the email
202 address you list as the official maintainer for your packages.  For
203 instance, I set the maintainer of the
204 <package>developers-reference</package> package to ``Adam Di Carlo
205 &lt;aph@debian.org&gt;''; therefore, one of the user IDs on my key is
206 that same value, ``Adam Di Carlo &lt;aph@debian.org&gt;''.
207         <p>
208 If your public key isn't on public key servers such as &pgp-keyserv;,
209 please read the documentation available locally in &file-keyservs;.
210 That document contains instructions on how to put your key on the
211 public key servers.  The New Maintainer Group will put your public key
212 on the servers if it isn't already there.
213         <p>
214 Due to export restrictions by the United States government some Debian
215 packages, including <package>gnupg</package>, are located on ftp sites
216 outside of the United States. You can find the current locations of
217 those packages at <url id="&url-readme-non-us;">.
218         <p>
219 Some countries restrict the use of cryptographic software by their
220 citizens.  This need not impede one's activities as a Debian package
221 maintainer however, as it may be perfectly legal to use cryptographic
222 products for authentication, rather than encryption purposes (as is
223 the case in France).  The Debian Project does not require the use of
224 cryptography <em>qua</em> cryptography in any manner.  If you live in a
225 country where use of cryptography even for authentication is forbidden
226 then please contact us so we can make special arrangements.
227         <p>
228 Once you have all your information ready, and your public key is
229 available on public key servers, send a message to
230 &email-new-maintainer; to register as an offical Debian developer so
231 that you will be able to upload your packages.  This message must
232 contain all the information discussed above.  The message must also
233 contain your public key (extracted using <tt>gpg --armor --export
234 <var>user_id</var></tt> in the case of <prgn>gpg</prgn>) for the
235 database of keys which is distributed from <url
236 id="url-debian-keyring;"> and the <package>debian-keyring</package>
237 package.  Please be sure to sign your request message with your chosen
238 public key.
239         <p>
240 Once this information is received and processed, you should be
241 contacted with information about your new Debian maintainer account.
242 If you don't hear anything within a month, please send a followup
243 message asking if your original application was received.  Do
244 <em>not</em> re-send your original application, that will just confuse
245 the New Maintainer Group. Please be patient, especially near release
246 points; mistakes do occasionally happen, and people do sometimes run
247 out of volunteer time.
248
249
250       <sect id="mentors">Debian Mentors
251         <p>
252 The mailing list &email-debian-mentors; has been set up for novice
253 maintainers who seek help with initial packaging and other
254 developer-related issues.  Every new developer is invited to subscribe
255 to that list (see <ref id="mailing-lists"> for details).
256         <p>
257 Those who prefer one-on-one help (e.g., via private email) should also
258 post to that list and an experienced developer will volunteer to help.
259
260
261     <chapt id="user-maint">Maintaining Your Debian Information
262
263       <sect id="key-maint">Maintaining Your Public Key
264         <p>
265 Be very careful with your private keys.  Do not place them on any
266 public servers or multiuser machines, such as
267 <tt>master.debian.org</tt>.  Back your keys up; keep a copy offline.
268 Read the documentation that comes with your software; read the <url
269 id="&url-pgp-faq;" name="PGP FAQ">.
270         <p>
271 If you add or remove signatures from your public key, or add or remove
272 user identities, you need to update the key servers and mail your
273 public key to &email-debian-keyring;.  The same key extraction
274 routines discussed in <ref id="registering"> apply.
275         <p>
276 You can find a more in-depth discussion of Debian key maintenance in
277 the documentation for the <package>debian-keyring</package> package.
278
279
280       <sect>Retiring Gracefully
281         <p>
282 If you choose to leave the Debian project, you should make sure you do
283 the following steps:
284 <enumlist>
285             <item>
286 Orphan all your packages, as described in <ref id="orphaning">.
287             <item>
288 Send an email about how you are leaving the project to
289 &email-debian-private;.
290             <item>
291 Notify the Debian key ring maintainers that you are leaving by
292 emailing to &email-debian-keyring;.
293           </enumlist>
294
295
296     <chapt id="servers">Mailing Lists, Servers, and Other Machines
297       <p>
298 In this chapter you will find a very brief road map of the Debian
299 mailing lists, the main Debian servers, and other Debian machines
300 which may be available to you as a developer.
301
302       <sect id="mailing-lists">Mailing lists
303         <p>
304 The mailing list server is at <tt>&lists-host;</tt>.  Mail
305 <tt>debian-<var>foo</var>-REQUEST@&lists-host;</tt>, where
306 <tt>debian-<var>foo</var></tt> is the name of the list, with the word
307 <tt>subscribe</tt> in the <em>Subject</em> to subscribe to the list or
308 <tt>unsubscribe</tt> to unsubscribe.  More detailed instructions on
309 how to subscribe and unsubscribe to the mailing lists can be found at
310 <url id="&url-debian-lists-subscribe;">, <url id="&url-debian-lists;">
311 or locally in &file-mail-lists; if you have the
312 <package>doc-debian</package> package installed.
313         <p>
314 When replying to messages on the mailing list, please do not send a
315 carbon copy (<tt>CC</tt>) to the original poster unless they explicitly
316 request to be copied.  Anyone who posts to a mailing list should read
317 it to see the responses.
318         <p>
319 The following are the core Debian mailing lists: &email-debian-devel;,
320 &email-debian-policy;, &email-debian-user;, &email-debian-private;,
321 &email-debian-announce;, and &email-debian-devel-announce;.  All
322 developers are expected to be subscribed to at least
323 &email-debian-private and &email-debian-devel-announce;.  There are
324 other mailing lists are available for a variety of special topics; see
325 <url id="&url-debian-lists-subscribe;"> for a list.  Cross-posting
326 (sending the same message to multiple lists) is discouraged.
327         <p>
328 &email-debian-private; is a special mailing lists for private
329 discussions amongst Debian developers.  It is meant to be used for
330 posts which for whatever reason should not be published publically.
331 As such, it is a low volume list, and users are urged not to use
332 &email-debian-private; unless it is really necessary.  Moreover, do
333 <em>not</em> forward email from that list to anyone.
334         <p>
335 As ever on the net, please trim down the quoting of articles you're
336 replying to.  In general, please adhere to the usual conventions for
337 posting messages.
338         <p>
339 Online archives of mailing lists are available at <url
340 id="&url-debian-list-archives;">.
341
342
343       <sect id="server-machines">Debian servers
344         <p>
345 Debian servers are well known servers which serve critical functions
346 in the Debian project.  Every developer should know what these servers
347 are and what they do.
348         <p>
349 If you have a problem with the operation of Debian server, and you
350 think that the system operators need to be notified of this problem,
351 please find the contact address for the particular role at <url
352 id="&url-debian-contacts;">.  If you have a non-operating problems
353 (such as packages to be remove, suggestions for the web site, etc.),
354 generally you'll report a bug against a ``pseudo-package''.  See <ref
355 id="submit-bug"> for information on how to submit bugs.
356
357       <sect1 id="servers-master">The master server
358         <p>
359 The master server, <tt>master.debian.org</tt>, holds the canonical copy
360 of the Debian archive (excluding the non-U.S. packages). Generally,
361 package uploads go to this server; see <ref id="upload">. 
362         <p>
363 <tt>master.debian.org</tt> is the canonical location for the Bug
364 Tracking System (BTS).  If you plan on doing some statistical analysis
365 or processing of Debian bugs, this would be the place to do it.
366 Please describe your plans on &email-debian-devel; before implementing
367 anything, however, to reduce unnecessary duplication of effort or
368 wasted processing time.
369         <p>
370 All Debian developers have accounts on <tt>master.debian.org</tt>.
371 Please take care to protect your password to this machine.  Try to
372 avoid login or upload methods which send passwords over the Internet
373 in the clear.
374         <p>
375 If you find a problem with <tt>master.debian.org</tt> such as disk
376 full, suspicious activity, or whatever, send an email to
377 &email-debian-admin;.  Problems with the Debian FTP archive generally
378 need to be reported as bugs against the
379 <package>ftp.debian.org</package> pseudo-package or an email to
380 &email-ftpmaster;, but also see the procedures in <ref
381 id="archive-manip">.
382
383       <sect1 id="servers-www">The WWW servers
384         <p>
385 The main web server, <tt>www.debian.org</tt>, is also known as
386 <tt>va.debian.org</tt>.  All developers are given accounts on this
387 machine.
388         <p>
389 If you have some Debian-specific information which you want to serve
390 up on the web, you can do do this by putting material in the
391 <file>public_html</file> directory under your home directory.  You can
392 do this on either <tt>va.debian.org</tt> or
393 <tt>master.debian.org</tt>.  Any material you put in those areas are
394 accessible via the URLs
395 <tt>http://www.debian.org/~<var>user-id</var>/</tt> and
396 <tt>http://master.debian.org/~<var>user-id</var>/</tt>, respectively.
397 Generally, you'll want to use <tt>va</tt>, for the
398 <tt>www.debian.org</tt> address, although in some cases you may need
399 to put it on <tt>master</tt>.  Please do not put any material on
400 Debian servers not relating to Debian, unless you have prior
401 permission. Send mail to &email-debian-devel; if you have any
402 questions.
403         <p>
404 If you find a problem with the Debian web server, you should generally
405 submit a bug against the pseudo-package,
406 <package>www.debian.org</package>.  First check whether or not someone
407 else has already reported the problem on the <url
408 id="&url-bts;db/pa/lwww.debian.org.html" name="Bug Tracking System">.
409
410
411       <sect1 id="servers-cvs">The CVS server
412         <p>
413 <tt>cvs.debian.org</tt> is also known as <tt>va.debian.org</tt>,
414 discussed above.  If you need the use of a publically accessible CVS
415 server, for instance, to help coordinate work on a package between
416 many different developers, you can request a CVS area on the server.
417           <p>
418 Generally, <tt>cvs.debian.org</tt> offers a combination of local CVS
419 access, anonymous client-server read-only access, and full
420 client-server access through <prgn>ssh</prgn>.  Also, the CVS area can
421 be accessed read-only via the Web at <url id="&url-cvsweb;">.
422         <p>
423 To request a CVS area, send a request via email to
424 &email-debian-admin;.  Include the name of the requested CVS area,
425 what <tt>va.debian.org</tt> user account should own the CVS root area,
426 and why you need it.
427
428
429       <sect1 id="servers-mirrors">Mirrors of Debian servers
430         <p>
431 The web and FTP servers have several mirrors available.  Please do not
432 put heavy load on the canonical FTP or web servers.  Ideally, the
433 canonical servers only mirror out to a first tier of mirrors, and all
434 user access is to the mirrors.  This allows Debian to better spread
435 its bandwidth requirements over several servers and networks.  Note
436 that newer push mirroring techniques ensure that mirrors are as
437 up-to-date as they can be.
438         <p>
439 The main web page listing the available public FTP (and, usually,
440 HTTP) servers can be found at <url id="&url-debian-mirrors;">.  More
441 information concerning Debian mirrors can be found at <url
442 id="&url-debian-mirroring;">.  This useful page includes information
443 and tools which can be helpful if you are interested in setting up
444 your own mirror, either for internal or public access.
445         <p>
446 Note that mirrors are generally run by third-parties who are
447 interested in helping Debian.  As such, developers generally do not
448 have accounts on these machines.
449         <p>
450 Please do not mirror off of <tt>master.debian.org</tt>.  This host
451 already has too much load.  Check the sites above for information, or
452 email <email>debian-devel@lists.debian.org</email>.
453
454
455       <sect id="other-machines">Other Debian Machines
456         <p>
457 There are other Debian machines which may be made available to you.
458 You can use these for Debian-related purposes as you see fit.  Please
459 be kind to system administrators, and do not use up tons and tons of
460 disk space, network bandwidth, or CPU without first getting the
461 approval of the local maintainers.  Usually these machines are run by
462 volunteers.  Generally, these machines are for porting activities.
463         <p>
464 Aside from the servers mentioned in <ref id="server-machines">, there
465 is a list of machines available to Debian developers at <url
466 id="&url-devel-machines;">.
467
468
469
470     <chapt id="archive">The Debian Archive
471
472       <sect>Overview
473         <p>
474 The Debian GNU/Linux distribution consists of a lot of Debian packages
475 (<tt>.deb</tt>'s, currently around &number-of-pkgs;) and a few
476 additional files (documentation, installation disk images, etc.).
477         <p>
478 Here is an example directory tree of a complete Debian distribution:
479         <p>
480 &sample-dist-dirtree;
481         <p>
482 As you can see, the top-level directory of the distribution contains
483 three directories, namely <em>main</em>, <em>contrib</em>, and
484 <em>non-free</em>. These directories are called <em>sections</em>.
485         <p>
486 In each section, there is a directory with the source packages
487 (source), a directory for each supported architecture
488 (<tt>binary-i386</tt>, <tt>binary-m68k</tt>, etc.), and a directory
489 for architecture independent packages (<tt>binary-all</tt>).
490         <p>
491 The <em>main</em> section contains additional directories which holds
492 the disk images and some essential pieces of documentation required
493 for installing the Debian distribution on a specific architecture
494 (<tt>disks-i386</tt>, <tt>disks-m68k</tt>, etc.).
495         <p>
496 The <em>binary</em> and <em>source</em> directories are divided
497 further into <em>subsections</em>.
498
499
500       <sect>Sections
501         <p>
502 The <em>main</em> section is what makes up the <em>official Debian
503 GNU/Linux distribution</em>.  The <em>main</em> section is official
504 because it fully complies with all our guidelines.  The other two
505 sections do not, to different degrees; as such, they are not
506 officially part of Debian.
507         <p>
508 Every package in the main section must fully comply with the <url
509 id="&url-dfsg;" name="Debian Free Software Guidelines"> (DFSG) and
510 with all other policy requirements as described in the <url
511 id="&url-debian-policy;" name="Debian Policy Manual">.  The DFSG is
512 our definition of ``free software.'' Check out the Debian Policy
513 Manual for details.
514         <p>
515 The packages which do not apply to the DFSG are placed in the
516 <em>non-free</em> section. These packages are not considered as part
517 of the Debian distribution, though we support their use, and we
518 provide infrastructure (such as our bug-tracking system and mailing
519 lists) for non-free software packages.
520         <p>
521 Packages in the <em>contrib</em> section have to comply with the DFSG,
522 but may fail other requirements.  For instance, they may depend on
523 non-free packages.
524         <p>
525 The <url id="&url-debian-policy;" name="Debian Policy Manual">
526 contains a more exact definition of the three sections. The above
527 discussion is just an introduction.
528         <p>
529 The separation of the three sections at the top-level of the archive
530 is important for all people who want to distribute Debian, either via
531 FTP servers on the Internet or on CD-ROMs: by distributing only the
532 <em>main</em> and <em>contrib</em> sections, one can avoid any legal
533 risks.  Some packages in the <em>non-free</em> section do not allow
534 commercial distribution, for example.
535         <p>
536 On the other hand, a CD-ROM vendor could easily check the individual
537 package licenses of the packages in <em>non-free</em> and include as
538 many on the CD-ROMs as he's allowed. (Since this varies greatly from
539 vendor to vendor, this job can't be done by the Debian developers.)
540
541
542       <sect>Architectures
543         <p>
544 In the first days, the Linux kernel was only available for the Intel
545 i386 (or greater) platforms, and so was Debian. But when Linux became
546 more and more popular, the kernel was ported to other architectures,
547 too.
548         <p>
549 The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola
550 680x0 (like Atari, Amiga and Macintoshes), MIPS, and PowerPC.  The
551 Linux 2.2 kernel supports even more architectures, including ARM and
552 UltraSPARC.  Since Linux supports these platforms, Debian decided that
553 it should, too.  Therefore, Debian has ports underway; in fact, we
554 also have ports underway to non-Linux kernel.  Aside from
555 <em>i386</em> (our name for Intel x86), there is <em>m68k</em>,
556 <em>alpha</em>, <em>powerpc</em>, <em>sparc</em>, <em>hurd-i386</em>,
557 and <em>arm</em>, as of this writing.
558         <p>
559 Debian GNU/Linux 1.3 is only available as <em>i386</em>.  Debian 2.0
560 shipped for <em>i386</em> and <em>m68k</em> architectures.  Debian 2.1
561 ships for the <em>i386</em>, <em>m68k</em>, <em>alpha</em>, and
562 <em>sparc</em> architectures.  Debian 2.2 adds support for the
563 <em>powerpc</em> architecture.
564         <p>
565 Information for developers or uses about the specific ports are
566 available at the <url id="&url-debian-ports;" name="Debian Ports web
567 pages">.
568
569
570       <sect>Subsections
571         <p>
572 The sections <em>main</em>, <em>contrib</em>, and <em>non-free</em>
573 are split into <em>subsections</em> to simplify the installation
574 process and the maintainance of the archive.  Subsections are not
575 formally defined, excepting perhaps the `base' subsection.
576 Subsections exist simply to simplify the organization and browsing of
577 available packages.  Please check the current Debian distribution to
578 see which sections are available.
579
580
581       <sect>Packages
582         <p>
583 There are two types of Debian packages, namely <em>source</em> and
584 <em>binary</em> packages.
585         <p>
586 Source packages consist of either two or three files: a <tt>.dsc</tt>
587 file, and either a <tt>.tar.gz</tt> file or both an
588 <tt>.orig.tar.gz</tt> and a <tt>.diff.gz</tt> file.
589         <p>
590 If a package is developed specially for Debian and is not distributed
591 outside of Debian, there is just one <tt>.tar.gz</tt> file which
592 contains the sources of the program.  If a package is distributed
593 elsewhere too, the <tt>.orig.tar.gz</tt> file stores the so-called
594 <em>upstream source code</em>, that is the source code that's
595 distributed from the <em>upstream maintainer</em> (often the author of
596 the software). In this case, the <tt>.diff.gz</tt> contains the
597 changes made by the Debian maintainer.
598         <p>
599 The <tt>.dsc</tt> lists all the files in the source package together
600 with checksums (<prgn>md5sums</prgn>) and some additional info about
601 the package (maintainer, version, etc.).
602
603
604       <sect>Distribution directories
605         <p>
606 The directory system described in the previous chapter, are themselves
607 contained within <em>distribution directories</em>.  Every
608 distribution is contained in the <tt>dists</tt> directory in the
609 top-level of the Debian archive itself (the symlinks from the
610 top-level directory to the distributions themselves are for backwards
611 compatability and are deprecated).
612         <p>
613 To summarize, the Debian archive has a root directory within an FTP
614 server.  For instance, at the mirror site,
615 <ftpsite>ftp.us.debian.org</ftpsite>, the Debian archive itself is
616 contained in <ftppath>/debian</ftppath>, which is a common location
617 (another is <ftppath>/pub/debian</ftppath>).
618         <p>
619 Within that archive root, the actual distributions are contained in
620 the <tt>dists</tt> directory.  Here is an overview of the layout:
621         <p>
622 <example>
623 <var>archive root</var>/dists/<var>distribution</var>/<var>section</var>/<var>architecture</var>/<var>subsection</var>/<var>packages</var>
624 </example>
625
626 Extrapolating from this layout, you know that to find the i386 base
627 packages for the distribution <em>slink</em>, you would look in
628 <ftppath>/debian/dists/slink/main/binary-i386/base/</ftppath>.
629
630         <sect1>Stable, unstable, and sometimes frozen
631         <p>
632 There is always a distribution called <em>stable</em> (residing in
633 <tt>dists/stable</tt>) and one called <em>unstable</em> (residing in
634 <tt>dists/unstable</tt>). This reflects the development process of the
635 Debian project.
636         <p>
637 Active development is done in the <em>unstable</em> distribution
638 (that's why this distribution is sometimes called the <em>development
639 distribution</em>). Every Debian developer can update his or her
640 packages in this distribution at any time. Thus, the contents of this
641 distribution change from day-to-day. Since no special effort is done
642 to test this distribution, it is sometimes ``unstable.''
643         <p>
644 After a period of development, the <em>unstable</em> distribution is
645 copied in a new distribution directory, called <em>frozen</em>. When
646 that occurs, no changes are allowed to the frozen distribution except
647 bug fixes; that's why it's called ``frozen.''  After another month or
648 a little longer, the <em>frozen</em> distribution is renamed to
649 <em>stable</em>, overriding the old <em>stable</em> distribution,
650 which is removed at that time.
651         <p>
652 This development cycle is based on the assumption that the
653 <em>unstable</em> distribution becomes <em>stable</em> after passing a
654 period of testing as <em>frozen</em>.  Even once a distribution is
655 considered stable, a few bugs inevitably remain--that's why the stable
656 distribution is updated every now and then. However, these updates are
657 tested very carefully and have to be introduced into the archive
658 individually to reduce the risk of introducing new bugs.  You can find
659 proposed additions to <em>stable</em> in the <tt>proposed-updates</tt>
660 directory.  Those packages in <tt>proposed-updates</tt> that pass
661 muster are periodically moved as a batch into the stable distribution
662 and the revision level of the stable distribution is incremented
663 (e.g., `1.3' becomes `1.3r1', `2.0r2' becomes `2.0r3', and so forth).
664         <p>
665 Note that development under <em>unstable</em> is continued during the
666 ``freeze'' period, since a new <em>unstable</em> distribution is be
667 created when the older <em>unstable</em> is moved to <em>frozen</em>.
668 Another wrinkle is that when the <em>frozen</em> distribution is
669 offically released, the old stable distribution is completely removed
670 from the Debian archives (although they do live on at
671 <tt>archive-host;</tt>).
672         <p>
673 In summary, there is always a <em>stable</em> and an <em>unstable</em>
674 distribution available, and the <em>frozen</em> distribution shows up
675 for a month or so from time to time.
676
677
678         <sect1>Experimental
679           <p>
680 The <em>experimental</em> distribution is a specialty distribution.
681 It is not a full distribution in the same sense that `stable' and
682 `unstable' are.  Instead, it is meant to be a temporary staging area
683 for highly experimental software where there's a good chance that the
684 software could break your system.  Users who download and install
685 packages from <em>experimental</em> are expected to have been duly
686 warned.  In short, all bets are off for the <em>experimental</em>
687 distribution.
688           <p>
689 Developers should be very selective in the use of the
690 <em>experimental</em> distribution.  Even if a package is highly
691 unstable, it could well still go into <em>unstable</em>; just state a
692 few warnings in the description.  However, if there is a chance that
693 the software could do grave damage to a system, it might be better to
694 put it into <em>experimental</em>.
695           <p>
696 For instance, an experimental encrypted file system should probably go
697 into <em>experimental</em>.  A new, beta, version of some software
698 which uses completely different configuration might go into
699 <em>experimental</em> at the maintainer's discretion.  New software
700 which isn't likely to damage your system can go into
701 <em>unstable</em>.  If you are working on an incompatible or complex
702 upgrade situation, you can also use <em>experimental</em> as a staging
703 area, so that testers can get early access.
704           <p>
705 However, using <em>experimental</em> as a personal staging area is not
706 always the best idea.  You can't replace or upgrade the files in there
707 on your own (<prgn>dinstall</prgn> and the Debian archive maintainers
708 do that).  Additionally, you'll have to remember to ask the archive
709 maintainers to delete the package one you have uploaded it to
710 <em>unstable</em>.  Using your personal web space on
711 <tt>va.debian.org</tt> is generally a better idea, so that you put
712 less strain on the Debian archive maintainers.
713
714
715       <sect id="codenames">Release code names
716         <p>
717 Every released Debian distribution has a <em>code name</em>: Debian
718 1.1 is called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0,
719 `hamm'; Debian 2.1, `slink'; and Debian 2.2, `potato'.  There is also
720 a ``pseudo-distribution'', called `sid' which is contains packages for
721 architectures which are not yet officially supported or released by
722 Debian.  These architectures are planned to be integrated into the
723 mainstream distribution at some future date.
724         <p>
725 Since the Debian has an open development model (i.e., everyone can
726 participate and follow the development) even the unstable distribution
727 is distributed via the Internet on the Debian FTP and HTTP server
728 network. Thus, if we had called the directory which contains the
729 development version `unstable', then we would have to rename it to
730 `stable' when the version is released, which would cause all FTP
731 mirrors to re-retrieve the whole distribution (which is already very
732 large!).
733         <p>
734 On the other hand, if we called the distribution directories
735 <em>Debian-x.y</em> from the beginning, people would think that Debian
736 release <em>x.y</em> is available. (This happened in the past, where a
737 CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0 development
738 version. That's the reason why the first official Debian release was
739 1.1, and not 1.0.)
740         <p>
741 Thus, the names of the distribution directories in the archive are
742 determined by their code names and not their release status (i.e.,
743 `slink').  These names stay the same during the development period and
744 after the release; symbolic links, which can be changed, are made to
745 indicate the currently released stable distribution.  That's why the
746 real distribution directories use the <em>code names</em> and symbolic
747 links for <em>stable</em>, <em>unstable</em>, and <em>frozen</em>
748 point to the appropriate release directories.
749
750
751     <chapt id="upload">Package uploads
752
753       <sect>Announcing new packages
754         <p>
755 If you want to create a new package for the Debian distribution, you
756 should first check the <url id="&url-wnpp;" name="Work-Needing and
757 Prospective Packages (WNPP)"> list.  Checking the WNPP ensures that no
758 one is already working on packaging that software, and that effort is
759 not duplicated. Assuming no one else is already working on your
760 prospective package, you must then send a short email to
761 &email-debian-devel; describing your plan to create a new package.
762 You should set the subject of the email to ``intent to package
763 <var>foo</var>'', substituting the name of the new package for
764 <var>foo</var>.
765         <p>
766 There are a number of reasons why we ask maintainers to follow these
767 steps:
768           <list compact>
769             <item>
770 It helps the (potentially new) maintainer to tap into the experience
771 of people on the list, and lets them know if any one else is working
772 on it already.
773             <item>
774 It lets other people thinking about working on the package know that
775 there already is a volunteer, and efforts may be shared.  The ``intent
776 to package'' message to &email-debian-devel@; will be picked up the
777 the WNPP maintainer, and your intention will be published in
778 subsequent versions of the WNPP document.
779             <item>
780 It lets the rest of the maintainers know more about the package than
781 the one line description and the changelog entry ``Initial version''
782 that generally gets posted to <tt>debian-devel-changes</tt> by
783 default.
784             <item>
785 It is helpful to the people who live off unstable (and form our first
786 line of testers); we should encourage these people.
787             <item>
788 The announcements give maintainers and other interested parties a
789 better feel of what is going on, and what is new, in the project.
790           </list>
791
792
793       <sect id="uploading">Uploading a package
794
795         <sect1>Generating the changes file
796           <p>
797 When a package is uploaded to the Debian FTP archive, it must be
798 accompanied by a <tt>.changes</tt> file, which gives directions to the
799 archive maintainers for its handling.  This is usually generated by
800 <prgn>dpkg-genchanges</prgn> during the normal package build process.
801           <p>
802 The changes file is a control file with the following fields:
803           <p>
804 &control-file-fields;
805           <p>
806 All of these fields are mandatory for a Debian upload.  See the list
807 of control fields in the <url id="&url-pkg-manual;" name="Debian
808 Packaging Manual"> for the contents of these fields.  You can close
809 bugs automatically using the <tt>Description</tt> field, see <ref
810 id="upload-bugfix">.  Only the <tt>Distribution</tt> field is
811 discussed in this section, since it relates to the archive maintenance
812 policies.
813
814
815         <sect1 id="upload-dist">Picking a distribution
816           <p>
817 Notably, the <tt>Distribution</tt> field, which originates from the
818 <file>debian/changelog</file> file, indicates which distribution the
819 package is intended for.  There are four possible values for this
820 field: `stable', `unstable', `frozen', or `experimental'; these values
821 can also be combined.  For instance, if you have a crucial security
822 fix release of a package, and the package has not diverged between the
823 <em>stable</em> and <em>unstable</em> distributions, then you might
824 put `stable unstable' in the <file>changelog</file>'s
825 <tt>Distribution</tt> field.  Or, if Debian has been frozen, and you
826 want to get a bug-fix release into <em>frozen</em>, you would set the
827 distribution to `frozen unstable'.  (See <ref id="upload-frozen"> for
828 more information on when to upload to <em>frozen</em>.)  Note that
829 setting the distribution to `stable' means that the package will be
830 placed into the <tt>proposed-updates</tt> directory of the Debian
831 archive for further testing before it is actually included in
832 <em>stable</em>.  Also note that it never makes sense to combine the
833 <em>experimental</em> distribution with anything else.
834           <p>
835 The first time a version is uploaded which corresponds to a particular
836 upstream version the original source tar file should be uploaded and
837 included in the <tt>.changes</tt> file; subsequent times the very same
838 tar file should be used to build the new diffs and <tt>.dsc</tt>
839 files, and it need not then be uploaded.
840           <p>
841 By default <prgn>dpkg-genchanges</prgn> and
842 <prgn>dpkg-buildpackage</prgn> will include the original source tar
843 file if and only if the Debian revision part of the source version
844 number is 0 or 1, indicating a new upstream version.  This behaviour
845 may be modified by using <tt>-sa</tt> to always include it or
846 <tt>-sd</tt> to always leave it out.
847           <p>
848 If no original source is included in the upload then the original
849 source tar-file used by <prgn>dpkg-source</prgn> when constructing the
850 <tt>.dsc</tt> file and diff to be uploaded <em>must</em> be
851 byte-for-byte identical with the one already in the archive.  If there
852 is some reason why this is not the case then the new version of the
853 original source should be uploaded, possibly by using the <tt>-sa</tt>
854 flag.
855
856           <sect2 id="upload-frozen">Uploading to <em>frozen</em>
857             <p>
858 The Debian freeze is a crucial time for Debian.  It is our chance to
859 synchronize and stabilize our distribution as a whole.  Therefore,
860 care must be taken when uploading to <em>frozen</em>.
861             <p>
862 It is tempting to always try to get the newest release of software
863 into the release.  However, it's much more important that the system
864 as a whole is stable and works as expected.
865             <p>
866 The watchword for uploading to <em>frozen</em> is <strong>no new
867 code</strong>.  This is a difficult thing to quantify, so here are
868 some guidelines:
869             <p>
870 <list>
871                 <item>
872 Fixes for bugs of severity <em>critical</em>, <em>grave</em>, or
873 <em>important</em> severity are always allowed for those packages that
874 must exist in the final release
875                 <item>
876 <em>critical</em>, <em>grave</em>, and <em>important</em> bug fixes
877 are only allowed for non-necessary packages if they don't add any new
878 features
879                 <item>
880 normal bug fixes are allowed (though discouraged) on all packages if
881 and only if there are no new features
882                 <item>
883 wishlist fixes are not allowed (they are, after all, not really bugs)
884                 <item>
885 documentation bug fixes are allowed, since good documentation is
886 important
887               </list>
888             <p>
889 Remember, there is statistically a 15% chance that every bug fix will
890 introduce a new bug.  The introduction and discovery of new bugs
891 either delays release or weakens the final product.  There is little
892 correlation between the severity of the original bug and the severity
893 of the introduced bug.
894
895
896
897         <sect1 id="upload-checking">Checking the package prior to upload
898           <p>
899 Before you upload your package, you should do basic testing on it.
900 Make sure you try the following activities (you'll need to have an
901 older version of the Debian package around).
902 <list>
903               <item>
904 Install the package and make sure the software works, or upgrade the
905 package from an older version to your new version if a Debian package
906 for it already exists.
907               <item>
908 Run <prgn>lintian</prgn> over the package.  You can run
909 <prgn>lintian</prgn> as follows: <tt>lintian -v
910 <var>package-version</var>.changes</tt>. This will check the source
911 package as well as the binary package.  If you don't understand the
912 output that <prgn>lintian</prgn> generates, try adding the <tt>-i</tt>
913 switch, which will cause <prgn>lintian</prgn> to output a very verbose
914 description of the problem.
915                 <p>
916 Normally, a package should <em>not</em> be uploaded if it causes lintian
917 to emit errors (they will start with <tt>E</tt>).
918                 <p>
919 For more information on <prgn>lintian</prgn>, see <ref id="lintian">.
920               <item>
921 Downgrade the package to the previous version (if one exists) -- this
922 tests the <tt>postrm</tt> and <tt>prerm</tt> scripts.
923               <item>
924 Remove the package, then reinstall it.
925             </list>
926
927
928         <sect1 id="upload-master">Uploading to <tt>master</tt>
929           <p>
930 To upload a package, you need a personal account on
931 <ftpsite>master.debian.org</ftpsite>.  All maintainers should already
932 have this account, see <ref id="servers-master">.  You can use either
933 <prgn>scp</prgn> or <prgn>ftp</prgn> to transfer the files.  In either
934 case, the files need to be placed into
935 <ftppath>&master-upload-dir</ftppath>.  (You cannot upload to Incoming
936 on master using anonymous FTP -- you must use your user-name and
937 password.)
938           <p>
939 <em>Note:</em> Do not upload packages containing software that is
940 export-controlled by the United States government to <tt>master</tt>,
941 nor to the overseas upload queues on <tt>chiark</tt> or
942 <tt>erlangen</tt>.  This prohibition covers almost all cryptographic
943 software, and even sometimes software that contains ``hooks'' to
944 cryptographic software, such as electronic mail readers that support
945 PGP encryption and authentication.  Uploads of such software should go
946 to <tt>non-us</tt> (see <ref id="upload-non-us">).  If you are not
947 sure whether U.S. export controls apply to your package, post a
948 message to &email-debian-devel; and ask.
949           <p>
950 You may also find the Debian package <package>dupload</package> useful
951 when uploading packages.  This handy program is distributed with
952 defaults for uploading via <prgn>ftp</prgn> to <tt>master</tt>,
953 <tt>chiark</tt>, and <tt>erlangen</tt>.  It can also be configured to
954 use <prgn>ssh</prgn>.  See <manref name="dupload" section="1"> and
955 <manref name="dupload" section="5"> for more information.
956
957
958         <sect1 id="upload-non-us">Uploading to <tt>pandora</tt> (non-us)
959           <p>
960 As discussed above, export controlled software should not be uploaded
961 to <tt>master</tt>.  Instead, use non-anonymous FTP or
962 <prgn>scp</prgn> to copy the package to
963 <ftpsite>pandora.debian.org</ftpsite>, placing the files in
964 <ftppath>&non-us-upload-dir</ftppath>.  By default, you can use your
965 same account which works on <tt>master</tt>.
966           <p>
967 The program <prgn>dupload</prgn> comes with support for uploading to
968 <tt>pandora</tt>; please refer to the documentation that comes with
969 the program for details.
970
971         <sect1>Uploads via <tt>chiark</tt>
972           <p>
973 If you have a slow network connection to <tt>master</tt>, there are
974 alternatives.  One is to upload files to <tt>Incoming</tt> via a
975 upload queue in Europe on <tt>chiark</tt>. For details connect to
976 <url id="&url-chiark-readme;">.
977           <p>
978 <em>Note:</em> Do not upload packages containing software that is
979 export-controlled by the United States government to the queue on
980 <tt>chiark</tt>.  Since this upload queue goes to <tt>master</tt>, the
981 prescription found in <ref id="upload-master"> applies here as well.
982           <p>
983 The program <prgn>dupload</prgn> comes with support for uploading to
984 <tt>chiark</tt>; please refer to the documentation that comes with the
985 program for details.
986
987
988         <sect1>Uploads via <tt>erlangen</tt>
989           <p>
990 Another upload queue is available in Germany: just upload the files
991 via anonymous FTP to <url id="&url-upload-erlangen;">.
992           <p>
993 The upload must be a complete Debian upload, as you would put it into
994 <tt>master</tt>'s <tt>Incoming</tt>, i.e., a <tt>.changes</tt> files
995 along with the other files mentioned in the <tt>.changes</tt>. The
996 queue daemon also checks that the <tt>.changes</tt> is correctly
997 PGP-signed by a Debian developer, so that no bogus files can find
998 their way to <tt>master</tt> via the queue. Please also make sure that
999 the <tt>Maintainer</tt> field in the <tt>.changes</tt> contains
1000 <em>your</em> e-mail address. The address found there is used for all
1001 replies, just as on <tt>master</tt>.
1002           <p>
1003 There's no need to move your files into a second directory after the
1004 upload as on <tt>chiark</tt>. And, in any case, you should get some
1005 mail reply from the queue daemon what happened to your
1006 upload. Hopefully it should have been moved to <tt>master</tt>, but in
1007 case of errors you're notified, too.
1008           <p>
1009 <em>Note:</em> Do not upload packages containing software that is
1010 export-controlled by the United States government to the queue on
1011 <tt>erlangen</tt>.  Since this upload queue goes to <tt>master</tt>, the
1012 prescription found in <ref id="upload-master"> applies here as well.
1013           <p>
1014 The program <prgn>dupload</prgn> comes with support for uploading to
1015 <tt>erlangen</tt>; please refer to the documentation that comes with
1016 the program for details.
1017
1018
1019         <sect1>Other Upload Queues
1020           <p>
1021 Another upload queue is available which is based in the US, and is a
1022 good backup when there are problems reaching <tt>master</tt>.  You can
1023 upload files, just as in <tt>erlangen</tt>, to <url
1024 id="&url-upload-samosa;">.
1025           <p>
1026 An upload queue is available in Japan: just upload the files via
1027 anonymous FTP to <url id="&url-upload-jp;">.
1028
1029
1030
1031       <sect id="upload-announce">Announcing package uploads
1032         <p>
1033 When a package is uploaded an announcement should be posted to one of
1034 the ``debian-changes'' lists. The announcement should give the
1035 (source) package name and version number, and a very short summary of
1036 the changes, in the <em>Subject</em> field, and should contain the
1037 PGP-signed <tt>.changes</tt> file.  Some additional explanatory text
1038 may be added before the start of the <tt>.changes</tt> file.
1039         <p>
1040 If a package is released with the <tt>Distribution:</tt> set to
1041 `stable', the announcement is sent to &email-debian-changes;.  If a
1042 package is released with <tt>Distribution:</tt> set to `unstable',
1043 `experimental', or `frozen' (when present), the announcement should be
1044 posted to &email-debian-devel-changes; instead.
1045         <p>
1046 On occasion, it is necessary to upload a package to both the
1047 <em>stable</em> and <em>unstable</em> distributions; this is done by
1048 putting both distributions in the <tt>Distribution:</tt> line.  In
1049 such a case the upload announcement should go to both of the above
1050 mailing lists.
1051         <p>
1052 The <prgn>dupload</prgn> program is clever enough to determine for itself
1053 where the announcement should go, and will automatically mail the
1054 announcement to the right list.  See <ref id="dupload">.
1055
1056       <sect id="upload-notification">
1057         <heading>Notification that a new package has been installed</heading>
1058         <p>
1059 The Debian archive maintainers are responsible for handling package
1060 uploads.  For the most part, uploads are automatically handled on a
1061 daily basis by an archive maintenance tool called
1062 <prgn>dinstall</prgn>.  Specifically, updates to existing packages to
1063 the `unstable' distribution are handled automatically. In other cases,
1064 notably new packages, placing the uploaded package into the
1065 distribution is handled manually. When uploads are handled manually,
1066 the change to the archive may take up to a week to occur (please be
1067 patient).
1068         <p>
1069 In any case, you will receive notification indicating that the package
1070 has been uploaded via email.  Please examine this notification
1071 carefully.  You may notice that the package didn't go into the section
1072 you thought you set it to go into.  Read on for why.
1073
1074         <sect1 id="override-file">The override file
1075           <p>
1076 The <file>debian/control</file> file's <tt>Section</tt> and
1077 <tt>Priority</tt> fields do not actually specify where the file will
1078 be placed in the archive, nor its priority.  In order to retain the
1079 overall integrity of the archive, it is the archive maintainers who
1080 have control over these fields.  The values in the
1081 <file>debian/control</file> file are actually just hints.
1082           <p>
1083 The archive maintainers keep track of the canonical sections and
1084 priorities for packages in the <em>override file</em>.  Sometimes the
1085 <em>override file</em> needs correcting.  Simply changing the
1086 package's <file>control</file> file is not going to work.  Instead,
1087 you should email &email-override; or submit a bug against
1088 <package>ftp.debian.org</package>.
1089           <p>
1090 For more information about <em>override files</em>, see <manref
1091 name="dpkg-scanpackages" section="8">, &file-bts-mailing;, and
1092 &file-bts-info;.
1093
1094
1095
1096     <chapt id="nmu">Non-Maintainer Uploads (NMUs)
1097       <p>
1098 Under certain circumstances it is necessary for someone other than the
1099 official package maintainer to make a release of a package.  This is
1100 called a non-maintainer upload, or NMU.
1101        <p>
1102 Debian porters, who compile packages for different architectures, do
1103 NMUs as part of their normal porting activity (see <ref
1104 id="porting">).  Another reason why NMUs are done is when a Debian
1105 developers needs to fix another developers' packages in order to
1106 address serious security problems or crippling bugs, especially during
1107 the freeze, or when the package maintainer is unable to release a fix
1108 in a timely fashion.
1109       <p>
1110 This chapter contains information providing guidelines for when and
1111 how NMUs should be done.  A fundamental distinction is made between
1112 source and binary NMUs, which is explained in the next section.
1113
1114       <sect id="nmu-terms">Terminology
1115         <p>
1116 There are two new terms used throughout this section: ``binary NMU''
1117 and ``source NMU''.  These terms are used with specific technical
1118 meaning throughout this document.  Both binary and source NMUs are
1119 similar, since they involve an upload of a package by a developer who
1120 is not the official maintainer of that package.  That is why it's a
1121 <em>non-maintainer</em> upload.
1122         <p>
1123 A source NMU is a upload of a package by a developer who is not the
1124 official maintainer, for the purposes of fixing a bug in the package.
1125 Source NMUs always involves changes to the source (even if it is just
1126 a change to <file>debian/changelog</file>).  This can be either a change
1127 to the upstream source, or a change to the Debian bits of the source.
1128         <p>
1129 A binary NMU is a recompilation and upload of a binary package for a
1130 new architecture.  As such, it is usually part of a porting effort.  A
1131 binary NMU is non-maintainer uploaded binary version of a package
1132 (often for another architecture), with no source changes required.
1133 There are many cases where porters must fix problems in the source in
1134 order to get them to compile for their target architecture; that would
1135 be considered a source NMU rather than a binary NMU.  As you can see,
1136 we don't distinguish in terminology between porter NMUs and non-porter
1137 NMUs.
1138         <p>
1139 Both classes of NMUs, source and binary, can be lumped by the term
1140 ``NMU''.  However, this often leads to confusion, since most people
1141 think ``source NMU'' when they think ``NMU''.  So it's best to be
1142 careful.  In this chapter, if I use the unqualified term ``NMU'', I
1143 mean both source and binary NMUs.
1144
1145
1146       <sect id="nmu-who">Who can do an NMU
1147         <p>
1148 Only official, registered Debian maintainers can do binary or source
1149 NMUs.  An official maintainer is someone who has their key in the
1150 Debian key ring.  Non-developers, however, are encouraged to download
1151 the source package and start hacking on it to fix problems; however,
1152 rather than doing an NMU, they should just submit worthwhile patches
1153 to the Bug Tracking System.  Maintainers almost always appreciate
1154 quality patches and bug reports.
1155
1156
1157       <sect id="nmu-when">When to do a source NMU
1158         <p>
1159 Guidelines for when to do a source NMU depend on the target
1160 distribution, i.e., stable, unstable, or frozen.  Porters have
1161 slightly different rules than non-porters, due to their unique
1162 circumstances (see <ref id="source-nmu-when-porter">).
1163         <p>
1164 Only critical changes or security bug fixes make it into stable.  When
1165 a security bug is detected a fixed package should be uploaded as soon
1166 as possible. In this case, the Debian Security Managers should get in
1167 contact with the package maintainer to make sure a fixed package is
1168 uploaded within a reasonable time (less than 48 hours). If the package
1169 maintainer cannot provide a fixed package fast enough or if he/she
1170 cannot be reached in time, the Security Manager may upload a fixed
1171 package (i.e., do a source NMU).
1172         <p>
1173 During the release freeze (see <ref id="upload-frozen">), NMUs which
1174 fix important or higher severity bugs are encouraged and accepted.
1175 Even during this window, however, you should endeavor to reach the
1176 current maintainer of the package; they might be just about to upload
1177 a fix for the problem.  As with any source NMU, the guidelines found
1178 in <ref id="nmu-guidelines"> need to be followed.
1179         <p>
1180 Bug fixes to unstable by non-maintainers are also acceptable, but only
1181 as a last resort or with permission.  Try the following steps first,
1182 and if they don't work, it is probably OK to do an NMU:
1183         <p>
1184 <list>
1185             <item>
1186 Make sure that the package bug is in the Debian Bug Tracking System
1187 (BTS).  If not, submit a bug.
1188             <item>
1189 Email the maintainer, and offer to help fix the package bug.  Give it a 
1190 few days.
1191             <item>
1192 Go ahead and fix the bug, submitting a patch to the right bug in the
1193 BTS.  Build the package and test it as discussed in <ref
1194 id="upload-checking">.  Use it locally.
1195             <item>
1196 Wait a couple of weeks for a response.
1197             <item>
1198 Email the maintainer, asking if it is OK to do an NMU.
1199             <item>
1200 Double check that your patch doesn't have any unexpected side effects.
1201 Make sure your patch is as small and as non-disruptive as it can be.
1202             <item>
1203 Wait another week for a response.
1204             <item>
1205 Go ahead and do the source NMU, as described in <ref
1206 id="nmu-guidelines">.
1207           </list>
1208
1209
1210
1211       <sect id="nmu-guidelines">How to do a source NMU
1212         <p>
1213 The following applies to porters insofar as they are playing the dual
1214 role of being both package bug-fixers and package porters.  If a
1215 porter has to change the Debian source archive, automatically their
1216 upload is a source NMU and is subject to its rules.  If a porter is
1217 simply uploading a recompiled binary package, the rules are different;
1218 see <ref id="porter-guidelines">.
1219         <p>
1220 First and foremost, it is critical that NMU patches to source should
1221 be as non-disruptive as possible.  Do not do housekeeping tasks, do
1222 not change the name of modules or files, do not move directories; in
1223 general, do not fix things which are not broken.  Keep the patch as
1224 small as possible.  If things bother you aesthetically, talk to the
1225 Debian maintainer, talk to the upstream maintainer, or submit a bug.
1226 However, aesthetic changes must <em>not</em> be made in a non-maintainer
1227 upload.
1228
1229
1230         <sect1 id="nmu-version">Source NMU version numbering
1231           <p>
1232 Whenever you have made a change to a package, no matter how trivial,
1233 the version number needs to change.  This enables our packing system
1234 to function.
1235           <p>
1236 If you are doing a non-maintainer upload (NMU), you should add a new
1237 minor version number to the <var>debian-revision</var> part of the
1238 version number (the portion after the last hyphen).  This extra minor
1239 number will start at `1'.  For example, consider the package `foo',
1240 which is at version 1.1-3.  In the archive, the source package control
1241 file would be <file>foo_1.1-3.dsc</file>.  The upstream version is
1242 `1.1' and the Debian revision is `3'.  The next NMU would add a new
1243 minor number `.1' to the Debian revision; the new source control file
1244 would be <file>foo_1.1-3.1.dsc</file>.
1245           <p>
1246 The Debian revision minor number is needed to avoid stealing one of
1247 the package maintainer's version numbers, which might disrupt their
1248 work.  It also has the benefit of making it visually clear that a
1249 package in the archive was not made by the official maintainer.
1250           <p>
1251 If there is no <var>debian-revision</var> component in the version
1252 number then one should be created, starting at `0.1'.  If it is
1253 absolutely necessary for someone other than the usual maintainer to
1254 make a release based on a new upstream version then the person making
1255 the release should start with the <var>debian-revision</var> value
1256 `0.1'.  The usual maintainer of a package should start their
1257 <var>debian-revision</var> numbering at `1'.  Note that if you do
1258 this, you'll have to invoke <prgn>dpkg-buildpackage</prgn> with the
1259 <tt>-sa</tt> switch to force the build system to pick up the new
1260 source package (normally it only looks for Debian revisions of '0' or
1261 '1' -- it's not yet clever enough to know about `0.1').
1262           <p>
1263 Remember, porters who are simply recompiling a package for a different
1264 architecture do not need to renumber.  Porters should use new version
1265 numbers if and only if they actually have to modify the source package
1266 in some way, i.e., if they are doing a source NMU and not a binary
1267 NMU.
1268
1269
1270         <sect1 id="nmu-changelog">
1271           <heading>Source NMUs must have a new changelog entry</heading>
1272           <p>
1273 A non-maintainer doing a source NMU must create a changelog entry,
1274 describing which bugs are fixed by the NMU, and generally why the NMU
1275 was required and what it fixed.  The changelog entry will have the
1276 non-maintainer's email address in the log entry and the NMU version
1277 number in it.</p>
1278           <p>
1279 By convention, source NMU changelog entries start with the line
1280 <example>
1281   * Non-maintainer upload
1282 </example></p></sect1>
1283
1284
1285         <sect1 id="nmu-patch">Source NMUs and the Bug Tracking System
1286           <p>
1287 Maintainers other than the official package maintainer should make as
1288 few changes to the package as possible, and they should always send a
1289 patch as a unified context diff (<tt>diff -u</tt>) detailing their
1290 changes to the Bug Tracking System.
1291           <p>
1292 What if you are simply recompiling the package?  In this case, the
1293 process is different for porters than it is for non-porters, as
1294 mentioned above.  If you are not a porter and are doing an NMU that
1295 simply requires a recompile (i.e., a new shared library is available
1296 to be linked against, a bug was fixed in
1297 <package>debhelper</package>), there must still be a changelog entry;
1298 therefore, there will be a patch.  If you are a porter, you are
1299 probably just doing a binary NMU.  (Note: this leaves out in the cold
1300 porters who have to do recompiles -- chalk it up as a weakness in how
1301 we maintain our archive.)
1302           <p>
1303 If the source NMU (non-maintainer upload) fixes some existing bugs,
1304 the bugs in the Bug Tracking System which are fixed need to be
1305 <em>notified</em> but not actually <em>closed</em> by the
1306 non-maintainer.  Technically, only the official package maintainer or
1307 the original bug submitter are allowed to close bugs.  However, the
1308 person making the non-maintainer release must send a short message to
1309 the relevant bugs explaining that the bugs have been fixed by the NMU.
1310 Using <email>control@bugs.debian.org</email>, the party doing the NMU
1311 should also set the severity of the bugs fixed in the NMU to `fixed'.
1312 This ensures that everyone knows that the bug was fixed in an NMU;
1313 however the bug is left open until the changes in the NMU are
1314 incorporated officially into the package by the official package
1315 maintainer.  Also, open a bug with the patches needed to fix the
1316 problem, or make sure that one of the other (already open) bugs has
1317 the patches.
1318           <p>
1319 The normal maintainer will either apply the patch or employ an
1320 alternate method of fixing the problem.  Sometimes bugs are fixed
1321 independently upstream, which is another good reason to back out an
1322 NMU's patch.  If the maintainer decides not to apply the NMU's patch
1323 but to release a new version, the maintainer needs to ensure that the
1324 new upstream version really fixes each problem that was fixed in the
1325 non-maintainer release.
1326           <p>
1327 In addition, the normal maintainer should <em>always</em> retain the
1328 entry in the changelog file documenting the non-maintainer upload.
1329
1330
1331         <sect1 id="nmu-build">Building source NMUs
1332           <p>
1333 Source NMU packages are built normally.  Pick a distribution using the
1334 same rules as found in <ref id="upload-dist">.  Just as described in
1335 <ref id="uploading">, a normal changes file, etc., will be built.  In
1336 fact, all the prescriptions from <ref id="upload"> apply, including
1337 the need to announce the NMU to the proper lists.
1338           <p>
1339 Make sure you do <em>not</em> change the value of the maintainer in
1340 the <file>debian/control</file> file.  Your name from the NMU entry of
1341 the <file>debian/changelog</file> file will be used for signing the
1342 changes file.
1343
1344
1345
1346
1347     <chapt id="porting">Porting and Being Ported
1348       <p>
1349 Debian supports an ever-increasing number of architectures.  Even if
1350 you are not a porter, and you don't use any architecture but one, it
1351 is part of your duty as a maintainer to be aware of issues of
1352 portability.  Therefore, even if you are not a porter, you should read
1353 most of this chapter.
1354       <p>
1355 Porting is the act of building Debian packages for architectures which
1356 is different from the original architecture of the package
1357 maintainer's binary package.  It is a unique and essential activity.
1358 In fact, porters do most of the actual compiling of Debian packages.
1359 For instance, for one <em>i386</em> binary package, there has to be a
1360 recompile for each architecture, which is around five more builds.
1361
1362
1363       <sect id="kind-to-porters">Being Kind to Porters
1364         <p>
1365 Porters have a difficult and unique task, since they are required to
1366 deal with a large volume of packages.  Ideally, every source package
1367 should build right out of the box; unfortunately, this is often not
1368 the case.  This section contains a checklist of ``gotchas'' often
1369 committed by Debian maintainers -- common problems which often stymie
1370 porters, and make their jobs unnecessarily more difficult.
1371         <p>
1372 The first and most important watchword is to respond quickly to bug or
1373 issues raised by porters.  Please treat porters with courtesy, as if
1374 they were in fact co-maintainers of your package (which in a way, they
1375 are).
1376         <p>
1377 By far, most of the problems encountered by porters are caused by
1378 <em>packaging bugs</em> in the source packages.  Here is a checklist
1379 of things you should check or be aware of.
1380
1381 <enumlist>
1382             <item>
1383 Don't set architecture to a value other than ``all'' or ``any'' unless
1384 you really mean it.  In too many cases, maintainers don't follow the
1385 instructions in the <url
1386 id="http://www.debian.org/doc/packaging-manuals/packaging.html/"
1387 name="Debian Packaging Manual">.  Setting your architecture to ``i386''
1388 is usually incorrect.
1389             <item>
1390 Make sure your source package is correct.  Do <tt>dpkg-source -x
1391 <var>package</var>.dsc</tt> to make sure your source package unpacks
1392 properly.  Then, in there, try building your package from scratch with
1393 <tt>dpkg-buildpackage</tt>.
1394             <item>
1395 Make sure you don't ship your source package with the
1396 <file>debian/files</file> or <file>debian/substvars</file> files.
1397 They should be removed by the `clean' target of
1398 <file>debian/rules</file>.
1399             <item>
1400 Make sure you don't rely on locally installed or hacked configurations
1401 or programs.  For instance, you should never be calling programs in
1402 <file>/usr/local/bin</file> or the like.  Try not to rely on programs
1403 be setup in a special way.  Try building your package on another
1404 machine, even if it's the same architecture.
1405             <item>
1406 Don't depend on the package your building already being installed (a
1407 sub-case of the above issue).
1408             <item>
1409 Don't rely on <prgn>egcc</prgn> being available; don't rely on
1410 <prgn>gcc</prgn> being a certain version.
1411             <item>
1412 Make sure your debian/rules contains separate ``binary-arch'' and
1413 ``binary-indep'' targets, as the Debian Packaging Manual requires.
1414 Make sure that both targets work independently, that is, that you can
1415 call the target without having called the other before. To test this,
1416 try to run <tt>dpkg-buildpackage -b</tt>.
1417           </enumlist>
1418
1419
1420       <sect id="porter-guidelines">Guidelines for Porter Uploads
1421         <p>
1422 If the package builds out of the box for the architecture to be ported
1423 to, you are in luck and your job is easy.  This section applies to
1424 that case; it describes how to build and upload your binary NMU so
1425 that it is properly installed into the archive.  If you do have to
1426 patch the package in order to get it to compile for the other
1427 architecture, you are actually doing a source NMU, so consult <ref
1428 id="nmu-guidelines"> instead.
1429         <p>
1430 In a binary NMU, no real changes are being made to the source.  You do
1431 not need to touch any of the files in the source package.  This
1432 includes <file>debian/changelog</file>.
1433         <p>
1434 Sometimes you need to recompile a packages against other packages
1435 which have been updated, such as libraries.  You do have to bump the
1436 version number in this case, so that the upgrade system can function
1437 properly.  Even so, these are considered binary-only NMUs -- there is
1438 no need in this case for all architectures to recompile.  You should
1439 set the version number as in the case of NMU versioning, but add a
1440 ``.0.'' before the the NMU version.  For instance, a recompile-only
1441 NMU of the source package ``foo_1.3-1'' would be numbered
1442 ``foo_1.3-1.0.1''.
1443         <p>
1444 The way to invoke <prgn>dpkg-buildpackage</prgn> is as
1445 <tt>dpkg-buildpackage -B -m<var>porter-email</var></tt>.  Of course,
1446 set <var>porter-email</var> to your email address.  This will do a
1447 binary-only build of only the architecture-dependant portions of the
1448 package, using the `binary-arch' target in <file>debian/rules</file>.
1449
1450
1451         <sect1 id="source-nmu-when-porter">
1452           <heading>When to do a source NMU if you are a porter</heading>
1453           <p>
1454 Porters doing a source NMU generally follow the guidelines found in
1455 <ref id="nmu">, just like non-porters.  However, it is expected that
1456 the wait cycle for a porter's source NMU is smaller than for a
1457 non-porter, since porters have to cope with a large quantity of
1458 packages.
1459           <p>
1460 Again, the situation varies depending on the distribution they are
1461 uploading to.  Crucial fixes (i.e., changes need to get a source
1462 package to compile for a released-targeted architecture) can be
1463 uploaded with <em>no</em> waiting period for the `frozen' distribution.
1464           <p>
1465 However, if you are a porter doing an NMU for `unstable', the above
1466 guidelines for porting should be followed, with two variations.
1467 Firstly, the acceptable waiting period -- the time between when the
1468 bug is submitted to the BTS and when it is OK to do an NMU -- is seven
1469 days for porters working on the unstable distribution.  This period
1470 can be shortened if the problem is critical and imposes hardship on
1471 the porting effort, at the discretion of the porter group.  (Remember,
1472 none of this is Policy, just mutually agreed upon guidelines.)
1473           <p>
1474 Secondly, porters doing source NMUs should make sure that the bug they
1475 submit to the BTS should be of severity `important' or greater.  This
1476 ensures that a single source package can be used to compile every
1477 supported Debian architecture by release time.  It is very important
1478 that we have one version of the binary and source package for all
1479 architecture in order to comply with many licenses.
1480           <p>
1481 Porters should try to avoid patches which simply kludge around bugs in
1482 the current version of the compile environment, kernel, or libc.
1483 Sometimes such kludges can't be helped.  If you have to kludge around
1484 compilers bugs and the like, make sure you <tt>#ifdef</tt> your work
1485 properly; also, document your kludge so that people know to remove it
1486 once the external problems have been fixed.
1487           <p>
1488 Porters may also have an unofficial location where they can put the
1489 results of their work during the waiting period.  This helps others
1490 running the port have the benefit of the porter's work, even during
1491 the waiting period.  Of course, such locations have no official
1492 blessing or status, so buyer, beware.
1493
1494
1495       <sect>Tools for Porters
1496         <p>
1497 There are several tools available for the porting effort. This section
1498 contains a brief introduction to these tools; see the package
1499 documentation or references for full information.
1500
1501
1502         <sect1 id="quinn-diff">
1503           <heading><package>quinn-diff</package>
1504           <p>
1505 <package>quinn-diff</package> is used to locate the differences from
1506 one architecture to another.  For instance, it could tell you which
1507 packages need to be ported for architecture <var>Y</var>, based on
1508 architecture <var>X</var>.
1509
1510
1511         <sect1 id="buildd">
1512           <heading><package>buildd</package>
1513           <p>
1514 The <package>buildd</package> system is used as a distributed,
1515 client-server build distribution system.  It is usually used in
1516 conjunction with <em>auto-builders</em>, which are ``slave'' hosts
1517 which simply check out and attempt to auto-build packages which need
1518 to be ported.  There is also an email interface to the system, which
1519 allows porters to ``check out'' a source package (usually one which
1520 cannot yet be autobuilt) and work on it.
1521           <p>
1522 <package>buildd</package> is not yet available as a package; however,
1523 most porting efforts are either using it currently or planning to use
1524 it in the near future.  It collects a number of as yet unpackaged
1525 components which are currently very useful and in use continually,
1526 such as <prgn>andrea</prgn>, <prgn>sbuild</prgn> and
1527 <prgn>wanna-build</prgn>.
1528           <p>
1529 Some of the data produced by <package>buildd</package> which is
1530 generally useful to porters is available on the web at <url
1531 id="&url-buildd;">.  This data includes nightly updated information
1532 from <prgn>andrea</prgn> (source dependencies) and
1533 <package>quinn-diff</package> (packages needing recompilation).
1534           <p>
1535 We are very excited about this system, since it potentially has so
1536 many uses.  Independent development groups can use the system for
1537 different sub-flavors of Debian, which may or may not really be of
1538 general interest (for instance, a flavor of Debian built with gcc
1539 bounds checking).  It will also enable Debian to recompile entire
1540 distributions quickly.
1541
1542
1543         <sect1 id="dpkg-cross">
1544           <heading><package>dpkg-cross</package>
1545           <p>
1546 <package>dpkg-cross</package> is a tool for installing libraries and
1547 headers for cross-compiling in a way similar to
1548 <package>dpkg</package>. Furthermore, the functionality of
1549 <prgn>dpkg-buildpackage</prgn> and <prgn>dpkg-shlibdeps</prgn> is
1550 enhanced to support cross-compiling.
1551
1552
1553
1554
1555     <chapt id="archive-manip">
1556       <heading>Moving, Removing, Renaming, Adopting, and Orphaning
1557       Packages</heading>
1558       <p>
1559 Some archive manipulation operation are not automated in the Debian
1560 upload process.  These procedures should be manually followed by
1561 maintainers.  This chapter gives guidelines in what to do in these
1562 cases.
1563
1564       <sect>Moving packages
1565         <p>
1566 Sometimes a package will change either its section.  For instance, a
1567 package from the `non-free' section might be GPL'd in a later version,
1568 in which case, the package should be moved to `main' or
1569 `contrib'.<footnote> See the <url id="&url-debian-policy;"
1570 name="Debian Policy Manual"> for guidelines on what section a package
1571 belongs in.
1572           </footnote>
1573         <p>
1574 If you need to change the section for one of your packages, change the
1575 package control information to place the package in the desired
1576 section, and re-upload the package (see the <url id="&url-pkg-manual;"
1577 name="Debian Packaging Manual"> for details).  Carefully examine the
1578 installation log sent to you when the package is installed into the
1579 archive.  If for some reason the old location of the package remains,
1580 file a bug against <tt>ftp.debian.org</tt> asking that the old
1581 location be removed.  Give details on what you did, since it might be
1582 a <prgn>dinstall</prgn> bug.
1583         <p>
1584 If, on the other hand, you need to change the <em>subsection</em> of
1585 one of your packages (e.g., ``devel'', ``admin''), the procedure is
1586 slightly different.  Correct the subsection as found in the control
1587 file of the package, and reupload that.  Also, you'll need to update
1588 the override file, as described in <ref id="override-file">.
1589
1590
1591       <sect id="removing-pkgs">Removing packages
1592         <p>
1593 If for some reason you want to completely remove a package (say, if it
1594 is an old compatibility library which is not longer required), you
1595 need to file a bug against <tt>ftp.debian.org</tt> asking that the
1596 package be removed.  Make sure you indicate which distribution the
1597 package should be removed from.
1598         <p>
1599 If in doubt concerning whether a package is disposable, email
1600 &email-debian-devel; asking for opinions.  Also of interest is the
1601 <prgn>apt-cache</prgn> program from the <package>apt</package>
1602 package.  When invoked as <tt>apt-cache showpkg
1603 <var>package</var></tt>, the program will show details for
1604 <var>package</var>, including reverse depends.
1605
1606         <sect1>Removing packages from <tt>Incoming</tt>
1607           <p>
1608 If you decide to remove a package from <tt>Incoming</tt>, it is nice
1609 but not required to send a notification of that to the appropriate
1610 announce list (either &email-debian-changes; or
1611 &email-debian-devel-changes;).
1612
1613       <sect>Replacing or renaming packages
1614         <p>
1615 Sometimes you made a mistake naming the package and you need to rename
1616 it.  In this case, you need to follow a two-step process.  First, set
1617 your <file>debian/control</file> file to replace and conflict with the
1618 obsolete name of the package (see the <url id="&url-pkg-manual;"
1619 name="Debian Packaging Manual"> for details).  Once you've uploaded
1620 that package, and the package has moved into the archive, file a bug
1621 against <tt>ftp.debian.org</tt> asking to remove the package with the
1622 obsolete name.
1623
1624
1625
1626       <sect id="orphaning">Orphaning a package
1627         <p>
1628 If you can no longer maintain a package, then you should set the
1629 package maintainer to <tt>Debian QA Group
1630 &lt;debian-qa@lists.debian.org&gt;</tt> and email &email-wnpp;
1631 indicating that the package is now orphaned.  If the package is
1632 especially crucial to Debian, you should instead email
1633 &email-debian-devel; asking for a new maintainer.
1634
1635
1636       <sect id="adopting">Adopting a package
1637         <p>
1638 Periodically, a listing of packages in need of new maintainers will be
1639 sent to &email-debian-devel list. This list is also available at in
1640 the Work-Needing and Prospective Packages document (WNPP), <url
1641 id="&url-wnpp;">.  If you wish to take over maintenance of any of the
1642 packages listed in the WNPP, or if you can no longer maintain a
1643 packages you have, or you simply want to know if any one is working on
1644 a new package, send a message to &email-wnpp;.
1645         <p>
1646 It is not OK to simply take over a package that you feel is neglected
1647 -- that would be package hijacking.  You can, of course, contact the
1648 current maintainer and ask them if you may take over the package.
1649 However, without their assent, you may not take over the package.
1650 Even if they ignore you, that is still not grounds to take over a
1651 package.  If you really feel that a maintainer has gone AWOL (absent
1652 without leave), post a query to &email-debian-private;.
1653         <p>
1654 If you take over an old package, you probably want to be listed as the
1655 package's official maintainer in the bug system. This will happen
1656 automatically once you upload a new version with an updated
1657 <tt>Maintainer:</tt> field, although it can take a couple of weeks. If
1658 you do not expect to upload a new version for a while, send an email
1659 to &email-override; so that bug reports will go to you right away.
1660
1661
1662
1663
1664     <chapt id="bug-handling">Handling Bugs
1665
1666       <sect>Monitoring bugs
1667         <p>
1668 If you want to be a good maintainer, you should periodically check the
1669 <url id="&url-bts;" name="Debian bug tracking system (BTS)"> for your
1670 packages.  The BTS contains all the open bugs against your packages.
1671         <p>
1672 Maintainers interact with the BTS via email addresses at
1673 <tt>bugs.debian.org</tt>.  Documentation on available commands can be
1674 found at <url id="http://www.debian.org/Bugs/">, or, if you have
1675 installed the <package>debian-doc</package> package, you can look at
1676 the local files <file>/usr/doc/debian/bug-*</file>.
1677         <p>
1678 Some find it useful to get periodic reports on open bugs.  You can add
1679 a cron job such as the following if you want to get a weekly email
1680 outlining all the open bugs against your packages:
1681 <example>
1682 # ask for weekly reports of bugs in my packages
1683 0 17 * * fri   echo "index maint <var>maintainer-address</var>" | mail request@bugs.debian.org
1684 </example>
1685 Replace <var>maintainer-address</var> with you official Debian
1686 maintainer address.
1687
1688       <sect id="submit-bug">Submitting Bugs
1689         <p>
1690 Often as a package maintainer, you find bugs in other packages or else
1691 have bugs reported to your packages which need to be reassigned.  The
1692 <url id="&url-bts-control;" name="BTS instructions"> can tell you how
1693 to do this.
1694         <p>
1695 We encourage you to file bugs when there are problems.  Try to submit
1696 the bug from a normal user account at which you are likely to receive
1697 mail.  Do not submit bugs as root.
1698         <p>
1699 Make sure the bug is not already filed against a package.  Try to do a
1700 good job reporting a bug and redirecting it to the proper location.
1701 For extra credit, you can go through other packages, merging bugs
1702 which are reported more than once, or setting bug severities to
1703 `fixed' when they have already been fixed.  Note that when you are
1704 neither the bug submitter nor the package maintainer, you are should
1705 not actually close the bug (unless you secure permission from the
1706 maintainer).
1707
1708       <sect>Responding to Bugs
1709         <p>
1710 Make sure that any discussions you have about bugs are sent both to
1711 the original submitter of the bug, and the bug itself (e.g.,
1712 <email>123@bugs.debian.org</email>).
1713         <p>
1714 You should <em>never</em> close bugs via the bug server `close'
1715 command sent to &email-bts-control;.  If you do so, the original
1716 submitter will not receive any feedback on why the bug was closed.
1717
1718       <sect id="upload-bugfix">When bugs are closed by new uploads
1719         <p>
1720 If you fix a bug in your packages, it is your responsibility as the
1721 package maintainer to close the bug when it has been fixed.  However,
1722 you should not close the bug until the package which fixes the bug has
1723 been accepted into the Debian archive.  Therefore, once you get
1724 notification that your updated package has been installed into the
1725 archive, you can and should close the bug in the BTS.
1726         <p>
1727 If you are using a new version of <package>dpkg-dev</package> and you
1728 do your changelog entry properly, <prgn>dinstall</prgn> will close the
1729 bugs automatically.  All you have to do is follow a certain syntax
1730 in your <file>debian/changelog</file> file:
1731 <example>
1732 acme-cannon (3.1415) unstable; urgency=low
1733
1734   * Frobbed with options (closes: Bug#98339)
1735   * Added safety to prevent operator dismemberment, closes: bug #98765,
1736     bug #98713, #98714.
1737   * Added manpage. closes: #98725.
1738 </example>
1739
1740 Technically speaking, the following Perl regular expression is what is
1741 used:
1742 <example>
1743   /closes:\s*(bug)?\#\d+(,\s*(bug)?\#\d+)*/gi
1744 </example>
1745
1746 The author prefers the <tt>(closes: Bug#<var>XXX</var>)</tt> syntax,
1747 since it stands out from the rest of the changelog entries.
1748         <p>
1749 If you want to close bugs the old fashioned, manual way, it is usually
1750 sufficient to mail the <tt>.changes</tt> file to
1751 <email>XXX-done@bugs.debian.org</email>, where <var>XXX</var> is your
1752 bug number.
1753
1754
1755       <sect id="lintian-reports">Lintian reports
1756         <p>
1757 You should periodically get the new <package>lintian</package> from
1758 `unstable' and check over all your packages.  Alternatively you can
1759 check for your maintainer email address at the <url id="&url-lintian;"
1760 name="online lintian report">.  That report, which is updated
1761 automatically, contains <prgn>lintian</prgn> reports against the
1762 latest version of the distribution (usually from 'unstable') using the
1763 latest <package>lintian</package>.
1764
1765
1766       <sect>Reporting lots of bugs at once
1767         <p>
1768 Reporting a great number of bugs for the same problem on a great
1769 number of different packages -- i.e., more than 10 -- is a deprecated
1770 practice.  Take all possible steps to avoid submitting bulk bugs at
1771 all.  For instance, if checking for the problem can be automated, add
1772 a new check to <package>lintian</package> so that an error or warning
1773 is emitted.
1774         <p>
1775 If you report more than 10 bugs on the same topic at once, it is
1776 recommended that you send a message to &email-debian-devel; describing
1777 your intention before submitting the report. This will allow other
1778 developers to verify that the bug is a real problem. In addition, it
1779 will help prevent a situation in which several maintainers start
1780 filing the same bug report simultaneously.
1781         <p>
1782 Note that when sending lots of bugs on the same subject, you should
1783 send the bug report to <email>maintonly@bugs.debian.org</email> so
1784 that the bug report is not forwarded to the bug distribution mailing
1785 list.
1786
1787
1788     <chapt id="tools">Overview of Debian Maintainer Tools
1789       <p>
1790 This section contains a rough overview of the tools available to
1791 maintainers.  These tools are meant to help convenience developers and 
1792 free their time for critical tasks.  
1793       <p>
1794 Some people prefer to use high-level package maintenance tools and
1795 some do not.  Debian is officially agnostic on this issue; any tool
1796 which gets the job done is fine.  Therefore, this section is not meant
1797 to stipulate to anyone which tools they should use or how they should
1798 go about with their duties of maintainership.  Nor is it meant to
1799 endorse any particular tool to the exclusion of a competing tool.
1800       <p>
1801 Most of the descriptions of these packages come from the actual
1802 package descriptions themselves.  Further information can be found in
1803 the package documentation itself.
1804
1805
1806       <sect id="dpkg-dev">
1807         <heading><package>dpkg-dev</package>
1808         <p>
1809 <package>dpkg-dev</package> contains the tools (including
1810 <prgn>dpkg-source</prgn>) required to unpack, build and upload Debian
1811 source packages.  These utilities contain the fundamental, low-level
1812 functionality required to create and manipulated packages; as such,
1813 they are required for any Debian maintainer.
1814
1815
1816       <sect id="lintian">
1817         <heading><package>lintian</package>
1818         <p>
1819 <package>Lintian</package> dissects Debian packages and reports bugs
1820 and policy violations. It contains automated checks for many aspects
1821 of Debian policy as well as some checks for common errors.  The use of
1822 <package>lintian</package> has already been discussed in <ref
1823 id="upload-checking"> and <ref id="lintian-reports">.
1824
1825
1826       <sect id="debhelper">
1827         <heading><package>debhelper</package>
1828         <p>
1829 <package>debhelper</package> is a collection of programs that can be
1830 used in <file>debian/rules</file> to automate common tasks related to
1831 building binary Debian packages. Programs are included to install
1832 various files into your package, compress files, fix file permissions,
1833 integrate your package with the Debian menu system.
1834         <p>
1835 Unlike <package>debmake</package>, <package>debhelper</package> is
1836 broken into several small, granular commands which act in a consistent
1837 manner.  As such, it allows a greater granularity of control than
1838 <package>debmake</package>.
1839
1840
1841       <sect id="debmake">
1842         <heading><package>debmake</package>
1843         <p>
1844 <package>debmake</package>, a pre-cursor to
1845 <package>debhelper</package>, is a less granular
1846 <file>debian/rules</file> assistant. It includes two main programs:
1847 <prgn>deb-make</prgn>, which can be used to help a maintainer convert
1848 a regular (non-Debian) source archive into a Debian source package;
1849 and <prgn>debstd</prgn>, which incorporates in one big shot the same
1850 sort of automated functions that one finds in
1851 <package>debhelper</package>.
1852         <p>
1853 The consensus is that <package>debmake</package> is now deprecated in
1854 favor of <package>debhelper</package>.  However, it's not a bug to use
1855 <package>debmake</package>.
1856
1857       <sect id="yada">
1858         <heading><package>yada</package>
1859         <p>
1860 <package>yada</package> is a new packaging helper tool with a slightly
1861 different philosophy.  It uses a <file>debian/packages</file> file to
1862 auto-generate other necessary files in the <file>debian/</file>
1863 subdirectory.
1864         <p>
1865 Note that <package>yada</package> is still quite new and possibly not
1866 yet as robust as other systems.
1867
1868
1869       <sect id="equivs">
1870         <heading><package>equivs</package>
1871         <p>
1872 <package>equivs</package> is another package for making packages.  It
1873 is often suggested for local use if you need to make a package simply
1874 to fulfill dependancies.  It is also sometimes used when making
1875 ``meta-packages'', which are packages whose only purpose is to depend
1876 on other packages.
1877
1878
1879       <sect id="cvs-buildpackage">
1880         <heading><package>cvs-buildpackage</package>
1881         <p>
1882 <package>cvs-buildpackage</package> provides the capability to inject
1883 or import Debian source packages into a CVS repository, build a Debian
1884 package from the CVS repository, and helps in integrating upstream
1885 changes into the repository.
1886         <p>
1887 These utilities provide an infrastructure to facilitate the use of CVS
1888 by Debian maintainers. This allows one to keep separate CVS branches
1889 of a package for <em>stable</em>, <em>unstable</em>, and possibly
1890 <em>experimental</em> distributions, along with the other benefits of
1891 a version control system.
1892
1893
1894       <sect id="dupload">
1895         <heading><package>dupload</package>
1896         <p>
1897 <package>dupload</package> is a package and a script to automagically
1898 upload Debian packages to the Debian archive, to log the upload, and
1899 to send mail about the upload of a package.  You can configure it for
1900 new upload locations or methods.
1901
1902
1903       <sect id="fakeroot">
1904         <heading><package>fakeroot</package>
1905         <p>
1906 <package>fakeroot</package> simulates root privileges.  This enables
1907 you to build packages without being root (packages usually want to
1908 install files with root ownership).  If you have
1909 <package>fakeroot</package> installed, you can say, i.e.,
1910 <tt>dpkg-buildpackage -rfakeroot</tt> as a user.
1911
1912
1913       <sect id="devscripts">
1914         <heading><package>devscripts</package>
1915         <p>
1916 <package>devscripts</package> is a package containing a few wrappers
1917 and tools which you may find helpful for maintaining your Debian
1918 packages.  Example scripts include <prgn>debchange</prgn>, which will
1919 manipulate your <file>debian/changelog</file> file from the
1920 command-line, and <prgn>debuild</prgn>, which is a wrapper around
1921 <prgn>dpkg-buildpackage</prgn>.
1922
1923
1924       <sect id="debget">
1925         <heading><package>debget</package>
1926         <p>
1927 <package>debget</package> is a package containing a convenient script
1928 which can be helpful in downloading files from the Debian archive.
1929 You can use it to download source packages, for instance.
1930
1931
1932
1933   </book>
1934 </debiandoc>
1935
1936 <!-- Keep this comment at the end of the file
1937 Local variables:
1938 mode: sgml
1939 sgml-omittag:t
1940 sgml-shorttag:t
1941 sgml-minimize-attributes:nil
1942 sgml-always-quote-attributes:t
1943 sgml-indent-step:2
1944 sgml-indent-data:nil
1945 sgml-parent-document:nil
1946 sgml-exposed-tags:nil
1947 sgml-declaration:nil
1948 sgml-local-catalogs:nil
1949 sgml-local-ecat-files:nil
1950 End:
1951 -->