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