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