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