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