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