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