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