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