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