chiark / gitweb /
First files for developers-reference in DocBook XML
[developers-reference.git] / pkgs.dbk
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3     "">
4 <chapter id="pkgs">
5 <title>Managing Packages</title>
6 <para>
7 This chapter contains information related to creating, uploading, maintaining,
8 and porting packages.
9 </para>
10 <section id="newpackage">
11 <title>New packages</title>
12 <para>
13 If you want to create a new package for the Debian distribution, you should
14 first check the <ulink url="">Work-Needing and
15 Prospective Packages (WNPP)</ulink> list.  Checking the WNPP list ensures that
16 no one is already working on packaging that software, and that effort is not
17 duplicated.  Read the <ulink url="">WNPP web
18 pages</ulink> for more information.
19 </para>
20 <para>
21 Assuming no one else is already working on your prospective package, you must
22 then submit a bug report (<xref linkend="submit-bug"/> ) against the
23 pseudo-package <systemitem role="package">wnpp</systemitem> describing your
24 plan to create a new package, including, but not limiting yourself to, a
25 description of the package, the license of the prospective package, and the
26 current URL where it can be downloaded from.
27 </para>
28 <para>
29 You should set the subject of the bug to ``ITP: <replaceable>foo</replaceable>
30 -- <replaceable>short description</replaceable>'', substituting the name of the
31 new package for <replaceable>foo</replaceable>.  The severity of the bug report
32 must be set to <emphasis>wishlist</emphasis>.  If you feel it's necessary, send
33 a copy to <email></email> by putting the address
34 in the <literal>X-Debbugs-CC:</literal> header of the message (no, don't use
35 <literal>CC:</literal>, because that way the message's subject won't indicate
36 the bug number).
37 </para>
38 <para>
39 Please include a <literal>Closes:
40 bug#<replaceable>nnnnn</replaceable></literal> entry in the changelog of the
41 new package in order for the bug report to be automatically closed once the new
42 package is installed in the archive (see <xref linkend="upload-bugfix"/> ).
43 </para>
44 <para>
45 When closing security bugs include CVE numbers as well as the Closes: #nnnnn.
46 This is useful for the security team to track vulnerabilities.  If an upload is
47 made to fix the bug before the advisory ID is known, it is encouraged to modify
48 the historical changelog entry with the next upload.  Even in this case, please
49 include all available pointers to background information in the original
50 changelog entry.
51 </para>
52 <para>
53 There are a number of reasons why we ask maintainers to announce their
54 intentions:
55 </para>
56 <itemizedlist>
57 <listitem>
58 <para>
59 It helps the (potentially new) maintainer to tap into the experience of people
60 on the list, and lets them know if anyone else is working on it already.
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 It lets other people thinking about working on the package know that there
66 already is a volunteer, so efforts may be shared.
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 It lets the rest of the maintainers know more about the package than the one
72 line description and the usual changelog entry ``Initial release'' that gets
73 posted to <literal>debian-devel-changes</literal>.
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 It is helpful to the people who live off unstable (and form our first line of
79 testers).  We should encourage these people.
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 The announcements give maintainers and other interested parties a better feel
85 of what is going on, and what is new, in the project.
86 </para>
87 </listitem>
88 </itemizedlist>
89 <para>
90 Please see <ulink url=""></ulink>
91 for common rejection reasons for a new package.
92 </para>
93 </section>
95 <section id="changelog-entries">
96 <title>Recording changes in the package</title>
97 <para>
98 Changes that you make to the package need to be recorded in the
99 <filename>debian/changelog</filename>.  These changes should provide a concise
100 description of what was changed, why (if it's in doubt), and note if any bugs
101 were closed.  They also record when the package was completed.  This file will
102 be installed in
103 <filename>/usr/share/doc/<replaceable>package</replaceable>/changelog.Debian.gz</filename>,
104 or
105 <filename>/usr/share/doc/<replaceable>package</replaceable>/changelog.gz</filename>
106 for native packages.
107 </para>
108 <para>
109 The <filename>debian/changelog</filename> file conforms to a certain structure,
110 with a number of different fields.  One field of note, the
111 <emphasis>distribution</emphasis>, is described in <xref
112 linkend="distribution"/> .  More information about the structure of this file
113 can be found in the Debian Policy section titled
114 <filename>debian/changelog</filename>.
115 </para>
116 <para>
117 Changelog entries can be used to automatically close Debian bugs when the
118 package is installed into the archive.  See <xref linkend="upload-bugfix"/> .
119 </para>
120 <para>
121 It is conventional that the changelog entry of a package that contains a new
122 upstream version of the software looks like this:
123 </para>
124 <screen>
125   * new upstream version
126 </screen>
127 <para>
128 There are tools to help you create entries and finalize the
129 <filename>changelog</filename> for release — see <xref linkend="devscripts"/>
130 and <xref linkend="dpkg-dev-el"/> .
131 </para>
132 <para>
133 See also <xref linkend="bpp-debian-changelog"/> .
134 </para>
135 </section>
137 <section id="sanitycheck">
138 <title>Testing the package</title>
139 <para>
140 Before you upload your package, you should do basic testing on it.  At a
141 minimum, you should try the following activities (you'll need to have an older
142 version of the same Debian package around):
143 </para>
144 <itemizedlist>
145 <listitem>
146 <para>
147 Install the package and make sure the software works, or upgrade the package
148 from an older version to your new version if a Debian package for it already
149 exists.
150 </para>
151 </listitem>
152 <listitem>
153 <para>
154 Run <command>lintian</command> over the package.  You can run
155 <command>lintian</command> as follows: <literal>lintian -v
156 <replaceable>package-version</replaceable>.changes</literal>.  This will check
157 the source package as well as the binary package.  If you don't understand the
158 output that <command>lintian</command> generates, try adding the
159 <literal>-i</literal> switch, which will cause <command>lintian</command> to
160 output a very verbose description of the problem.
161 </para>
162 <para>
163 Normally, a package should <emphasis>not</emphasis> be uploaded if it causes
164 lintian to emit errors (they will start with <literal>E</literal>).
165 </para>
166 <para>
167 For more information on <command>lintian</command>, see <xref
168 linkend="lintian"/> .
169 </para>
170 </listitem>
171 <listitem>
172 <para>
173 Optionally run <xref linkend="debdiff"/> to analyze changes from an older
174 version, if one exists.
175 </para>
176 </listitem>
177 <listitem>
178 <para>
179 Downgrade the package to the previous version (if one exists) — this tests
180 the <filename>postrm</filename> and <filename>prerm</filename> scripts.
181 </para>
182 </listitem>
183 <listitem>
184 <para>
185 Remove the package, then reinstall it.
186 </para>
187 </listitem>
188 <listitem>
189 <para>
190 Copy the source package in a different directory and try unpacking it and
191 rebuilding it.  This tests if the package relies on existing files outside of
192 it, or if it relies on permissions being preserved on the files shipped inside
193 the .diff.gz file.
194 </para>
195 </listitem>
196 </itemizedlist>
197 </section>
199 <section id="sourcelayout">
200 <title>Layout of the source package</title>
201 <para>
202 There are two types of Debian source packages:
203 </para>
204 <itemizedlist>
205 <listitem>
206 <para>
207 the so-called <emphasis>native</emphasis> packages, where there is no
208 distinction between the original sources and the patches applied for Debian
209 </para>
210 </listitem>
211 <listitem>
212 <para>
213 the (more common) packages where there's an original source tarball file
214 accompanied by another file that contains the patches applied for Debian
215 </para>
216 </listitem>
217 </itemizedlist>
218 <para>
219 For the native packages, the source package includes a Debian source control
220 file (<literal>.dsc</literal>) and the source tarball
221 (<literal>.tar.gz</literal>).  A source package of a non-native package
222 includes a Debian source control file, the original source tarball
223 (<literal>.orig.tar.gz</literal>) and the Debian patches
224 (<literal>.diff.gz</literal>).
225 </para>
226 <para>
227 Whether a package is native or not is determined when it is built by
228 <citerefentry> <refentrytitle>dpkg-buildpackage</refentrytitle>
229 <manvolnum>1</manvolnum> </citerefentry>.  The rest of this section relates
230 only to non-native packages.
231 </para>
232 <para>
233 The first time a version is uploaded which corresponds to a particular upstream
234 version, the original source tar file should be uploaded and included in the
235 <filename>.changes</filename> file.  Subsequently, this very same tar file
236 should be used to build the new diffs and <filename>.dsc</filename> files, and
237 will not need to be re-uploaded.
238 </para>
239 <para>
240 By default, <command>dpkg-genchanges</command> and
241 <command>dpkg-buildpackage</command> will include the original source tar file
242 if and only if the Debian revision part of the source version number is 0 or 1,
243 indicating a new upstream version.  This behavior may be modified by using
244 <literal>-sa</literal> to always include it or <literal>-sd</literal> to always
245 leave it out.
246 </para>
247 <para>
248 If no original source is included in the upload, the original source tar-file
249 used by <command>dpkg-source</command> when constructing the
250 <filename>.dsc</filename> file and diff to be uploaded
251 <emphasis>must</emphasis> be byte-for-byte identical with the one already in
252 the archive.
253 </para>
254 <para>
255 Please notice that, in non-native packages, permissions on files that are not
256 present in the .orig.tar.gz will not be preserved, as diff does not store file
257 permissions in the patch.
258 </para>
259 </section>
261 <section id="distribution">
262 <title>Picking a distribution</title>
263 <para>
264 Each upload needs to specify which distribution the package is intended for.
265 The package build process extracts this information from the first line of the
266 <filename>debian/changelog</filename> file and places it in the
267 <literal>Distribution</literal> field of the <literal>.changes</literal> file.
268 </para>
269 <para>
270 There are several possible values for this field: `stable', `unstable',
271 `testing-proposed-updates' and `experimental'.  Normally, packages are uploaded
272 into <emphasis>unstable</emphasis>.
273 </para>
274 <para>
275 Actually, there are two other possible distributions: `stable-security' and
276 `testing-security', but read <xref linkend="bug-security"/> for more
277 information on those.
278 </para>
279 <para>
280 It is not possible to upload a package into several distributions at the same
281 time.
282 </para>
283 <section id="upload-stable">
284 <title>Special case: uploads to the <emphasis>stable</emphasis> distribution</title>
285 <para>
286 Uploading to <emphasis>stable</emphasis> means that the package will transfered
287 to the <emphasis>p-u-new</emphasis>-queue for review by the stable release
288 managers, and if approved will be installed in
289 <filename>stable-proposed-updates</filename> directory of the Debian archive.
290 From there, it will be included in <emphasis>stable</emphasis> with the next
291 point release.
292 </para>
293 <para>
294 Extra care should be taken when uploading to <emphasis>stable</emphasis>.
295 Basically, a package should only be uploaded to stable if one of the following
296 happens:
297 </para>
298 <itemizedlist>
299 <listitem>
300 <para>
301 a truly critical functionality problem
302 </para>
303 </listitem>
304 <listitem>
305 <para>
306 the package becomes uninstallable
307 </para>
308 </listitem>
309 <listitem>
310 <para>
311 a released architecture lacks the package
312 </para>
313 </listitem>
314 </itemizedlist>
315 <para>
316 In the past, uploads to <emphasis>stable</emphasis> were used to address
317 security problems as well.  However, this practice is deprecated, as uploads
318 used for Debian security advisories are automatically copied to the appropriate
319 <filename>proposed-updates</filename> archive when the advisory is released.
320 See <xref linkend="bug-security"/> for detailed information on handling
321 security problems.
322 </para>
323 <para>
324 Changing anything else in the package that isn't important is discouraged,
325 because even trivial fixes can cause bugs later on.
326 </para>
327 <para>
328 Packages uploaded to <emphasis>stable</emphasis> need to be compiled on systems
329 running <emphasis>stable</emphasis>, so that their dependencies are limited to
330 the libraries (and other packages) available in <emphasis>stable</emphasis>;
331 for example, a package uploaded to <emphasis>stable</emphasis> that depends on
332 a library package that only exists in unstable will be rejected.  Making
333 changes to dependencies of other packages (by messing with
334 <literal>Provides</literal> or shlibs files), possibly making those other
335 packages uninstallable, is strongly discouraged.
336 </para>
337 <para>
338 The Release Team (which can be reached at
339 <email></email>) will regularly evaluate the
340 uploads To <emphasis>stable-proposed-updates</emphasis> and decide if your
341 package can be included in <emphasis>stable</emphasis>.  Please be clear (and
342 verbose, if necessary) in your changelog entries for uploads to
343 <emphasis>stable</emphasis>, because otherwise the package won't be considered
344 for inclusion.
345 </para>
346 <para>
347 It's best practice to speak with the stable release manager
348 <emphasis>before</emphasis> uploading to
349 <emphasis>stable</emphasis>/<emphasis>stable-proposed-updates</emphasis>, so
350 that the uploaded package fits the needs of the next point release.
351 </para>
352 </section>
354 <section id="upload-t-p-u">
355 <title>Special case: uploads to <emphasis>testing/testing-proposed-updates</emphasis></title>
356 <para>
357 Please see the information in the <link linkend="t-p-u">testing
358 section</link> for details.
359 </para>
360 </section>
362 </section>
364 <section id="upload">
365 <title>Uploading a package</title>
366 <section id="upload-ftp-master">
367 <title>Uploading to <literal>ftp-master</literal></title>
368 <para>
369 To upload a package, you should upload the files (including the signed changes
370 and dsc-file) with anonymous ftp to <literal></literal> in
371 the directory <ulink
372 url="">/pub/UploadQueue/</ulink>.
373 To get the files processed there, they need to be signed with a key in the
374 debian keyring.
375 </para>
376 <para>
377 Please note that you should transfer the changes file last.  Otherwise, your
378 upload may be rejected because the archive maintenance software will parse the
379 changes file and see that not all files have been uploaded.
380 </para>
381 <para>
382 You may also find the Debian packages <xref linkend="dupload"/> or <xref
383 linkend="dput"/> useful when uploading packages.  These handy programs help
384 automate the process of uploading packages into Debian.
385 </para>
386 <para>
387 For removing packages, please see the README file in that ftp directory, and
388 the Debian package <xref linkend="dcut"/> .
389 </para>
390 </section>
392 <section id="upload-non-us">
393 <title>Uploading to <literal>non-US</literal></title>
394 <para>
395 <emphasis>Note:</emphasis> non-us was discontinued with the release of sarge.
396 </para>
397 </section>
399 <section id="delayed-incoming">
400 <title>Delayed uploads</title>
401 <para>
402 Delayed uploads are done for the moment via the delayed queue at gluck.  The
403 upload-directory is <literal>gluck:~tfheen/DELAYED/[012345678]-day</literal>.
404 0-day is uploaded multiple times per day to ftp-master.
405 </para>
406 <para>
407 With a fairly recent dput, this section
408 </para>
409 <screen>
410 [tfheen_delayed]
411 method = scp
412 fqdn =
413 incoming = ~tfheen
414 </screen>
415 <para>
416 in ~/ should work fine for uploading to the DELAYED queue.
417 </para>
418 <para>
419 <emphasis>Note:</emphasis> Since this upload queue goes to
420 <literal>ftp-master</literal>, the prescription found in <xref
421 linkend="upload-ftp-master"/> applies here as well.
422 </para>
423 </section>
425 <section id="s5.6.4">
426 <title>Security uploads</title>
427 <para>
428 Do <emphasis role="strong">NOT</emphasis> upload a package to the security
429 upload queue (oldstable-security, stable-security, etc.) without prior
430 authorization from the security team.  If the package does not exactly meet the
431 team's requirements, it will cause many problems and delays in dealing with the
432 unwanted upload.  For details, please see section <xref
433 linkend="bug-security"/> .
434 </para>
435 </section>
437 <section id="s5.6.5">
438 <title>Other upload queues</title>
439 <para>
440 The scp queues on ftp-master, and security are mostly unusable due to the login
441 restrictions on those hosts.
442 </para>
443 <para>
444 The anonymous queues on and are currently
445 down.  Work is underway to resurrect them.
446 </para>
447 <para>
448 The queues on,,, and
449 are down permanently, and will not be resurrected.
450 The queue in Japan will be replaced with a new queue on some
451 day.
452 </para>
453 <para>
454 For the time being, the anonymous ftp queue on (the former
455 ftp-master) works, but it is deprecated and will be removed at some point in
456 the future.
457 </para>
458 </section>
460 <section id="upload-notification">
461 <title>Notification that a new package has been installed</title>
462 <para>
463 The Debian archive maintainers are responsible for handling package uploads.
464 For the most part, uploads are automatically handled on a daily basis by the
465 archive maintenance tools, <command>katie</command>.  Specifically, updates to
466 existing packages to the `unstable' distribution are handled automatically.  In
467 other cases, notably new packages, placing the uploaded package into the
468 distribution is handled manually.  When uploads are handled manually, the
469 change to the archive may take up to a month to occur.  Please be patient.
470 </para>
471 <para>
472 In any case, you will receive an email notification indicating that the package
473 has been added to the archive, which also indicates which bugs will be closed
474 by the upload.  Please examine this notification carefully, checking if any
475 bugs you meant to close didn't get triggered.
476 </para>
477 <para>
478 The installation notification also includes information on what section the
479 package was inserted into.  If there is a disparity, you will receive a
480 separate email notifying you of that.  Read on below.
481 </para>
482 <para>
483 Note that if you upload via queues, the queue daemon software will also send
484 you a notification by email.
485 </para>
486 </section>
488 </section>
490 <section id="override-file">
491 <title>Specifying the package section, subsection and priority</title>
492 <para>
493 The <filename>debian/control</filename> file's <literal>Section</literal> and
494 <literal>Priority</literal> fields do not actually specify where the file will
495 be placed in the archive, nor its priority.  In order to retain the overall
496 integrity of the archive, it is the archive maintainers who have control over
497 these fields.  The values in the <filename>debian/control</filename> file are
498 actually just hints.
499 </para>
500 <para>
501 The archive maintainers keep track of the canonical sections and priorities for
502 packages in the <emphasis>override file</emphasis>.  If there is a disparity
503 between the <emphasis>override file</emphasis> and the package's fields as
504 indicated in <filename>debian/control</filename>, then you will receive an
505 email noting the divergence when the package is installed into the archive.
506 You can either correct your <filename>debian/control</filename> file for your
507 next upload, or else you may wish to make a change in the <emphasis>override
508 file</emphasis>.
509 </para>
510 <para>
511 To alter the actual section that a package is put in, you need to first make
512 sure that the <filename>debian/control</filename> file in your package is
513 accurate.  Next, send an email <email></email> or
514 submit a bug against <systemitem role="package"></systemitem>
515 requesting that the section or priority for your package be changed from the
516 old section or priority to the new one.  Be sure to explain your reasoning.
517 </para>
518 <para>
519 For more information about <emphasis>override files</emphasis>, see
520 <citerefentry> <refentrytitle>dpkg-scanpackages</refentrytitle>
521 <manvolnum>1</manvolnum> </citerefentry> and <ulink
522 url=""></ulink>.
523 </para>
524 <para>
525 Note that the <literal>Section</literal> field describes both the section as
526 well as the subsection, which are described in <xref
527 linkend="archive-sections"/> .  If the section is main, it should be omitted.
528 The list of allowable subsections can be found in <ulink
529 url=""></ulink>.
530 </para>
531 </section>
533 <section id="bug-handling">
534 <title>Handling bugs</title>
535 <para>
536 Every developer has to be able to work with the Debian <ulink
537 url="">bug tracking system</ulink>.  This includes
538 knowing how to file bug reports properly (see <xref linkend="submit-bug"/> ),
539 how to update them and reorder them, and how to process and close them.
540 </para>
541 <para>
542 The bug tracking system's features are described in the <ulink
543 url="">BTS documentation for
544 developers</ulink>.  This includes closing bugs, sending followup messages,
545 assigning severities and tags, marking bugs as forwarded, and other issues.
546 </para>
547 <para>
548 Operations such as reassigning bugs to other packages, merging separate bug
549 reports about the same issue, or reopening bugs when they are prematurely
550 closed, are handled using the so-called control mail server.  All of the
551 commands available on this server are described in the <ulink
552 url="">BTS control server
553 documentation</ulink>.
554 </para>
555 <section id="bug-monitoring">
556 <title>Monitoring bugs</title>
557 <para>
558 If you want to be a good maintainer, you should periodically check the <ulink
559 url="">Debian bug tracking system (BTS)</ulink> for
560 your packages.  The BTS contains all the open bugs against your packages.  You
561 can check them by browsing this page:
562 <literal><replaceable>yourlogin</replaceable></literal>.
563 </para>
564 <para>
565 Maintainers interact with the BTS via email addresses at
566 <literal></literal>.  Documentation on available commands can be
567 found at <ulink url=""></ulink>, or, if you have
568 installed the <systemitem role="package">doc-debian</systemitem> package, you
569 can look at the local files <filename>/usr/share/doc/debian/bug-*</filename>.
570 </para>
571 <para>
572 Some find it useful to get periodic reports on open bugs.  You can add a cron
573 job such as the following if you want to get a weekly email outlining all the
574 open bugs against your packages:
575 </para>
576 <screen>
577 # ask for weekly reports of bugs in my packages
578 0 17 * * fri   echo index maint <replaceable>address</replaceable> | mail
579 </screen>
580 <para>
581 Replace <replaceable>address</replaceable> with your official Debian maintainer
582 address.
583 </para>
584 </section>
586 <section id="bug-answering">
587 <title>Responding to bugs</title>
588 <para>
589 When responding to bugs, make sure that any discussion you have about bugs is
590 sent both to the original submitter of the bug, and to the bug itself (e.g.,
591 <email></email>).  If you're writing a new mail and you
592 don't remember the submitter email address, you can use the
593 <email></email> email to contact the submitter
594 <emphasis>and</emphasis> to record your mail within the bug log (that means you
595 don't need to send a copy of the mail to <email></email>).
596 </para>
597 <para>
598 If you get a bug which mentions FTBFS, this means Fails to build from source.
599 Porters frequently use this acronym.
600 </para>
601 <para>
602 Once you've dealt with a bug report (e.g.  fixed it), mark it as
603 <emphasis>done</emphasis> (close it) by sending an explanation message to
604 <email></email>.  If you're fixing a bug by changing
605 and uploading the package, you can automate bug closing as described in <xref
606 linkend="upload-bugfix"/> .
607 </para>
608 <para>
609 You should <emphasis>never</emphasis> close bugs via the bug server
610 <literal>close</literal> command sent to
611 <email></email>.  If you do so, the original submitter
612 will not receive any information about why the bug was closed.
613 </para>
614 </section>
616 <section id="bug-housekeeping">
617 <title>Bug housekeeping</title>
618 <para>
619 As a package maintainer, you will often find bugs in other packages or have
620 bugs reported against your packages which are actually bugs in other packages.
621 The bug tracking system's features are described in the <ulink
622 url="">BTS documentation for Debian
623 developers</ulink>.  Operations such as reassigning, merging, and tagging bug
624 reports are described in the <ulink
625 url="">BTS control server
626 documentation</ulink>.  This section contains some guidelines for managing your
627 own bugs, based on the collective Debian developer experience.
628 </para>
629 <para>
630 Filing bugs for problems that you find in other packages is one of the civic
631 obligations of maintainership, see <xref linkend="submit-bug"/> for details.
632 However, handling the bugs in your own packages is even more important.
633 </para>
634 <para>
635 Here's a list of steps that you may follow to handle a bug report:
636 </para>
637 <orderedlist numeration="arabic">
638 <listitem>
639 <para>
640 Decide whether the report corresponds to a real bug or not.  Sometimes users
641 are just calling a program in the wrong way because they haven't read the
642 documentation.  If you diagnose this, just close the bug with enough
643 information to let the user correct their problem (give pointers to the good
644 documentation and so on).  If the same report comes up again and again you may
645 ask yourself if the documentation is good enough or if the program shouldn't
646 detect its misuse in order to give an informative error message.  This is an
647 issue that may need to be brought up with the upstream author.
648 </para>
649 <para>
650 If the bug submitter disagrees with your decision to close the bug, they may
651 reopen it until you find an agreement on how to handle it.  If you don't find
652 any, you may want to tag the bug <literal>wontfix</literal> to let people know
653 that the bug exists but that it won't be corrected.  If this situation is
654 unacceptable, you (or the submitter) may want to require a decision of the
655 technical committee by reassigning the bug to <systemitem
656 role="package">tech-ctte</systemitem> (you may use the clone command of the BTS
657 if you wish to keep it reported against your package).  Before doing so, please
658 read the <ulink url="">recommended
659 procedure</ulink>.
660 </para>
661 </listitem>
662 <listitem>
663 <para>
664 If the bug is real but it's caused by another package, just reassign the bug to
665 the right package.  If you don't know which package it should be reassigned to,
666 you should ask for help on <link linkend="irc-channels">IRC</link> or
667 on <email></email>.  Please make sure that the
668 maintainer(s) of the package the bug is reassigned to know why you reassigned
669 it.
670 </para>
671 <para>
672 Sometimes you also have to adjust the severity of the bug so that it matches
673 our definition of the severity.  That's because people tend to inflate the
674 severity of bugs to make sure their bugs are fixed quickly.  Some bugs may even
675 be dropped to wishlist severity when the requested change is just cosmetic.
676 </para>
677 </listitem>
678 <listitem>
679 <para>
680 If the bug is real but the same problem has already been reported by someone
681 else, then the two relevant bug reports should be merged into one using the
682 merge command of the BTS.  In this way, when the bug is fixed, all of the
683 submitters will be informed of this.  (Note, however, that emails sent to one
684 bug report's submitter won't automatically be sent to the other report's
685 submitter.) For more details on the technicalities of the merge command and its
686 relative, the unmerge command, see the BTS control server documentation.
687 </para>
688 </listitem>
689 <listitem>
690 <para>
691 The bug submitter may have forgotten to provide some information, in which case
692 you have to ask them for the required information.  You may use the
693 <literal>moreinfo</literal> tag to mark the bug as such.  Moreover if you can't
694 reproduce the bug, you tag it <literal>unreproducible</literal>.  Anyone who
695 can reproduce the bug is then invited to provide more information on how to
696 reproduce it.  After a few months, if this information has not been sent by
697 someone, the bug may be closed.
698 </para>
699 </listitem>
700 <listitem>
701 <para>
702 If the bug is related to the packaging, you just fix it.  If you are not able
703 to fix it yourself, then tag the bug as <literal>help</literal>.  You can also
704 ask for help on <email></email> or
705 <email></email>.  If it's an upstream problem, you
706 have to forward it to the upstream author.  Forwarding a bug is not enough, you
707 have to check at each release if the bug has been fixed or not.  If it has, you
708 just close it, otherwise you have to remind the author about it.  If you have
709 the required skills you can prepare a patch that fixes the bug and send it to
710 the author at the same time.  Make sure to send the patch to the BTS and to tag
711 the bug as <literal>patch</literal>.
712 </para>
713 </listitem>
714 <listitem>
715 <para>
716 If you have fixed a bug in your local copy, or if a fix has been committed to
717 the CVS repository, you may tag the bug as <literal>pending</literal> to let
718 people know that the bug is corrected and that it will be closed with the next
719 upload (add the <literal>closes:</literal> in the
720 <filename>changelog</filename>).  This is particularly useful if you are
721 several developers working on the same package.
722 </para>
723 </listitem>
724 <listitem>
725 <para>
726 Once a corrected package is available in the <emphasis>unstable</emphasis>
727 distribution, you can close the bug.  This can be done automatically, read
728 <xref linkend="upload-bugfix"/> .
729 </para>
730 </listitem>
731 </orderedlist>
732 </section>
734 <section id="upload-bugfix">
735 <title>When bugs are closed by new uploads</title>
736 <para>
737 As bugs and problems are fixed in your packages, it is your responsibility as
738 the package maintainer to close these bugs.  However, you should not close a
739 bug until the package which fixes the bug has been accepted into the Debian
740 archive.  Therefore, once you get notification that your updated package has
741 been installed into the archive, you can and should close the bug in the BTS.
742 Also, the bug should be closed with the correct version.
743 </para>
744 <para>
745 However, it's possible to avoid having to manually close bugs after the upload
746 — just list the fixed bugs in your <filename>debian/changelog</filename>
747 file, following a certain syntax, and the archive maintenance software will
748 close the bugs for you.  For example:
749 </para>
750 <screen>
751 -cannon (3.1415) unstable; urgency=low
753   * Frobbed with options (closes: Bug#98339)
754   * Added safety to prevent operator dismemberment, closes: bug#98765,
755     bug#98713, #98714.
756   * Added man page. Closes: #98725.
757 </screen>
758 <para>
759 Technically speaking, the following Perl regular expression describes how bug
760 closing changelogs are identified:
761 </para>
762 <screen>
763   /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig
764 </screen>
765 <para>
766 We prefer the <literal>closes: #<replaceable>XXX</replaceable></literal>
767 syntax, as it is the most concise entry and the easiest to integrate with the
768 text of the <filename>changelog</filename>.  Unless specified different by the
769 <replaceable>-v</replaceable>-switch to <command>dpkg-buildpackage</command>,
770 only the bugs closed in the most recent changelog entry are closed (basically,
771 exactly the bugs mentioned in the changelog-part in the
772 <filename>.changes</filename> file are closed).
773 </para>
774 <para>
775 Historically, uploads identified as <link linkend="nmu">Non-maintainer
776 upload (NMU)</link> were tagged <literal>fixed</literal> instead of being
777 closed, but that practice was ceased with the advent of version-tracking.  The
778 same applied to the tag <literal>fixed-in-experimental</literal>.
779 </para>
780 <para>
781 If you happen to mistype a bug number or forget a bug in the changelog entries,
782 don't hesitate to undo any damage the error caused.  To reopen wrongly closed
783 bugs, send a <literal>reopen <replaceable>XXX</replaceable></literal> command
784 to the bug tracking system's control address,
785 <email></email>.  To close any remaining bugs that were
786 fixed by your upload, email the <filename>.changes</filename> file to
787 <email></email>, where <replaceable>XXX</replaceable>
788 is the bug number, and put Version: YYY and an empty line as the first two
789 lines of the body of the email, where <replaceable>YYY</replaceable> is the
790 first version where the bug has been fixed.
791 </para>
792 <para>
793 Bear in mind that it is not obligatory to close bugs using the changelog as
794 described above.  If you simply want to close bugs that don't have anything to
795 do with an upload you made, do it by emailing an explanation to
796 <email></email>.  Do <emphasis
797 role="strong">not</emphasis> close bugs in the changelog entry of a version if
798 the changes in that version of the package don't have any bearing on the bug.
799 </para>
800 <para>
801 For general information on how to write your changelog entries, see <xref
802 linkend="bpp-debian-changelog"/> .
803 </para>
804 </section>
806 <section id="bug-security">
807 <title>Handling security-related bugs</title>
808 <para>
809 Due to their sensitive nature, security-related bugs must be handled carefully.
810 The Debian Security Team exists to coordinate this activity, keeping track of
811 outstanding security problems, helping maintainers with security problems or
812 fixing them themselves, sending security advisories, and maintaining
814 </para>
815 <para>
816 When you become aware of a security-related bug in a Debian package, whether or
817 not you are the maintainer, collect pertinent information about the problem,
818 and promptly contact the security team at
819 <email></email> as soon as possible.  <emphasis
820 role="strong">DO NOT UPLOAD</emphasis> any packages for stable; the security
821 team will do that.  Useful information includes, for example:
822 </para>
823 <itemizedlist>
824 <listitem>
825 <para>
826 Which versions of the package are known to be affected by the bug.  Check each
827 version that is present in a supported Debian release, as well as testing and
828 unstable.
829 </para>
830 </listitem>
831 <listitem>
832 <para>
833 The nature of the fix, if any is available (patches are especially helpful)
834 </para>
835 </listitem>
836 <listitem>
837 <para>
838 Any fixed packages that you have prepared yourself (send only the
839 <literal>.diff.gz</literal> and <literal>.dsc</literal> files and read <xref
840 linkend="bug-security-building"/> first)
841 </para>
842 </listitem>
843 <listitem>
844 <para>
845 Any assistance you can provide to help with testing (exploits, regression
846 testing, etc.)
847 </para>
848 </listitem>
849 <listitem>
850 <para>
851 Any information needed for the advisory (see <xref
852 linkend="bug-security-advisories"/> )
853 </para>
854 </listitem>
855 </itemizedlist>
856 <section id="bug-security-confidentiality">
857 <title>Confidentiality</title>
858 <para>
859 Unlike most other activities within Debian, information about security issues
860 must sometimes be kept private for a time.  This allows software distributors
861 to coordinate their disclosure in order to minimize their users' exposure.
862 Whether this is the case depends on the nature of the problem and corresponding
863 fix, and whether it is already a matter of public knowledge.
864 </para>
865 <para>
866 There are several ways developers can learn of a security problem:
867 </para>
868 <itemizedlist>
869 <listitem>
870 <para>
871 they notice it on a public forum (mailing list, web site, etc.)
872 </para>
873 </listitem>
874 <listitem>
875 <para>
876 someone files a bug report
877 </para>
878 </listitem>
879 <listitem>
880 <para>
881 someone informs them via private email
882 </para>
883 </listitem>
884 </itemizedlist>
885 <para>
886 In the first two cases, the information is public and it is important to have a
887 fix as soon as possible.  In the last case, however, it might not be public
888 information.  In that case there are a few possible options for dealing with
889 the problem:
890 </para>
891 <itemizedlist>
892 <listitem>
893 <para>
894 If the security exposure is minor, there is sometimes no need to keep the
895 problem a secret and a fix should be made and released.
896 </para>
897 </listitem>
898 <listitem>
899 <para>
900 If the problem is severe, it is preferable to share the information with other
901 vendors and coordinate a release.  The security team keeps in contact with the
902 various organizations and individuals and can take care of that.
903 </para>
904 </listitem>
905 </itemizedlist>
906 <para>
907 In all cases if the person who reports the problem asks that it not be
908 disclosed, such requests should be honored, with the obvious exception of
909 informing the security team in order that a fix may be produced for a stable
910 release of Debian.  When sending confidential information to the security team,
911 be sure to mention this fact.
912 </para>
913 <para>
914 Please note that if secrecy is needed you may not upload a fix to unstable (or
915 anywhere else, such as a public CVS repository).  It is not sufficient to
916 obfuscate the details of the change, as the code itself is public, and can (and
917 will) be examined by the general public.
918 </para>
919 <para>
920 There are two reasons for releasing information even though secrecy is
921 requested: the problem has been known for a while, or the problem or exploit
922 has become public.
923 </para>
924 </section>
926 <section id="bug-security-advisories">
927 <title>Security Advisories</title>
928 <para>
929 Security advisories are only issued for the current, released stable
930 distribution, and <emphasis>not</emphasis> for testing or unstable.  When
931 released, advisories are sent to the
932 <email></email> mailing list and
933 posted on <ulink url="">the security web
934 page</ulink>.  Security advisories are written and posted by the security team.
935 However they certainly do not mind if a maintainer can supply some of the
936 information for them, or write part of the text.  Information that should be in
937 an advisory includes:
938 </para>
939 <itemizedlist>
940 <listitem>
941 <para>
942 A description of the problem and its scope, including:
943 </para>
944 <itemizedlist>
945 <listitem>
946 <para>
947 The type of problem (privilege escalation, denial of service, etc.)
948 </para>
949 </listitem>
950 <listitem>
951 <para>
952 What privileges may be gained, and by whom (if any)
953 </para>
954 </listitem>
955 <listitem>
956 <para>
957 How it can be exploited
958 </para>
959 </listitem>
960 <listitem>
961 <para>
962 Whether it is remotely or locally exploitable
963 </para>
964 </listitem>
965 <listitem>
966 <para>
967 How the problem was fixed
968 </para>
969 </listitem>
970 </itemizedlist>
971 <para>
972 This information allows users to assess the threat to their systems.
973 </para>
974 </listitem>
975 <listitem>
976 <para>
977 Version numbers of affected packages
978 </para>
979 </listitem>
980 <listitem>
981 <para>
982 Version numbers of fixed packages
983 </para>
984 </listitem>
985 <listitem>
986 <para>
987 Information on where to obtain the updated packages (usually from the Debian
988 security archive)
989 </para>
990 </listitem>
991 <listitem>
992 <para>
993 References to upstream advisories, <ulink
994 url="">CVE</ulink> identifiers, and any other information
995 useful in cross-referencing the vulnerability
996 </para>
997 </listitem>
998 </itemizedlist>
999 </section>
1001 <section id="bug-security-building">
1002 <title>Preparing packages to address security issues</title>
1003 <para>
1004 One way that you can assist the security team in their duties is to provide
1005 them with fixed packages suitable for a security advisory for the stable Debian
1006 release.
1007 </para>
1008 <para>
1009 When an update is made to the stable release, care must be taken to avoid
1010 changing system behavior or introducing new bugs.  In order to do this, make as
1011 few changes as possible to fix the bug.  Users and administrators rely on the
1012 exact behavior of a release once it is made, so any change that is made might
1013 break someone's system.  This is especially true of libraries: make sure you
1014 never change the API or ABI, no matter how small the change.
1015 </para>
1016 <para>
1017 This means that moving to a new upstream version is not a good solution.
1018 Instead, the relevant changes should be back-ported to the version present in
1019 the current stable Debian release.  Generally, upstream maintainers are willing
1020 to help if needed.  If not, the Debian security team may be able to help.
1021 </para>
1022 <para>
1023 In some cases, it is not possible to back-port a security fix, for example when
1024 large amounts of source code need to be modified or rewritten.  If this
1025 happens, it may be necessary to move to a new upstream version.  However, this
1026 is only done in extreme situations, and you must always coordinate that with
1027 the security team beforehand.
1028 </para>
1029 <para>
1030 Related to this is another important guideline: always test your changes.  If
1031 you have an exploit available, try it and see if it indeed succeeds on the
1032 unpatched package and fails on the fixed package.  Test other, normal actions
1033 as well, as sometimes a security fix can break seemingly unrelated features in
1034 subtle ways.
1035 </para>
1036 <para>
1037 Do <emphasis role="strong">NOT</emphasis> include any changes in your package
1038 which are not directly related to fixing the vulnerability.  These will only
1039 need to be reverted, and this wastes time.  If there are other bugs in your
1040 package that you would like to fix, make an upload to proposed-updates in the
1041 usual way, after the security advisory is issued.  The security update
1042 mechanism is not a means for introducing changes to your package which would
1043 otherwise be rejected from the stable release, so please do not attempt to do
1044 this.
1045 </para>
1046 <para>
1047 Review and test your changes as much as possible.  Check the differences from
1048 the previous version repeatedly (<command>interdiff</command> from the
1049 <systemitem role="package">patchutils</systemitem> package and
1050 <command>debdiff</command> from <systemitem
1051 role="package">devscripts</systemitem> are useful tools for this, see <xref
1052 linkend="debdiff"/> ).
1053 </para>
1054 <para>
1055 Be sure to verify the following items:
1056 </para>
1057 <itemizedlist>
1058 <listitem>
1059 <para>
1060 Target the right distribution in your <filename>debian/changelog</filename>.
1061 For stable this is <literal>stable-security</literal> and for testing this is
1062 <literal>testing-security</literal>, and for the previous stable release, this
1063 is <literal>oldstable-security</literal>.  Do not target
1064 <replaceable>distribution</replaceable>-proposed-updates or
1065 <literal>stable</literal>!
1066 </para>
1067 </listitem>
1068 <listitem>
1069 <para>
1070 The upload should have urgency=high.
1071 </para>
1072 </listitem>
1073 <listitem>
1074 <para>
1075 Make descriptive, meaningful changelog entries.  Others will rely on them to
1076 determine whether a particular bug was fixed.  Always include an external
1077 reference, preferably a CVE identifier, so that it can be cross-referenced.
1078 Include the same information in the changelog for unstable, so that it is clear
1079 that the same bug was fixed, as this is very helpful when verifying that the
1080 bug is fixed in the next stable release.  If a CVE identifier has not yet been
1081 assigned, the security team will request one so that it can be included in the
1082 package and in the advisory.
1083 </para>
1084 </listitem>
1085 <listitem>
1086 <para>
1087 Make sure the version number is proper.  It must be greater than the current
1088 package, but less than package versions in later distributions.  If in doubt,
1089 test it with <literal>dpkg --compare-versions</literal>.  Be careful not to
1090 re-use a version number that you have already used for a previous upload.  For
1091 <emphasis>testing</emphasis>, there must be a higher version in
1092 <emphasis>unstable</emphasis>.  If there is none yet (for example, if
1093 <emphasis>testing</emphasis> and <emphasis>unstable</emphasis> have the same
1094 version) you must upload a new version to unstable first.
1095 </para>
1096 </listitem>
1097 <listitem>
1098 <para>
1099 Do not make source-only uploads if your package has any binary-all packages (do
1100 not use the <literal>-S</literal> option to
1101 <command>dpkg-buildpackage</command>).  The <command>buildd</command>
1102 infrastructure will not build those.  This point applies to normal package
1103 uploads as well.
1104 </para>
1105 </listitem>
1106 <listitem>
1107 <para>
1108 Unless the upstream source has been uploaded to before (by
1109 a previous security update), build the upload with full upstream source
1110 (<literal>dpkg-buildpackage -sa</literal>).  If there has been a previous
1111 upload to with the same upstream version, you may upload
1112 without upstream source (<literal>dpkg-buildpackage -sd</literal>).
1113 </para>
1114 </listitem>
1115 <listitem>
1116 <para>
1117 Be sure to use the exact same <filename>*.orig.tar.gz</filename> as used in the
1118 normal archive, otherwise it is not possible to move the security fix into the
1119 main archives later.
1120 </para>
1121 </listitem>
1122 <listitem>
1123 <para>
1124 Build the package on a clean system which only has packages installed from the
1125 distribution you are building for.  If you do not have such a system yourself,
1126 you can use a machine (see <xref linkend="server-machines"/> ) or
1127 setup a chroot (see <xref linkend="pbuilder"/> and <xref
1128 linkend="debootstrap"/> ).
1129 </para>
1130 </listitem>
1131 </itemizedlist>
1132 </section>
1134 <section id="bug-security-upload">
1135 <title>Uploading the fixed package</title>
1136 <para>
1137 Do <emphasis role="strong">NOT</emphasis> upload a package to the security
1138 upload queue (oldstable-security, stable-security, etc.) without prior
1139 authorization from the security team.  If the package does not exactly meet the
1140 team's requirements, it will cause many problems and delays in dealing with the
1141 unwanted upload.
1142 </para>
1143 <para>
1144 Do <emphasis role="strong">NOT</emphasis> upload your fix to proposed-updates
1145 without coordinating with the security team.  Packages from
1146 will be copied into the proposed-updates directory automatically.  If a package
1147 with the same or a higher version number is already installed into the archive,
1148 the security update will be rejected by the archive system.  That way, the
1149 stable distribution will end up without a security update for this package
1150 instead.
1151 </para>
1152 <para>
1153 Once you have created and tested the new package and it has been approved by
1154 the security team, it needs to be uploaded so that it can be installed in the
1155 archives.  For security uploads, the place to upload to is
1156 <literal></literal> .
1157 </para>
1158 <para>
1159 Once an upload to the security queue has been accepted, the package will
1160 automatically be rebuilt for all architectures and stored for verification by
1161 the security team.
1162 </para>
1163 <para>
1164 Uploads which are waiting for acceptance or verification are only accessible by
1165 the security team.  This is necessary since there might be fixes for security
1166 problems that cannot be disclosed yet.
1167 </para>
1168 <para>
1169 If a member of the security team accepts a package, it will be installed on
1170 as well as proposed for the proper
1171 <replaceable>distribution</replaceable>-proposed-updates on ftp-master.
1172 </para>
1173 </section>
1175 </section>
1177 </section>
1179 <section id="archive-manip">
1180 <title>Moving, removing, renaming, adopting, and orphaning packages</title>
1181 <para>
1182 Some archive manipulation operations are not automated in the Debian upload
1183 process.  These procedures should be manually followed by maintainers.  This
1184 chapter gives guidelines on what to do in these cases.
1185 </para>
1186 <section id="moving-pkgs">
1187 <title>Moving packages</title>
1188 <para>
1189 Sometimes a package will change its section.  For instance, a package from the
1190 `non-free' section might be GPL'd in a later version, in which case the package
1191 should be moved to `main' or `contrib'.<footnote><para> See the <ulink
1192 url="">Debian Policy Manual</ulink> for
1193 guidelines on what section a package belongs in.  </para> </footnote>
1194 </para>
1195 <para>
1196 If you need to change the section for one of your packages, change the package
1197 control information to place the package in the desired section, and re-upload
1198 the package (see the <ulink
1199 url="">Debian Policy Manual</ulink> for
1200 details).  You must ensure that you include the
1201 <filename>.orig.tar.gz</filename> in your upload (even if you are not uploading
1202 a new upstream version), or it will not appear in the new section together with
1203 the rest of the package.  If your new section is valid, it will be moved
1204 automatically.  If it does not, then contact the ftpmasters in order to
1205 understand what happened.
1206 </para>
1207 <para>
1208 If, on the other hand, you need to change the <emphasis>subsection</emphasis>
1209 of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly
1210 different.  Correct the subsection as found in the control file of the package,
1211 and re-upload that.  Also, you'll need to get the override file updated, as
1212 described in <xref linkend="override-file"/> .
1213 </para>
1214 </section>
1216 <section id="removing-pkgs">
1217 <title>Removing packages</title>
1218 <para>
1219 If for some reason you want to completely remove a package (say, if it is an
1220 old compatibility library which is no longer required), you need to file a bug
1221 against <literal></literal> asking that the package be removed;
1222 as all bugs, this bug should normally have normal severity.  Make sure you
1223 indicate which distribution the package should be removed from.  Normally, you
1224 can only have packages removed from <emphasis>unstable</emphasis> and
1225 <emphasis>experimental</emphasis>.  Packages are not removed from
1226 <emphasis>testing</emphasis> directly.  Rather, they will be removed
1227 automatically after the package has been removed from
1228 <emphasis>unstable</emphasis> and no package in <emphasis>testing</emphasis>
1229 depends on it.
1230 </para>
1231 <para>
1232 There is one exception when an explicit removal request is not necessary: If a
1233 (source or binary) package is an orphan, it will be removed semi-automatically.
1234 For a binary-package, this means if there is no longer any source package
1235 producing this binary package; if the binary package is just no longer produced
1236 on some architectures, a removal request is still necessary.  For a
1237 source-package, this means that all binary packages it refers to have been
1238 taken over by another source package.
1239 </para>
1240 <para>
1241 In your removal request, you have to detail the reasons justifying the request.
1242 This is to avoid unwanted removals and to keep a trace of why a package has
1243 been removed.  For example, you can provide the name of the package that
1244 supersedes the one to be removed.
1245 </para>
1246 <para>
1247 Usually you only ask for the removal of a package maintained by yourself.  If
1248 you want to remove another package, you have to get the approval of its
1249 maintainer.
1250 </para>
1251 <para>
1252 Further information relating to these and other package removal related topics
1253 may be found at <ulink url=""></ulink>
1254 and <ulink url=""></ulink>.
1255 </para>
1256 <para>
1257 If in doubt concerning whether a package is disposable, email
1258 <email></email> asking for opinions.  Also of
1259 interest is the <command>apt-cache</command> program from the <systemitem
1260 role="package">apt</systemitem> package.  When invoked as <literal>apt-cache
1261 showpkg <replaceable>package</replaceable></literal>, the program will show
1262 details for <replaceable>package</replaceable>, including reverse depends.
1263 Other useful programs include <literal>apt-cache rdepends</literal>,
1264 <command>apt-rdepends</command> and <command>grep-dctrl</command>.  Removal of
1265 orphaned packages is discussed on <email></email>.
1266 </para>
1267 <para>
1268 Once the package has been removed, the package's bugs should be handled.  They
1269 should either be reassigned to another package in the case where the actual
1270 code has evolved into another package (e.g.  <literal>libfoo12</literal> was
1271 removed because <literal>libfoo13</literal> supersedes it) or closed if the
1272 software is simply no longer part of Debian.
1273 </para>
1274 <section id="s5.9.2.1">
1275 <title>Removing packages from <filename>Incoming</filename></title>
1276 <para>
1277 In the past, it was possible to remove packages from
1278 <filename>incoming</filename>.  However, with the introduction of the new
1279 incoming system, this is no longer possible.  Instead, you have to upload a new
1280 revision of your package with a higher version than the package you want to
1281 replace.  Both versions will be installed in the archive but only the higher
1282 version will actually be available in <emphasis>unstable</emphasis> since the
1283 previous version will immediately be replaced by the higher.  However, if you
1284 do proper testing of your packages, the need to replace a package should not
1285 occur too often anyway.
1286 </para>
1287 </section>
1289 </section>
1291 <section id="s5.9.3">
1292 <title>Replacing or renaming packages</title>
1293 <para>
1294 When you make a mistake naming your package, you should follow a two-step
1295 process to rename it.  First, set your <filename>debian/control</filename> file
1296 to replace and conflict with the obsolete name of the package (see the <ulink
1297 url="">Debian Policy Manual</ulink> for
1298 details).  Once you've uploaded the package and the package has moved into the
1299 archive, file a bug against <literal></literal> asking to remove
1300 the package with the obsolete name.  Do not forget to properly reassign the
1301 package's bugs at the same time.
1302 </para>
1303 <para>
1304 At other times, you may make a mistake in constructing your package and wish to
1305 replace it.  The only way to do this is to increase the version number and
1306 upload a new version.  The old version will be expired in the usual manner.
1307 Note that this applies to each part of your package, including the sources: if
1308 you wish to replace the upstream source tarball of your package, you will need
1309 to upload it with a different version.  An easy possibility is to replace
1310 <filename>foo_1.00.orig.tar.gz</filename> with
1311 <filename>foo_1.00+0.orig.tar.gz</filename>.  This restriction gives each file
1312 on the ftp site a unique name, which helps to ensure consistency across the
1313 mirror network.
1314 </para>
1315 </section>
1317 <section id="orphaning">
1318 <title>Orphaning a package</title>
1319 <para>
1320 If you can no longer maintain a package, you need to inform others, and see
1321 that the package is marked as orphaned.  You should set the package maintainer
1322 to <literal>Debian QA Group &lt;;</literal> and submit
1323 a bug report against the pseudo package <systemitem
1324 role="package">wnpp</systemitem>.  The bug report should be titled <literal>O:
1325 <replaceable>package</replaceable> -- <replaceable>short
1326 description</replaceable></literal> indicating that the package is now
1327 orphaned.  The severity of the bug should be set to
1328 <emphasis>normal</emphasis>; if the package has a priority of standard or
1329 higher, it should be set to important.  If you feel it's necessary, send a copy
1330 to <email></email> by putting the address in the
1331 X-Debbugs-CC: header of the message (no, don't use CC:, because that way the
1332 message's subject won't indicate the bug number).
1333 </para>
1334 <para>
1335 If you just intend to give the package away, but you can keep maintainership
1336 for the moment, then you should instead submit a bug against <systemitem
1337 role="package">wnpp</systemitem> and title it <literal>RFA:
1338 <replaceable>package</replaceable> -- <replaceable>short
1339 description</replaceable></literal>.  <literal>RFA</literal> stands for
1340 <emphasis>Request For Adoption</emphasis>.
1341 </para>
1342 <para>
1343 More information is on the <ulink url="">WNPP
1344 web pages</ulink>.
1345 </para>
1346 </section>
1348 <section id="adopting">
1349 <title>Adopting a package</title>
1350 <para>
1351 A list of packages in need of a new maintainer is available in the <ulink
1352 url="">Work-Needing and Prospective Packages
1353 list (WNPP)</ulink>.  If you wish to take over maintenance of any of the
1354 packages listed in the WNPP, please take a look at the aforementioned page for
1355 information and procedures.
1356 </para>
1357 <para>
1358 It is not OK to simply take over a package that you feel is neglected — that
1359 would be package hijacking.  You can, of course, contact the current maintainer
1360 and ask them if you may take over the package.  If you have reason to believe a
1361 maintainer has gone AWOL (absent without leave), see <xref linkend="mia-qa"/> .
1362 </para>
1363 <para>
1364 Generally, you may not take over the package without the assent of the current
1365 maintainer.  Even if they ignore you, that is still not grounds to take over a
1366 package.  Complaints about maintainers should be brought up on the developers'
1367 mailing list.  If the discussion doesn't end with a positive conclusion, and
1368 the issue is of a technical nature, consider bringing it to the attention of
1369 the technical committee (see the <ulink
1370 url="">technical committee web
1371 page</ulink> for more information).
1372 </para>
1373 <para>
1374 If you take over an old package, you probably want to be listed as the
1375 package's official maintainer in the bug system.  This will happen
1376 automatically once you upload a new version with an updated
1377 <literal>Maintainer:</literal> field, although it can take a few hours after
1378 the upload is done.  If you do not expect to upload a new version for a while,
1379 you can use <xref linkend="pkg-tracking-system"/> to get the bug reports.
1380 However, make sure that the old maintainer has no problem with the fact that
1381 they will continue to receive the bugs during that time.
1382 </para>
1383 </section>
1385 </section>
1387 <section id="porting">
1388 <title>Porting and being ported</title>
1389 <para>
1390 Debian supports an ever-increasing number of architectures.  Even if you are
1391 not a porter, and you don't use any architecture but one, it is part of your
1392 duty as a maintainer to be aware of issues of portability.  Therefore, even if
1393 you are not a porter, you should read most of this chapter.
1394 </para>
1395 <para>
1396 Porting is the act of building Debian packages for architectures that are
1397 different from the original architecture of the package maintainer's binary
1398 package.  It is a unique and essential activity.  In fact, porters do most of
1399 the actual compiling of Debian packages.  For instance, for a single
1400 <emphasis>i386</emphasis> binary package, there must be a recompile for each
1401 architecture, which amounts to 12 more builds.
1402 </para>
1403 <section id="kind-to-porters">
1404 <title>Being kind to porters</title>
1405 <para>
1406 Porters have a difficult and unique task, since they are required to deal with
1407 a large volume of packages.  Ideally, every source package should build right
1408 out of the box.  Unfortunately, this is often not the case.  This section
1409 contains a checklist of ``gotchas'' often committed by Debian maintainers —
1410 common problems which often stymie porters, and make their jobs unnecessarily
1411 difficult.
1412 </para>
1413 <para>
1414 The first and most important thing is to respond quickly to bug or issues
1415 raised by porters.  Please treat porters with courtesy, as if they were in fact
1416 co-maintainers of your package (which, in a way, they are).  Please be tolerant
1417 of succinct or even unclear bug reports; do your best to hunt down whatever the
1418 problem is.
1419 </para>
1420 <para>
1421 By far, most of the problems encountered by porters are caused by
1422 <emphasis>packaging bugs</emphasis> in the source packages.  Here is a
1423 checklist of things you should check or be aware of.
1424 </para>
1425 <orderedlist numeration="arabic">
1426 <listitem>
1427 <para>
1428 Make sure that your <literal>Build-Depends</literal> and
1429 <literal>Build-Depends-Indep</literal> settings in
1430 <filename>debian/control</filename> are set properly.  The best way to validate
1431 this is to use the <systemitem role="package">debootstrap</systemitem> package
1432 to create an unstable chroot environment (see <xref linkend="debootstrap"/> ).
1433 Within that chrooted environment, install the <systemitem
1434 role="package">build-essential</systemitem> package and any package
1435 dependencies mentioned in <literal>Build-Depends</literal> and/or
1436 <literal>Build-Depends-Indep</literal>.  Finally, try building your package
1437 within that chrooted environment.  These steps can be automated by the use of
1438 the <command>pbuilder</command> program which is provided by the package of the
1439 same name (see <xref linkend="pbuilder"/> ).
1440 </para>
1441 <para>
1442 If you can't set up a proper chroot, <command>dpkg-depcheck</command> may be of
1443 assistance (see <xref linkend="dpkg-depcheck"/> ).
1444 </para>
1445 <para>
1446 See the <ulink url="">Debian Policy
1447 Manual</ulink> for instructions on setting build dependencies.
1448 </para>
1449 </listitem>
1450 <listitem>
1451 <para>
1452 Don't set architecture to a value other than ``all'' or ``any'' unless you
1453 really mean it.  In too many cases, maintainers don't follow the instructions
1454 in the <ulink url="">Debian Policy
1455 Manual</ulink>.  Setting your architecture to ``i386'' is usually incorrect.
1456 </para>
1457 </listitem>
1458 <listitem>
1459 <para>
1460 Make sure your source package is correct.  Do <literal>dpkg-source -x
1461 <replaceable>package</replaceable>.dsc</literal> to make sure your source
1462 package unpacks properly.  Then, in there, try building your package from
1463 scratch with <command>dpkg-buildpackage</command>.
1464 </para>
1465 </listitem>
1466 <listitem>
1467 <para>
1468 Make sure you don't ship your source package with the
1469 <filename>debian/files</filename> or <filename>debian/substvars</filename>
1470 files.  They should be removed by the `clean' target of
1471 <filename>debian/rules</filename>.
1472 </para>
1473 </listitem>
1474 <listitem>
1475 <para>
1476 Make sure you don't rely on locally installed or hacked configurations or
1477 programs.  For instance, you should never be calling programs in
1478 <filename>/usr/local/bin</filename> or the like.  Try not to rely on programs
1479 being setup in a special way.  Try building your package on another machine,
1480 even if it's the same architecture.
1481 </para>
1482 </listitem>
1483 <listitem>
1484 <para>
1485 Don't depend on the package you're building being installed already (a sub-case
1486 of the above issue).
1487 </para>
1488 </listitem>
1489 <listitem>
1490 <para>
1491 Don't rely on the compiler being a certain version, if possible.  If not, then
1492 make sure your build dependencies reflect the restrictions, although you are
1493 probably asking for trouble, since different architectures sometimes
1494 standardize on different compilers.
1495 </para>
1496 </listitem>
1497 <listitem>
1498 <para>
1499 Make sure your debian/rules contains separate ``binary-arch'' and
1500 ``binary-indep'' targets, as the Debian Policy Manual requires.  Make sure that
1501 both targets work independently, that is, that you can call the target without
1502 having called the other before.  To test this, try to run
1503 <literal>dpkg-buildpackage -B</literal>.
1504 </para>
1505 </listitem>
1506 </orderedlist>
1507 </section>
1509 <section id="porter-guidelines">
1510 <title>Guidelines for porter uploads</title>
1511 <para>
1512 If the package builds out of the box for the architecture to be ported to, you
1513 are in luck and your job is easy.  This section applies to that case; it
1514 describes how to build and upload your binary package so that it is properly
1515 installed into the archive.  If you do have to patch the package in order to
1516 get it to compile for the other architecture, you are actually doing a source
1517 NMU, so consult <xref linkend="nmu-guidelines"/> instead.
1518 </para>
1519 <para>
1520 For a porter upload, no changes are being made to the source.  You do not need
1521 to touch any of the files in the source package.  This includes
1522 <filename>debian/changelog</filename>.
1523 </para>
1524 <para>
1525 The way to invoke <command>dpkg-buildpackage</command> is as
1526 <literal>dpkg-buildpackage -B
1527 -m<replaceable>porter-email</replaceable></literal>.  Of course, set
1528 <replaceable>porter-email</replaceable> to your email address.  This will do a
1529 binary-only build of only the architecture-dependent portions of the package,
1530 using the `binary-arch' target in <filename>debian/rules</filename>.
1531 </para>
1532 <para>
1533 If you are working on a Debian machine for your porting efforts and you need to
1534 sign your upload locally for its acceptance in the archive, you can run
1535 <command>debsign</command> on your <filename>.changes</filename> file to have
1536 it signed conveniently, or use the remote signing mode of
1537 <command>dpkg-sig</command>.
1538 </para>
1539 <section id="binary-only-nmu">
1540 <title>Recompilation or binary-only NMU</title>
1541 <para>
1542 Sometimes the initial porter upload is problematic because the environment in
1543 which the package was built was not good enough (outdated or obsolete library,
1544 bad compiler, ...).  Then you may just need to recompile it in an updated
1545 environment.  However, you have to bump the version number in this case, so
1546 that the old bad package can be replaced in the Debian archive
1547 (<command>katie</command> refuses to install new packages if they don't have a
1548 version number greater than the currently available one).
1549 </para>
1550 <para>
1551 You have to make sure that your binary-only NMU doesn't render the package
1552 uninstallable.  This could happen when a source package generates
1553 arch-dependent and arch-independent packages that depend on each other via
1554 $(Source-Version).
1555 </para>
1556 <para>
1557 Despite the required modification of the changelog, these are called
1558 binary-only NMUs — there is no need in this case to trigger all other
1559 architectures to consider themselves out of date or requiring recompilation.
1560 </para>
1561 <para>
1562 Such recompilations require special ``magic'' version numbering, so that the
1563 archive maintenance tools recognize that, even though there is a new Debian
1564 version, there is no corresponding source update.  If you get this wrong, the
1565 archive maintainers will reject your upload (due to lack of corresponding
1566 source code).
1567 </para>
1568 <para>
1569 The ``magic'' for a recompilation-only NMU is triggered by using a suffix
1570 appended to the package version number, following the form b&lt;number&gt;.
1571 For instance, if the latest version you are recompiling against was version
1572 ``2.9-3'', your NMU should carry a version of ``2.9-3+b1''.  If the latest
1573 version was ``3.4+b1'' (i.e, a native package with a previous recompilation
1574 NMU), your NMU should have a version number of ``3.4+b2''.  <footnote><para> In
1575 the past, such NMUs used the third-level number on the Debian part of the
1576 revision to denote their recompilation-only status; however, this syntax was
1577 ambiguous with native packages and did not allow proper ordering of
1578 recompile-only NMUs, source NMUs, and security NMUs on the same package, and
1579 has therefore been abandoned in favor of this new syntax.  </para> </footnote>
1580 </para>
1581 <para>
1582 Similar to initial porter uploads, the correct way of invoking
1583 <command>dpkg-buildpackage</command> is <literal>dpkg-buildpackage -B</literal>
1584 to only build the architecture-dependent parts of the package.
1585 </para>
1586 </section>
1588 <section id="source-nmu-when-porter">
1589 <title>When to do a source NMU if you are a porter</title>
1590 <para>
1591 Porters doing a source NMU generally follow the guidelines found in <xref
1592 linkend="nmu"/> , just like non-porters.  However, it is expected that the wait
1593 cycle for a porter's source NMU is smaller than for a non-porter, since porters
1594 have to cope with a large quantity of packages.  Again, the situation varies
1595 depending on the distribution they are uploading to.  It also varies whether
1596 the architecture is a candidate for inclusion into the next stable release; the
1597 release managers decide and announce which architectures are candidates.
1598 </para>
1599 <para>
1600 If you are a porter doing an NMU for `unstable', the above guidelines for
1601 porting should be followed, with two variations.  Firstly, the acceptable
1602 waiting period — the time between when the bug is submitted to the BTS and
1603 when it is OK to do an NMU — is seven days for porters working on the
1604 unstable distribution.  This period can be shortened if the problem is critical
1605 and imposes hardship on the porting effort, at the discretion of the porter
1606 group.  (Remember, none of this is Policy, just mutually agreed upon
1607 guidelines.) For uploads to stable or testing, please coordinate with the
1608 appropriate release team first.
1609 </para>
1610 <para>
1611 Secondly, porters doing source NMUs should make sure that the bug they submit
1612 to the BTS should be of severity `serious' or greater.  This ensures that a
1613 single source package can be used to compile every supported Debian
1614 architecture by release time.  It is very important that we have one version of
1615 the binary and source package for all architecture in order to comply with many
1616 licenses.
1617 </para>
1618 <para>
1619 Porters should try to avoid patches which simply kludge around bugs in the
1620 current version of the compile environment, kernel, or libc.  Sometimes such
1621 kludges can't be helped.  If you have to kludge around compiler bugs and the
1622 like, make sure you <literal>#ifdef</literal> your work properly; also,
1623 document your kludge so that people know to remove it once the external
1624 problems have been fixed.
1625 </para>
1626 <para>
1627 Porters may also have an unofficial location where they can put the results of
1628 their work during the waiting period.  This helps others running the port have
1629 the benefit of the porter's work, even during the waiting period.  Of course,
1630 such locations have no official blessing or status, so buyer beware.
1631 </para>
1632 </section>
1634 </section>
1636 <section id="porter-automation">
1637 <title>Porting infrastructure and automation</title>
1638 <para>
1639 There is infrastructure and several tools to help automate package porting.
1640 This section contains a brief overview of this automation and porting to these
1641 tools; see the package documentation or references for full information.
1642 </para>
1643 <section id="s5.10.3.1">
1644 <title>Mailing lists and web pages</title>
1645 <para>
1646 Web pages containing the status of each port can be found at <ulink
1647 url=""></ulink>.
1648 </para>
1649 <para>
1650 Each port of Debian has a mailing list.  The list of porting mailing lists can
1651 be found at <ulink url=""></ulink>.  These
1652 lists are used to coordinate porters, and to connect the users of a given port
1653 with the porters.
1654 </para>
1655 </section>
1657 <section id="s5.10.3.2">
1658 <title>Porter tools</title>
1659 <para>
1660 Descriptions of several porting tools can be found in <xref
1661 linkend="tools-porting"/> .
1662 </para>
1663 </section>
1665 <section id="buildd">
1666 <title><systemitem role="package">buildd</systemitem></title>
1667 <para>
1668 The <systemitem role="package">buildd</systemitem> system is used as a
1669 distributed, client-server build distribution system.  It is usually used in
1670 conjunction with <emphasis>auto-builders</emphasis>, which are ``slave'' hosts
1671 which simply check out and attempt to auto-build packages which need to be
1672 ported.  There is also an email interface to the system, which allows porters
1673 to ``check out'' a source package (usually one which cannot yet be auto-built)
1674 and work on it.
1675 </para>
1676 <para>
1677 <systemitem role="package">buildd</systemitem> is not yet available as a
1678 package; however, most porting efforts are either using it currently or
1679 planning to use it in the near future.  The actual automated builder is
1680 packaged as <systemitem role="package">sbuild</systemitem>, see its description
1681 in <xref linkend="sbuild"/> .  The complete <systemitem
1682 role="package">buildd</systemitem> system also collects a number of as yet
1683 unpackaged components which are currently very useful and in use continually,
1684 such as <command>andrea</command> and <command>wanna-build</command>.
1685 </para>
1686 <para>
1687 Some of the data produced by <systemitem role="package">buildd</systemitem>
1688 which is generally useful to porters is available on the web at <ulink
1689 url=""></ulink>.  This data includes nightly updated
1690 information from <command>andrea</command> (source dependencies) and
1691 <systemitem role="package">quinn-diff</systemitem> (packages needing
1692 recompilation).
1693 </para>
1694 <para>
1695 We are quite proud of this system, since it has so many possible uses.
1696 Independent development groups can use the system for different sub-flavors of
1697 Debian, which may or may not really be of general interest (for instance, a
1698 flavor of Debian built with <command>gcc</command> bounds checking).  It will
1699 also enable Debian to recompile entire distributions quickly.
1700 </para>
1701 <para>
1702 The buildds admins of each arch can be contacted at the mail address
1703 $
1704 </para>
1705 </section>
1707 </section>
1709 <section id="packages-arch-specific">
1710 <title>When your package is <emphasis>not</emphasis> portable</title>
1711 <para>
1712 Some packages still have issues with building and/or working on some of the
1713 architectures supported by Debian, and cannot be ported at all, or not within a
1714 reasonable amount of time.  An example is a package that is SVGA-specific (only
1715 i386), or uses other hardware-specific features not supported on all
1716 architectures.
1717 </para>
1718 <para>
1719 In order to prevent broken packages from being uploaded to the archive, and
1720 wasting buildd time, you need to do a few things:
1721 </para>
1722 <itemizedlist>
1723 <listitem>
1724 <para>
1725 First, make sure your package <emphasis>does</emphasis> fail to build on
1726 architectures that it cannot support.  There are a few ways to achieve this.
1727 The preferred way is to have a small testsuite during build time that will test
1728 the functionality, and fail if it doesn't work.  This is a good idea anyway, as
1729 this will prevent (some) broken uploads on all architectures, and also will
1730 allow the package to build as soon as the required functionality is available.
1731 </para>
1732 <para>
1733 Additionally, if you believe the list of supported architectures is pretty
1734 constant, you should change 'any' to a list of supported architectures in
1735 debian/control.  This way, the build will fail also, and indicate this to a
1736 human reader without actually trying.
1737 </para>
1738 </listitem>
1739 <listitem>
1740 <para>
1741 In order to prevent autobuilders from needlessly trying to build your package,
1742 it must be included in <filename>packages-arch-specific</filename>, a list used
1743 by the <command>wanna-build</command> script.  The current version is available
1744 as <ulink
1745 url=""></ulink>;
1746 please see the top of the file for whom to contact for changes.
1747 </para>
1748 </listitem>
1749 </itemizedlist>
1750 <para>
1751 Please note that it is insufficient to only add your package to
1752 Packages-arch-specific without making it fail to build on unsupported
1753 architectures: A porter or any other person trying to build your package might
1754 accidently upload it without noticing it doesn't work.  If in the past some
1755 binary packages were uploaded on unsupported architectures, request their
1756 removal by filing a bug against <systemitem
1757 role="package"></systemitem>
1758 </para>
1759 </section>
1761 </section>
1763 <section id="nmu">
1764 <title>Non-Maintainer Uploads (NMUs)</title>
1765 <para>
1766 Under certain circumstances it is necessary for someone other than the official
1767 package maintainer to make a release of a package.  This is called a
1768 non-maintainer upload, or NMU.
1769 </para>
1770 <para>
1771 This section handles only source NMUs, i.e.  NMUs which upload a new version of
1772 the package.  For binary-only NMUs by porters or QA members, please see <xref
1773 linkend="binary-only-nmu"/> .  If a buildd builds and uploads a package, that
1774 too is strictly speaking a binary NMU.  See <xref linkend="buildd"/> for some
1775 more information.
1776 </para>
1777 <para>
1778 The main reason why NMUs are done is when a developer needs to fix another
1779 developer's package in order to address serious problems or crippling bugs or
1780 when the package maintainer is unable to release a fix in a timely fashion.
1781 </para>
1782 <para>
1783 First and foremost, it is critical that NMU patches to source should be as
1784 non-disruptive as possible.  Do not do housekeeping tasks, do not change the
1785 name of modules or files, do not move directories; in general, do not fix
1786 things which are not broken.  Keep the patch as small as possible.  If things
1787 bother you aesthetically, talk to the Debian maintainer, talk to the upstream
1788 maintainer, or submit a bug.  However, aesthetic changes must
1789 <emphasis>not</emphasis> be made in a non-maintainer upload.
1790 </para>
1791 <para>
1792 And please remember the Hippocratic Oath: Above all, do no harm.  It is better
1793 to leave a package with an open grave bug than applying a non-functional patch,
1794 or one that hides the bug instead of resolving it.
1795 </para>
1796 <section id="nmu-guidelines">
1797 <title>How to do a NMU</title>
1798 <para>
1799 NMUs which fix important, serious or higher severity bugs are encouraged and
1800 accepted.  You should endeavor to reach the current maintainer of the package;
1801 they might be just about to upload a fix for the problem, or have a better
1802 solution.
1803 </para>
1804 <para>
1805 NMUs should be made to assist a package's maintainer in resolving bugs.
1806 Maintainers should be thankful for that help, and NMUers should respect the
1807 decisions of maintainers, and try to personally help the maintainer by their
1808 work.
1809 </para>
1810 <para>
1811 A NMU should follow all conventions, written down in this section.  For an
1812 upload to testing or unstable, this order of steps is recommended:
1813 </para>
1814 <itemizedlist>
1815 <listitem>
1816 <para>
1817 Make sure that the package's bugs that the NMU is meant to address are all
1818 filed in the Debian Bug Tracking System (BTS).  If they are not, submit them
1819 immediately.
1820 </para>
1821 </listitem>
1822 <listitem>
1823 <para>
1824 Wait a few days for the response from the maintainer.  If you don't get any
1825 response, you may want to help them by sending the patch that fixes the bug.
1826 Don't forget to tag the bug with the patch keyword.
1827 </para>
1828 </listitem>
1829 <listitem>
1830 <para>
1831 Wait a few more days.  If you still haven't got an answer from the maintainer,
1832 send them a mail announcing your intent to NMU the package.  Prepare an NMU as
1833 described in this section, and test it carefully on your machine (cf.  <xref
1834 linkend="sanitycheck"/> ).  Double check that your patch doesn't have any
1835 unexpected side effects.  Make sure your patch is as small and as
1836 non-disruptive as it can be.
1837 </para>
1838 </listitem>
1839 <listitem>
1840 <para>
1841 Upload your package to incoming in <filename>DELAYED/7-day</filename> (cf.
1842 <xref linkend="delayed-incoming"/> ), send the final patch to the maintainer
1843 via the BTS, and explain to them that they have 7 days to react if they want to
1844 cancel the NMU.
1845 </para>
1846 </listitem>
1847 <listitem>
1848 <para>
1849 Follow what happens, you're responsible for any bug that you introduced with
1850 your NMU.  You should probably use <xref linkend="pkg-tracking-system"/> (PTS)
1851 to stay informed of the state of the package after your NMU.
1852 </para>
1853 </listitem>
1854 </itemizedlist>
1855 <para>
1856 At times, the release manager or an organized group of developers can announce
1857 a certain period of time in which the NMU rules are relaxed.  This usually
1858 involves shortening the period during which one is to wait before uploading the
1859 fixes, and shortening the DELAYED period.  It is important to notice that even
1860 in these so-called bug squashing party times, the NMU'er has to file bugs and
1861 contact the developer first, and act later.  Please see <xref
1862 linkend="qa-bsp"/> for details.
1863 </para>
1864 <para>
1865 For the testing distribution, the rules may be changed by the release managers.
1866 Please take additional care, and acknowledge that the usual way for a package
1867 to enter testing is through unstable.
1868 </para>
1869 <para>
1870 For the stable distribution, please take extra care.  Of course, the release
1871 managers may also change the rules here.  Please verify before you upload that
1872 all your changes are OK for inclusion into the next stable release by the
1873 release manager.
1874 </para>
1875 <para>
1876 When a security bug is detected, the security team may do an NMU, using their
1877 own rules.  Please refer to <xref linkend="bug-security"/> for more
1878 information.
1879 </para>
1880 <para>
1881 For the differences for Porters NMUs, please see <xref
1882 linkend="source-nmu-when-porter"/> .
1883 </para>
1884 <para>
1885 Of course, it is always possible to agree on special rules with a maintainer
1886 (like the maintainer asking please upload this fix directly for me, and no diff
1887 required).
1888 </para>
1889 </section>
1891 <section id="nmu-version">
1892 <title>NMU version numbering</title>
1893 <para>
1894 Whenever you have made a change to a package, no matter how trivial, the
1895 version number needs to change.  This enables our packing system to function.
1896 </para>
1897 <para>
1898 If you are doing a non-maintainer upload (NMU), you should add a new minor
1899 version number to the <replaceable>debian-revision</replaceable> part of the
1900 version number (the portion after the last hyphen).  This extra minor number
1901 will start at `1'.  For example, consider the package `foo', which is at
1902 version 1.1-3.  In the archive, the source package control file would be
1903 <filename>foo_1.1-3.dsc</filename>.  The upstream version is `1.1' and the
1904 Debian revision is `3'.  The next NMU would add a new minor number `.1' to the
1905 Debian revision; the new source control file would be
1906 <filename>foo_1.1-3.1.dsc</filename>.
1907 </para>
1908 <para>
1909 The Debian revision minor number is needed to avoid stealing one of the package
1910 maintainer's version numbers, which might disrupt their work.  It also has the
1911 benefit of making it visually clear that a package in the archive was not made
1912 by the official maintainer.
1913 </para>
1914 <para>
1915 If there is no <replaceable>debian-revision</replaceable> component in the
1916 version number then one should be created, starting at `0.1' (but in case of a
1917 debian native package still upload it as native package).  If it is absolutely
1918 necessary for someone other than the usual maintainer to make a release based
1919 on a new upstream version then the person making the release should start with
1920 the <replaceable>debian-revision</replaceable> value `0.1'.  The usual
1921 maintainer of a package should start their
1922 <replaceable>debian-revision</replaceable> numbering at `1'.
1923 </para>
1924 <para>
1925 If you upload a package to testing or stable, sometimes, you need to fork the
1926 version number tree.  For this, version numbers like 1.1-3sarge0.1 could be
1927 used.
1928 </para>
1929 </section>
1931 <section id="nmu-changelog">
1932 <title>Source NMUs must have a new changelog entry</title>
1933 <para>
1934 Anyone who is doing a source NMU must create a changelog entry, describing
1935 which bugs are fixed by the NMU, and generally why the NMU was required and
1936 what it fixed.  The changelog entry will have the email address of the person
1937 who uploaded it in the log entry and the NMU version number in it.
1938 </para>
1939 <para>
1940 By convention, source NMU changelog entries start with the line
1941 </para>
1942 <screen>
1943   * Non-maintainer upload
1944 </screen>
1945 </section>
1947 <section id="nmu-patch">
1948 <title>Source NMUs and the Bug Tracking System</title>
1949 <para>
1950 Maintainers other than the official package maintainer should make as few
1951 changes to the package as possible, and they should always send a patch as a
1952 unified context diff (<literal>diff -u</literal>) detailing their changes to
1953 the Bug Tracking System.
1954 </para>
1955 <para>
1956 What if you are simply recompiling the package?  If you just need to recompile
1957 it for a single architecture, then you may do a binary-only NMU as described in
1958 <xref linkend="binary-only-nmu"/> which doesn't require any patch to be sent.
1959 If you want the package to be recompiled for all architectures, then you do a
1960 source NMU as usual and you will have to send a patch.
1961 </para>
1962 <para>
1963 Bugs fixed by source NMUs used to be tagged fixed instead of closed, but since
1964 version tracking is in place, such bugs are now also closed with the NMU
1965 version.
1966 </para>
1967 <para>
1968 Also, after doing an NMU, you have to send the information to the existing bugs
1969 that are fixed by your NMU, including the unified diff.  Historically, it was
1970 custom to open a new bug and include a patch showing all the changes you have
1971 made.  The normal maintainer will either apply the patch or employ an alternate
1972 method of fixing the problem.  Sometimes bugs are fixed independently upstream,
1973 which is another good reason to back out an NMU's patch.  If the maintainer
1974 decides not to apply the NMU's patch but to release a new version, the
1975 maintainer needs to ensure that the new upstream version really fixes each
1976 problem that was fixed in the non-maintainer release.
1977 </para>
1978 <para>
1979 In addition, the normal maintainer should <emphasis>always</emphasis> retain
1980 the entry in the changelog file documenting the non-maintainer upload -- and of
1981 course, also keep the changes.  If you revert some of the changes, please
1982 reopen the relevant bug reports.
1983 </para>
1984 </section>
1986 <section id="nmu-build">
1987 <title>Building source NMUs</title>
1988 <para>
1989 Source NMU packages are built normally.  Pick a distribution using the same
1990 rules as found in <xref linkend="distribution"/> , follow the other
1991 instructions in <xref linkend="upload"/> .
1992 </para>
1993 <para>
1994 Make sure you do <emphasis>not</emphasis> change the value of the maintainer in
1995 the <filename>debian/control</filename> file.  Your name as given in the NMU
1996 entry of the <filename>debian/changelog</filename> file will be used for
1997 signing the changes file.
1998 </para>
1999 </section>
2001 <section id="ack-nmu">
2002 <title>Acknowledging an NMU</title>
2003 <para>
2004 If one of your packages has been NMU'ed, you have to incorporate the changes in
2005 your copy of the sources.  This is easy, you just have to apply the patch that
2006 has been sent to you.  Once this is done, you have to close the bugs that have
2007 been tagged fixed by the NMU.  The easiest way is to use the
2008 <literal>-v</literal> option of <command>dpkg-buildpackage</command>, as this
2009 allows you to include just all changes since your last maintainer upload.
2010 Alternatively, you can close them manually by sending the required mails to the
2011 BTS or by adding the required <literal>closes: #nnnn</literal> in the changelog
2012 entry of your next upload.
2013 </para>
2014 <para>
2015 In any case, you should not be upset by the NMU.  An NMU is not a personal
2016 attack against the maintainer.  It is a proof that someone cares enough about
2017 the package that they were willing to help you in your work, so you should be
2018 thankful.  You may also want to ask them if they would be interested in helping
2019 you on a more frequent basis as co-maintainer or backup maintainer (see <xref
2020 linkend="collaborative-maint"/> ).
2021 </para>
2022 </section>
2024 <section id="nmu-vs-qa">
2025 <title>NMU vs QA uploads</title>
2026 <para>
2027 Unless you know the maintainer is still active, it is wise to check the package
2028 to see if it has been orphaned.  The current list of orphaned packages which
2029 haven't had their maintainer set correctly is available at <ulink
2030 url=""></ulink>.  If you perform an NMU on an
2031 improperly orphaned package, please set the maintainer to ``Debian QA Group
2032 &lt;;''.
2033 </para>
2034 </section>
2036 <section id="nmu-who">
2037 <title>Who can do an NMU</title>
2038 <para>
2039 Only official, registered Debian Developers can do binary or source NMUs.  A
2040 Debian Developer is someone who has their key in the Debian key ring.
2041 Non-developers, however, are encouraged to download the source package and
2042 start hacking on it to fix problems; however, rather than doing an NMU, they
2043 should just submit worthwhile patches to the Bug Tracking System.  Maintainers
2044 almost always appreciate quality patches and bug reports.
2045 </para>
2046 </section>
2048 <section id="nmu-terms">
2049 <title>Terminology</title>
2050 <para>
2051 There are two new terms used throughout this section: ``binary-only NMU'' and
2052 ``source NMU''.  These terms are used with specific technical meaning
2053 throughout this document.  Both binary-only and source NMUs are similar, since
2054 they involve an upload of a package by a developer who is not the official
2055 maintainer of that package.  That is why it's a
2056 <emphasis>non-maintainer</emphasis> upload.
2057 </para>
2058 <para>
2059 A source NMU is an upload of a package by a developer who is not the official
2060 maintainer, for the purposes of fixing a bug in the package.  Source NMUs
2061 always involves changes to the source (even if it is just a change to
2062 <filename>debian/changelog</filename>).  This can be either a change to the
2063 upstream source, or a change to the Debian bits of the source.  Note, however,
2064 that source NMUs may also include architecture-dependent packages, as well as
2065 an updated Debian diff.
2066 </para>
2067 <para>
2068 A binary-only NMU is a recompilation and upload of a binary package for a given
2069 architecture.  As such, it is usually part of a porting effort.  A binary-only
2070 NMU is a non-maintainer uploaded binary version of a package, with no source
2071 changes required.  There are many cases where porters must fix problems in the
2072 source in order to get them to compile for their target architecture; that
2073 would be considered a source NMU rather than a binary-only NMU.  As you can
2074 see, we don't distinguish in terminology between porter NMUs and non-porter
2075 NMUs.
2076 </para>
2077 <para>
2078 Both classes of NMUs, source and binary-only, can be lumped under the term
2079 ``NMU''.  However, this often leads to confusion, since most people think
2080 ``source NMU'' when they think ``NMU''.  So it's best to be careful: always use
2081 ``binary NMU'' or ``binNMU'' for binary-only NMUs.
2082 </para>
2083 </section>
2085 </section>
2087 <section id="collaborative-maint">
2088 <title>Collaborative maintenance</title>
2089 <para>
2090 Collaborative maintenance is a term describing the sharing of Debian package
2091 maintenance duties by several people.  This collaboration is almost always a
2092 good idea, since it generally results in higher quality and faster bug fix
2093 turnaround times.  It is strongly recommended that packages with a priority of
2094 <literal>Standard</literal> or which are part of the base set have
2095 co-maintainers.
2096 </para>
2097 <para>
2098 Generally there is a primary maintainer and one or more co-maintainers.  The
2099 primary maintainer is the person whose name is listed in the
2100 <literal>Maintainer</literal> field of the <filename>debian/control</filename>
2101 file.  Co-maintainers are all the other maintainers.
2102 </para>
2103 <para>
2104 In its most basic form, the process of adding a new co-maintainer is quite
2105 easy:
2106 </para>
2107 <itemizedlist>
2108 <listitem>
2109 <para>
2110 Setup the co-maintainer with access to the sources you build the package from.
2111 Generally this implies you are using a network-capable version control system,
2112 such as <command>CVS</command> or <command>Subversion</command>.  Alioth (see
2113 <xref linkend="alioth"/> ) provides such tools, amongst others.
2114 </para>
2115 </listitem>
2116 <listitem>
2117 <para>
2118 Add the co-maintainer's correct maintainer name and address to the
2119 <literal>Uploaders</literal> field in the global part of the
2120 <filename>debian/control</filename> file.
2121 </para>
2122 <screen>
2123 : John Buzz &lt;;, Adam Rex &lt;;
2124 </screen>
2125 </listitem>
2126 <listitem>
2127 <para>
2128 Using the PTS (<xref linkend="pkg-tracking-system"/> ), the co-maintainers
2129 should subscribe themselves to the appropriate source package.
2130 </para>
2131 </listitem>
2132 </itemizedlist>
2133 <para>
2134 Another form of collaborative maintenance is team maintenance, which is
2135 recommended if you maintain several packages with the same group of developers.
2136 In that case, the Maintainer and Uploaders field of each package must be
2137 managed with care.  It is recommended to choose between one of the two
2138 following schemes:
2139 </para>
2140 <orderedlist numeration="arabic">
2141 <listitem>
2142 <para>
2143 Put the team member mainly responsible for the package in the Maintainer field.
2144 In the Uploaders, put the mailing list address, and the team members who care
2145 for the package.
2146 </para>
2147 </listitem>
2148 <listitem>
2149 <para>
2150 Put the mailing list address in the Maintainer field.  In the Uploaders field,
2151 put the team members who care for the package.  In this case, you must make
2152 sure the mailing list accept bug reports without any human interaction (like
2153 moderation for non-subscribers).
2154 </para>
2155 </listitem>
2156 </orderedlist>
2157 <para>
2158 In any case, it is a bad idea to automatically put all team members in the
2159 Uploaders field.  It clutters the Developer's Package Overview listing (see
2160 <xref linkend="ddpo"/> ) with packages one doesn't really care for, and creates
2161 a false sense of good maintenance.
2162 </para>
2163 </section>
2165 <section id="testing">
2166 <title>The testing distribution</title>
2167 <section id="testing-basics">
2168 <title>Basics</title>
2169 <para>
2170 Packages are usually installed into the `testing' distribution after they have
2171 undergone some degree of testing in unstable.
2172 </para>
2173 <para>
2174 They must be in sync on all architectures and mustn't have dependencies that
2175 make them uninstallable; they also have to have generally no known
2176 release-critical bugs at the time they're installed into testing.  This way,
2177 `testing' should always be close to being a release candidate.  Please see
2178 below for details.
2179 </para>
2180 </section>
2182 <section id="testing-unstable">
2183 <title>Updates from unstable</title>
2184 <para>
2185 The scripts that update the <emphasis>testing</emphasis> distribution are run
2186 each day after the installation of the updated packages; these scripts are
2187 called <emphasis>britney</emphasis>.  They generate the
2188 <filename>Packages</filename> files for the <emphasis>testing</emphasis>
2189 distribution, but they do so in an intelligent manner; they try to avoid any
2190 inconsistency and to use only non-buggy packages.
2191 </para>
2192 <para>
2193 The inclusion of a package from <emphasis>unstable</emphasis> is conditional on
2194 the following:
2195 </para>
2196 <itemizedlist>
2197 <listitem>
2198 <para>
2199 The package must have been available in <emphasis>unstable</emphasis> for 2, 5
2200 or 10 days, depending on the urgency (high, medium or low).  Please note that
2201 the urgency is sticky, meaning that the highest urgency uploaded since the
2202 previous testing transition is taken into account.  Those delays may be doubled
2203 during a freeze, or testing transitions may be switched off altogether;
2204 </para>
2205 </listitem>
2206 <listitem>
2207 <para>
2208 It must have the same number or fewer release-critical bugs than the version
2209 currently available in <emphasis>testing</emphasis>;
2210 </para>
2211 </listitem>
2212 <listitem>
2213 <para>
2214 It must be available on all architectures on which it has previously been built
2215 in unstable.  <xref linkend="madison"/> may be of interest to check that
2216 information;
2217 </para>
2218 </listitem>
2219 <listitem>
2220 <para>
2221 It must not break any dependency of a package which is already available in
2222 <emphasis>testing</emphasis>;
2223 </para>
2224 </listitem>
2225 <listitem>
2226 <para>
2227 The packages on which it depends must either be available in
2228 <emphasis>testing</emphasis> or they must be accepted into
2229 <emphasis>testing</emphasis> at the same time (and they will be if they fulfill
2230 all the necessary criteria);
2231 </para>
2232 </listitem>
2233 </itemizedlist>
2234 <para>
2235 To find out whether a package is progressing into testing or not, see the
2236 testing script output on the <ulink
2237 url="">web page of the testing
2238 distribution</ulink>, or use the program <command>grep-excuses</command> which
2239 is in the <systemitem role="package">devscripts</systemitem> package.  This
2240 utility can easily be used in a <citerefentry>
2241 <refentrytitle>crontab</refentrytitle> <manvolnum>5</manvolnum> </citerefentry>
2242 to keep yourself informed of the progression of your packages into
2243 <emphasis>testing</emphasis>.
2244 </para>
2245 <para>
2246 The <filename>update_excuses</filename> file does not always give the precise
2247 reason why the package is refused; you may have to find it on your own by
2248 looking for what would break with the inclusion of the package.  The <ulink
2249 url="">testing web page</ulink> gives some
2250 more information about the usual problems which may be causing such troubles.
2251 </para>
2252 <para>
2253 Sometimes, some packages never enter <emphasis>testing</emphasis> because the
2254 set of inter-relationship is too complicated and cannot be sorted out by the
2255 scripts.  See below for details.
2256 </para>
2257 <para>
2258 Some further dependency analysis is shown on <ulink
2259 url=""></ulink> — but be warned, this page also
2260 shows build dependencies which are not considered by britney.
2261 </para>
2262 <section id="outdated">
2263 <title>out-of-date</title>
2264 <para>
2265 For the testing migration script, outdated means: There are different versions
2266 in unstable for the release architectures (except for the architectures in
2267 fuckedarches; fuckedarches is a list of architectures that don't keep up (in
2268, but currently, it's empty).  outdated has nothing whatsoever to
2269 do with the architectures this package has in testing.
2270 </para>
2271 <para>
2272 Consider this example:
2273 </para>
2274 <informaltable pgwide="1">
2275 <tgroup cols="3">
2276 <thead>
2277 <row>
2278 <entry></entry>
2279 <entry>alpha</entry>
2280 <entry>arm</entry>
2281 </row>
2282 </thead>
2283 <tbody>
2284 <row>
2285 <entry>testing</entry>
2286 <entry>1</entry>
2287 <entry>-</entry>
2288 </row>
2289 <row>
2290 <entry>unstable</entry>
2291 <entry>1</entry>
2292 <entry>2</entry>
2293 </row>
2294 </tbody>
2295 </tgroup>
2296 </informaltable>
2297 <para>
2298 The package is out of date on alpha in unstable, and will not go to testing.
2299 And removing foo from testing would not help at all, the package is still out
2300 of date on alpha, and will not propagate to testing.
2301 </para>
2302 <para>
2303 However, if ftp-master removes a package in unstable (here on arm):
2304 </para>
2305 <informaltable pgwide="1">
2306 <tgroup cols="4">
2307 <thead>
2308 <row>
2309 <entry></entry>
2310 <entry>alpha</entry>
2311 <entry>arm</entry>
2312 <entry>hurd-i386</entry>
2313 </row>
2314 </thead>
2315 <tbody>
2316 <row>
2317 <entry>testing</entry>
2318 <entry>1</entry>
2319 <entry>1</entry>
2320 <entry>-</entry>
2321 </row>
2322 <row>
2323 <entry>unstable</entry>
2324 <entry>2</entry>
2325 <entry>-</entry>
2326 <entry>1</entry>
2327 </row>
2328 </tbody>
2329 </tgroup>
2330 </informaltable>
2331 <para>
2332 In this case, the package is up to date on all release architectures in
2333 unstable (and the extra hurd-i386 doesn't matter, as it's not a release
2334 architecture).
2335 </para>
2336 <para>
2337 Sometimes, the question is raised if it is possible to allow packages in that
2338 are not yet built on all architectures: No.  Just plainly no.  (Except if you
2339 maintain glibc or so.)
2340 </para>
2341 </section>
2343 <section id="removals">
2344 <title>Removals from testing</title>
2345 <para>
2346 Sometimes, a package is removed to allow another package in: This happens only
2347 to allow <emphasis>another</emphasis> package to go in if it's ready in every
2348 other sense.  Suppose e.g.  that <emphasis>a</emphasis> cannot be installed
2349 with the new version of <emphasis>b</emphasis>; then <emphasis>a</emphasis> may
2350 be removed to allow <emphasis>b</emphasis> in.
2351 </para>
2352 <para>
2353 Of course, there is another reason to remove a package from testing: It's just
2354 too buggy (and having a single RC-bug is enough to be in this state).
2355 </para>
2356 <para>
2357 Furthermore, if a package has been removed from unstable, and no package in
2358 testing depends on it any more, then it will automatically be removed.
2359 </para>
2360 </section>
2362 <section id="circular">
2363 <title>circular dependencies</title>
2364 <para>
2365 A situation which is not handled very well by britney is if package
2366 <emphasis>a</emphasis> depends on the new version of package
2367 <emphasis>b</emphasis>, and vice versa.
2368 </para>
2369 <para>
2370 An example of this is:
2371 </para>
2372 <informaltable pgwide="1">
2373 <tgroup cols="3">
2374 <thead>
2375 <row>
2376 <entry></entry>
2377 <entry>testing</entry>
2378 <entry>unstable</entry>
2379 </row>
2380 </thead>
2381 <tbody>
2382 <row>
2383 <entry>a</entry>
2384 <entry>1; depends: b=1</entry>
2385 <entry>2; depends: b=2</entry>
2386 </row>
2387 <row>
2388 <entry>b</entry>
2389 <entry>1; depends: a=1</entry>
2390 <entry>2; depends: a=2</entry>
2391 </row>
2392 </tbody>
2393 </tgroup>
2394 </informaltable>
2395 <para>
2396 Neither package <emphasis>a</emphasis> nor package <emphasis>b</emphasis> is
2397 considered for update.
2398 </para>
2399 <para>
2400 Currently, this requires some manual hinting from the release team.  Please
2401 contact them by sending mail to <email></email>
2402 if this happens to one of your packages.
2403 </para>
2404 </section>
2406 <section id="s5.13.2.4">
2407 <title>influence of package in testing</title>
2408 <para>
2409 Generally, there is nothing that the status of a package in testing means for
2410 transition of the next version from unstable to testing, with two exceptions:
2411 If the RC-bugginess of the package goes down, it may go in even if it is still
2412 RC-buggy.  The second exception is if the version of the package in testing is
2413 out of sync on the different arches: Then any arch might just upgrade to the
2414 version of the source package; however, this can happen only if the package was
2415 previously forced through, the arch is in fuckedarches, or there was no binary
2416 package of that arch present in unstable at all during the testing migration.
2417 </para>
2418 <para>
2419 In summary this means: The only influence that a package being in testing has
2420 on a new version of the same package is that the new version might go in
2421 easier.
2422 </para>
2423 </section>
2425 <section id="details">
2426 <title>details</title>
2427 <para>
2428 If you are interested in details, this is how britney works:
2429 </para>
2430 <para>
2431 The packages are looked at to determine whether they are valid candidates.
2432 This gives the update excuses.  The most common reasons why a package is not
2433 considered are too young, RC-bugginess, and out of date on some arches.  For
2434 this part of britney, the release managers have hammers of various sizes to
2435 force britney to consider a package.  (Also, the base freeze is coded in that
2436 part of britney.) (There is a similar thing for binary-only updates, but this
2437 is not described here.  If you're interested in that, please peruse the code.)
2438 </para>
2439 <para>
2440 Now, the more complex part happens: Britney tries to update testing with the
2441 valid candidates; first, each package alone, and then larger and even larger
2442 sets of packages together.  Each try is accepted if testing is not more
2443 uninstallable after the update than before.  (Before and after this part, some
2444 hints are processed; but as only release masters can hint, this is probably not
2445 so important for you.)
2446 </para>
2447 <para>
2448 If you want to see more details, you can look it up on
2449 merkel:/org/ (or there in
2450 ~aba/testing/update_out to see a setup with a smaller packages file).  Via web,
2451 it's at <ulink
2452 url=""></ulink>
2453 </para>
2454 <para>
2455 The hints are available via <ulink
2456 url=""></ulink>.
2457 </para>
2458 </section>
2460 </section>
2462 <section id="t-p-u">
2463 <title>Direct updates to testing</title>
2464 <para>
2465 The testing distribution is fed with packages from unstable according to the
2466 rules explained above.  However, in some cases, it is necessary to upload
2467 packages built only for testing.  For that, you may want to upload to
2468 <emphasis>testing-proposed-updates</emphasis>.
2469 </para>
2470 <para>
2471 Keep in mind that packages uploaded there are not automatically processed, they
2472 have to go through the hands of the release manager.  So you'd better have a
2473 good reason to upload there.  In order to know what a good reason is in the
2474 release managers' eyes, you should read the instructions that they regularly
2475 give on <email></email>.
2476 </para>
2477 <para>
2478 You should not upload to <emphasis>testing-proposed-updates</emphasis> when you
2479 can update your packages through <emphasis>unstable</emphasis>.  If you can't
2480 (for example because you have a newer development version in unstable), you may
2481 use this facility, but it is recommended that you ask for authorization from
2482 the release manager first.  Even if a package is frozen, updates through
2483 unstable are possible, if the upload via unstable does not pull in any new
2484 dependencies.
2485 </para>
2486 <para>
2487 Version numbers are usually selected by adding the codename of the testing
2488 distribution and a running number, like 1.2sarge1 for the first upload through
2489 testing-proposed-updates of package version 1.2.
2490 </para>
2491 <para>
2492 Please make sure you didn't miss any of these items in your upload:
2493 </para>
2494 <itemizedlist>
2495 <listitem>
2496 <para>
2497 Make sure that your package really needs to go through
2498 <emphasis>testing-proposed-updates</emphasis>, and can't go through unstable;
2499 </para>
2500 </listitem>
2501 <listitem>
2502 <para>
2503 Make sure that you included only the minimal amount of changes;
2504 </para>
2505 </listitem>
2506 <listitem>
2507 <para>
2508 Make sure that you included an appropriate explanation in the changelog;
2509 </para>
2510 </listitem>
2511 <listitem>
2512 <para>
2513 Make sure that you've written <emphasis>testing</emphasis> or
2514 <emphasis>testing-proposed-updates</emphasis> into your target distribution;
2515 </para>
2516 </listitem>
2517 <listitem>
2518 <para>
2519 Make sure that you've built and tested your package in
2520 <emphasis>testing</emphasis>, not in <emphasis>unstable</emphasis>;
2521 </para>
2522 </listitem>
2523 <listitem>
2524 <para>
2525 Make sure that your version number is higher than the version in
2526 <emphasis>testing</emphasis> and <emphasis>testing-proposed-updates</emphasis>,
2527 and lower than in <emphasis>unstable</emphasis>;
2528 </para>
2529 </listitem>
2530 <listitem>
2531 <para>
2532 After uploading and successful build on all platforms, contact the release team
2533 at <email></email> and ask them to approve your
2534 upload.
2535 </para>
2536 </listitem>
2537 </itemizedlist>
2538 </section>
2540 <section id="faq">
2541 <title>Frequently asked questions</title>
2542 <section id="rc">
2543 <title>What are release-critical bugs, and how do they get counted?</title>
2544 <para>
2545 All bugs of some higher severities are by default considered release-critical;
2546 currently, these are critical, grave, and serious bugs.
2547 </para>
2548 <para>
2549 Such bugs are presumed to have an impact on the chances that the package will
2550 be released with the stable release of Debian: in general, if a package has
2551 open release-critical bugs filed on it, it won't get into testing, and
2552 consequently won't be released in stable.
2553 </para>
2554 <para>
2555 The unstable bug count are all release-critical bugs without either any
2556 release-tag (such as potato, woody) or with release-tag sid; also, only if they
2557 are neither fixed nor set to sarge-ignore.  The testing bug count for a package
2558 is considered to be roughly the bug count of unstable count at the last point
2559 when the testing version equalled the unstable version.
2560 </para>
2561 <para>
2562 This will change post-sarge, as soon as we have versions in the bug tracking
2563 system.
2564 </para>
2565 </section>
2567 <section id="s5.13.4.2">
2568 <title>How could installing a package into testing possibly break other packages?</title>
2569 <para>
2570 The structure of the distribution archives is such that they can only contain
2571 one version of a package; a package is defined by its name.  So when the source
2572 package acmefoo is installed into testing, along with its binary packages
2573 acme-foo-bin, acme-bar-bin, libacme-foo1 and libacme-foo-dev, the old version
2574 is removed.
2575 </para>
2576 <para>
2577 However, the old version may have provided a binary package with an old soname
2578 of a library, such as libacme-foo0.  Removing the old acmefoo will remove
2579 libacme-foo0, which will break any packages which depend on it.
2580 </para>
2581 <para>
2582 Evidently, this mainly affects packages which provide changing sets of binary
2583 packages in different versions (in turn, mainly libraries).  However, it will
2584 also affect packages upon which versioned dependencies have been declared of
2585 the ==, &lt;=, or &lt;&lt; varieties.
2586 </para>
2587 <para>
2588 When the set of binary packages provided by a source package change in this
2589 way, all the packages that depended on the old binaries will have to be updated
2590 to depend on the new binaries instead.  Because installing such a source
2591 package into testing breaks all the packages that depended on it in testing,
2592 some care has to be taken now: all the depending packages must be updated and
2593 ready to be installed themselves so that they won't be broken, and, once
2594 everything is ready, manual intervention by the release manager or an assistant
2595 is normally required.
2596 </para>
2597 <para>
2598 If you are having problems with complicated groups of packages like this,
2599 contact debian-devel or debian-release for help.
2600 </para>
2601 </section>
2603 </section>
2605 </section>
2607 </chapter>