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