/[ddp]/manuals/trunk/developers-reference/pkgs.dbk
ViewVC logotype

Diff of /manuals/trunk/developers-reference/pkgs.dbk

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 5219 by he, Sat Jun 7 10:47:12 2008 UTC revision 7071 by hertzog, Sun Feb 14 17:46:38 2010 UTC
# Line 28  description of the package, the license Line 28  description of the package, the license
28  current URL where it can be downloaded from.  current URL where it can be downloaded from.
29  </para>  </para>
30  <para>  <para>
31  You should set the subject of the bug to ``ITP: <replaceable>foo</replaceable>  You should set the subject of the bug to <literal>ITP:
32  -- <replaceable>short description</replaceable>'', substituting the name of the  <replaceable>foo</replaceable> -- <replaceable>short
33  new package for <replaceable>foo</replaceable>.  The severity of the bug report  description</replaceable></literal>, substituting the name of the new
34  must be set to <literal>wishlist</literal>.  If you feel it's necessary, send  package for <replaceable>foo</replaceable>.
35  a copy to &email-debian-devel; by putting the address in the  The severity of the bug report must be set to <literal>wishlist</literal>.
36  <literal>X-Debbugs-CC:</literal> header of the message (no, don't use  Please send a copy to &email-debian-devel; by using the X-Debbugs-CC
37  <literal>CC:</literal>, because that way the message's subject won't indicate  header (don't use CC:, because that way the message's subject won't
38  the bug number).  indicate the bug number). If you are packaging so many new packages (>10)
39  </para>  that notifying the mailing list in seperate messages is too disruptive,
40  <para>  send a summary after filing the bugs to the debian-devel list instead.
41  Please include a <literal>Closes:  This will inform the other developers about upcoming packages and will
42  bug#<replaceable>nnnnn</replaceable></literal> entry in the changelog of the  allow a review of your description and package name.
43  new package in order for the bug report to be automatically closed once the new  </para>
44  package is installed in the archive (see <xref linkend="upload-bugfix"/> ).  <para>
45    Please include a <literal>Closes: #<replaceable>nnnnn</replaceable></literal>
46    entry in the changelog of the new package in order for the bug report to
47    be automatically closed once the new package is installed in the archive
48    (see <xref linkend="upload-bugfix"/>).
49    </para>
50    <para>
51    If you think your package needs some explanations for the administrators of the
52    NEW package queue, include them in your changelog, send to ftpmaster@debian.org
53    a reply to the email you receive as a maintainer after your upload, or reply to
54    the rejection email in case you are already re-uploading.
55  </para>  </para>
56  <para>  <para>
57  When closing security bugs include CVE numbers as well as the Closes: #nnnnn.  When closing security bugs include CVE numbers as well as the Closes: #nnnnn.
# Line 213  distinction between the original sources Line 223  distinction between the original sources
223  <listitem>  <listitem>
224  <para>  <para>
225  the (more common) packages where there's an original source tarball file  the (more common) packages where there's an original source tarball file
226  accompanied by another file that contains the patches applied for Debian  accompanied by another file that contains the changes made by Debian
227  </para>  </para>
228  </listitem>  </listitem>
229  </itemizedlist>  </itemizedlist>
230  <para>  <para>
231  For the native packages, the source package includes a Debian source control  For the native packages, the source package includes a Debian source control
232  file (<literal>.dsc</literal>) and the source tarball  file (<literal>.dsc</literal>) and the source tarball
233  (<literal>.tar.gz</literal>).  A source package of a non-native package  (<literal>.tar.{gz,bz2,lzma}</literal>). A source package of a non-native package
234  includes a Debian source control file, the original source tarball  includes a Debian source control file, the original source tarball
235  (<literal>.orig.tar.gz</literal>) and the Debian patches  (<literal>.orig.tar.{gz,bz2,lzma}</literal>) and the Debian changes
236  (<literal>.diff.gz</literal>).  (<literal>.diff.gz</literal> for the source format “1.0” or
237    <literal>.debian.tar.{gz,bz2,lzma}</literal> for the source format “3.0 (quilt)”).
238  </para>  </para>
239  <para>  <para>
240  Whether a package is native or not is determined when it is built by  With source format “1.0”, whether a package is native or not was determined
241  <citerefentry> <refentrytitle>dpkg-buildpackage</refentrytitle>  by <command>dpkg-source</command> at build time. Nowadays it is recommended
242  <manvolnum>1</manvolnum> </citerefentry>.  The rest of this section relates  to be explicit about the desired source format by putting either “3.0 (quilt)”
243  only to non-native packages.  or “3.0 (native)” in <filename>debian/source/format</filename>.
244    The rest of this section relates only to non-native packages.
245  </para>  </para>
246  <para>  <para>
247  The first time a version is uploaded which corresponds to a particular upstream  The first time a version is uploaded which corresponds to a particular upstream
# Line 241  will not need to be re-uploaded. Line 253  will not need to be re-uploaded.
253  <para>  <para>
254  By default, <command>dpkg-genchanges</command> and  By default, <command>dpkg-genchanges</command> and
255  <command>dpkg-buildpackage</command> will include the original source tar file  <command>dpkg-buildpackage</command> will include the original source tar file
256  if and only if the Debian revision part of the source version number is 0 or 1,  if and only if the current changelog entry has a different upstream version
257  indicating a new upstream version.  This behavior may be modified by using  from the preceding entry. This behavior may be modified by using
258  <literal>-sa</literal> to always include it or <literal>-sd</literal> to always  <literal>-sa</literal> to always include it or <literal>-sd</literal> to always
259  leave it out.  leave it out.
260  </para>  </para>
# Line 255  the archive. Line 267  the archive.
267  </para>  </para>
268  <para>  <para>
269  Please notice that, in non-native packages, permissions on files that are not  Please notice that, in non-native packages, permissions on files that are not
270  present in the .orig.tar.gz will not be preserved, as diff does not store file  present in the .orig.tar.{gz,bz2} will not be preserved, as diff does not store file
271  permissions in the patch.  permissions in the patch. However when using source format “3.0 (quilt)”,
272    permissions of files inside the <filename>debian</filename> directory are
273    preserved since they are stored in a tar archive.
274  </para>  </para>
275  </section>  </section>
276    
# Line 270  The package build process extracts this Line 284  The package build process extracts this
284  </para>  </para>
285  <para>  <para>
286  There are several possible values for this field: <literal>stable</literal>,  There are several possible values for this field: <literal>stable</literal>,
287  <literal>unstable</literal>, <litersl>testing-proposed-updates</literal> and  <literal>unstable</literal>, <literal>testing-proposed-updates</literal> and
288  <literal>experimental</literal>.  Normally, packages are uploaded into  <literal>experimental</literal>.  Normally, packages are uploaded into
289  <literal>unstable</literal>.  <literal>unstable</literal>.
290  </para>  </para>
# Line 287  time. Line 301  time.
301  <title>Special case: uploads to the <literal>stable</literal> and  <title>Special case: uploads to the <literal>stable</literal> and
302  <literal>oldstable</literal> distributions</title>  <literal>oldstable</literal> distributions</title>
303  <para>  <para>
304  Uploading to <literal>stable</literal> means that the package will transfered  Uploading to <literal>stable</literal> means that the package will transferred
305  to the <literal>proposed-updates-new</literal> queue for review by the stable  to the <literal>proposed-updates-new</literal> queue for review by the stable
306  release managers, and if approved will be installed in  release managers, and if approved will be installed in
307  <filename>stable-proposed-updates</filename> directory of the Debian archive.  <filename>stable-proposed-updates</filename> directory of the Debian archive.
# Line 372  section</link> for details. Line 386  section</link> for details.
386  <title>Uploading to <literal>ftp-master</literal></title>  <title>Uploading to <literal>ftp-master</literal></title>
387  <para>  <para>
388  To upload a package, you should upload the files (including the signed changes  To upload a package, you should upload the files (including the signed changes
389  and dsc-file) with anonymous ftp to <literal>&ftp-master-host;</literal> in  and dsc-file) with anonymous ftp to <literal>&ftp-upload-host;</literal> in
390  the directory <ulink  the directory <ulink
391  url="ftp://&ftp-master-host;&upload-queue;">&upload-queue;</ulink>.  url="ftp://&ftp-upload-host;&upload-queue;">&upload-queue;</ulink>.
392  To get the files processed there, they need to be signed with a key in the  To get the files processed there, they need to be signed with a key in the
393  Debian Developers keyring or the Debian Maintainers keyring  Debian Developers keyring or the Debian Maintainers keyring
394  (see <ulink url="&url-wiki-dm;"></ulink>).  (see <ulink url="&url-wiki-dm;"></ulink>).
# Line 390  linkend="dput"/> useful when uploading p Line 404  linkend="dput"/> useful when uploading p
404  automate the process of uploading packages into Debian.  automate the process of uploading packages into Debian.
405  </para>  </para>
406  <para>  <para>
407  For removing packages, please see the README file in that ftp directory, and  For removing packages, please see
408    <ulink url="ftp://&ftp-upload-host;&upload-queue;/README"/> and
409  the Debian package <xref linkend="dcut"/> .  the Debian package <xref linkend="dcut"/> .
410  </para>  </para>
411  </section>  </section>
412    
413  <section id="delayed-incoming">  <section id="delayed-incoming">
414  <title>Delayed uploads</title>  <title>Delayed uploads</title>
415    
416  <para>  <para>
417  Delayed uploads are done for the moment via the delayed queue at <literal>gluck  It is sometimes useful to upload a package immediately, but to want this
418  </literal>. The upload-directory is  package to arrive in the archive only a few days later. For example,
419  <literal>gluck:~tfheen/DELAYED/[012345678]-day</literal>. 0-day is uploaded  when preparing a <link linkend="nmu">Non-maintainer Upload</link>,
420  multiple times per day to <literal>&ftp-master-host;</literal>.  you might want to give the maintainer a few days to react.
 </para>  
 <para>  
 With a fairly recent dput, this section  
421  </para>  </para>
422  <screen>  
 [tfheen_delayed]  
 method = scp  
 fqdn = gluck.debian.org  
 incoming = ~tfheen  
 </screen>  
423  <para>  <para>
424  in <filename>~/.dput.cf</filename> should work fine for uploading to the  An upload to the delayed directory keeps the package in
425  <literal>DELAYED</literal> queue.  <ulink url="http://ftp-master.debian.org/deferred.html">
426    the deferred uploads queue"</ulink>.
427    When the specified waiting time is over, the package is moved into
428    the regular incoming directory for processing.
429    This is done through automatic uploading to
430    <literal>&ftp-upload-host;</literal> in upload-directory
431    <literal>DELAYED/[012345678]-day</literal>. 0-day is uploaded
432    multiple times per day to <literal>&ftp-upload-host;</literal>.
433  </para>  </para>
434  <para>  <para>
435  <emphasis>Note:</emphasis> Since this upload queue goes to  With dput, you can use the <literal>--delayed <replaceable>DELAY</replaceable></literal>
436  <literal>&ftp-master-host;</literal>, the prescription found in <xref  parameter to put the package into one of the queues.
 linkend="upload-ftp-master"/> applies here as well.  
437  </para>  </para>
438  </section>  </section>
439    
# Line 438  see section <xref linkend="bug-security" Line 452  see section <xref linkend="bug-security"
452  <section id="s5.6.5">  <section id="s5.6.5">
453  <title>Other upload queues</title>  <title>Other upload queues</title>
454  <para>  <para>
455  The scp queues on <literal>&ftp-master-host;</literal>, and <literal>  There is an alternative upload queue in Europe at <ulink
456  security.debian.org</literal> are mostly unusable due to the login restrictions  url="ftp://&ftp-eu-upload-host;&upload-queue;"/>. It operates in
457  on those hosts.  the same way as <literal>&ftp-upload-host;</literal>, but should be faster
458  </para>  for European developers.
 <para>  
 The anonymous queues on ftp.uni-erlangen.de and ftp.uk.debian.org are currently  
 down.  Work is underway to resurrect them.  
459  </para>  </para>
460  <para>  <para>
461  The queues on master.debian.org, samosa.debian.org, master.debian.or.jp, and  Packages can also be uploaded via ssh to
462  ftp.chiark.greenend.org.uk are down permanently, and will not be resurrected.  <literal>&ssh-upload-host;</literal>; files should be put
463  The queue in Japan will be replaced with a new queue on hp.debian.or.jp some  <literal>/srv/upload.debian.org/UploadQueue</literal>. This queue does
464  day.  not support <xref linkend="delayed-incoming">delayed uploads</xref>.
465  </para>  </para>
466  </section>  </section>
467    
# Line 508  file</literal>. Line 519  file</literal>.
519  <para>  <para>
520  To alter the actual section that a package is put in, you need to first make  To alter the actual section that a package is put in, you need to first make
521  sure that the <filename>debian/control</filename> file in your package is  sure that the <filename>debian/control</filename> file in your package is
522  accurate.  Next, send an email &email-override; or submit a  accurate.  Next, submit a
523  bug against <systemitem role="package">ftp.debian.org</systemitem> requesting  bug against <systemitem role="package">ftp.debian.org</systemitem> requesting
524  that the section or priority for your package be changed from the old section  that the section or priority for your package be changed from the old section
525  or priority to the new one.  Be sure to explain your reasoning.  or priority to the new one. Use a Subject like
526    <literal>override: PACKAGE1:section/priority, [...],
527      PACKAGEX:section/priority</literal>, and include the justification for the
528    change in the body of the bug report.
529  </para>  </para>
530  <para>  <para>
531  For more information about <literal>override files</literal>, see  For more information about <literal>override files</literal>, see
# Line 662  procedure</ulink>. Line 676  procedure</ulink>.
676  If the bug is real but it's caused by another package, just reassign the bug to  If the bug is real but it's caused by another package, just reassign the bug to
677  the right package.  If you don't know which package it should be reassigned to,  the right package.  If you don't know which package it should be reassigned to,
678  you should ask for help on <link linkend="irc-channels">IRC</link> or  you should ask for help on <link linkend="irc-channels">IRC</link> or
679  on &email-debian-devel;.  Please make sure that the  on &email-debian-devel;.  Please inform the maintainer(s) of the package
680  maintainer(s) of the package the bug is reassigned to know why you reassigned  you reassign the bug to, for example by Cc:ing the message that does the
681  it.  reassign to <email>packagename@packages.debian.org</email> and explaining
682    your reasons in that mail. Please note that a simple reassignment is
683    <emphasis>not</emphasis> e-mailed to the maintainers of the package
684    being reassigned to, so they won't know about it until they look at
685    a bug overview for their packages.
686  </para>  </para>
687  <para>  <para>
688    If the bug affects the operation of your package, please consider
689    cloning the bug and reassigning the clone to the package that really
690    causes the behavior. Otherwise, the bug will not be shown in your
691    package's bug list, possibly causing users to report the same bug over
692    and over again. You should block "your" bug with the reassigned, cloned
693    bug to document the relationship.
694    </para>
695    </listitem>
696    <listitem>
697    <para>
698  Sometimes you also have to adjust the severity of the bug so that it matches  Sometimes you also have to adjust the severity of the bug so that it matches
699  our definition of the severity.  That's because people tend to inflate the  our definition of the severity.  That's because people tend to inflate the
700  severity of bugs to make sure their bugs are fixed quickly.  Some bugs may even  severity of bugs to make sure their bugs are fixed quickly.  Some bugs may even
# Line 721  several developers working on the same p Line 749  several developers working on the same p
749  </listitem>  </listitem>
750  <listitem>  <listitem>
751  <para>  <para>
752  Once a corrected package is available in the <literal>unstable</literal>  Once a corrected package is available in the archive, the bug should be
753  distribution, you can close the bug.  This can be done automatically, read  closed indicating the version in which it was fixed. This can be done
754  <xref linkend="upload-bugfix"/> .  automatically, read <xref linkend="upload-bugfix"/>.
755  </para>  </para>
756  </listitem>  </listitem>
757  </orderedlist>  </orderedlist>
# Line 810  outstanding security problems, helping m Line 838  outstanding security problems, helping m
838  fixing them themselves, sending security advisories, and maintaining  fixing them themselves, sending security advisories, and maintaining
839  <literal>security.debian.org</literal>.  <literal>security.debian.org</literal>.
840  </para>  </para>
 <!-- information about the security database goes here once it's ready -->  
 <!-- (mdz) -->  
841  <para>  <para>
842  When you become aware of a security-related bug in a Debian package, whether or  When you become aware of a security-related bug in a Debian package, whether or
843  not you are the maintainer, collect pertinent information about the problem,  not you are the maintainer, collect pertinent information about the problem,
844  and promptly contact the security team at  and promptly contact the security team at
845  &email-security-team; as soon as possible.  <emphasis  &email-security-team; as soon as possible.  <emphasis
846  role="strong">DO NOT UPLOAD</emphasis> any packages for <literal>stable</literal>;  role="strong">DO NOT UPLOAD</emphasis> any packages for <literal>stable</literal>
847   the security team will do that.  Useful information includes, for example:  without contacting the team.  Useful information includes, for example:
848  </para>  </para>
849  <itemizedlist>  <itemizedlist>
850  <listitem>  <listitem>
# Line 853  linkend="bug-security-advisories"/> ) Line 879  linkend="bug-security-advisories"/> )
879  </para>  </para>
880  </listitem>  </listitem>
881  </itemizedlist>  </itemizedlist>
882    <para>As the maintainer of the package, you have the responsibility to
883    maintain it, even in the stable release. You are in the best position
884    to evaluate patches and test updated packages, so please see the sections
885    below on how to prepare packages for the Security Team to handle.</para>
886    
887    <section id="bug-security-tracker">
888    <title>The Security Tracker</title>
889    <para>
890    The security team maintains a central database, the
891    <ulink url="http://security-tracker.debian.org/">Debian Security Tracker</ulink>.
892    This contains all public information that is known about security issues:
893    which packages and versions are affected or fixed, and thus whether stable,
894    testing and/or unstable are vulnerable. Information that is still confidential
895    is not added to the tracker.
896    </para>
897    <para>
898    You can search it for a specific issue, but also on package name. Look
899    for your package to see which issues are still open. If you can, please provide
900    more information about those issues, or help to address them in your package.
901    Instructions are on the tracker web pages.
902    </para>
903    </section>
904    
905  <section id="bug-security-confidentiality">  <section id="bug-security-confidentiality">
906  <title>Confidentiality</title>  <title>Confidentiality</title>
907  <para>  <para>
# Line 922  There are two reasons for releasing info Line 971  There are two reasons for releasing info
971  requested: the problem has been known for a while, or the problem or exploit  requested: the problem has been known for a while, or the problem or exploit
972  has become public.  has become public.
973  </para>  </para>
974    <para>
975    The Security Team has a PGP-key to enable encrypted communication about
976    sensitive issues. See the <ulink url="http://www.debian.org/security/faq#contact">Security Team FAQ</ulink> for details.
977    </para>
978  </section>  </section>
979    
980  <section id="bug-security-advisories">  <section id="bug-security-advisories">
# Line 1058  Be sure to verify the following items: Line 1111  Be sure to verify the following items:
1111  <itemizedlist>  <itemizedlist>
1112  <listitem>  <listitem>
1113  <para>  <para>
1114  Target the right distribution in your <filename>debian/changelog</filename>.  <emphasis role="strong">Target the right distribution</emphasis>
1115    in your <filename>debian/changelog</filename>.
1116  For <literal>stable</literal> this is <literal>stable-security</literal> and  For <literal>stable</literal> this is <literal>stable-security</literal> and
1117  for testing this is <literal>testing-security</literal>, and for the previous  for <literal>testing</literal> this is <literal>testing-security</literal>, and for the previous
1118  stable release, this is <literal>oldstable-security</literal>.  Do not target  stable release, this is <literal>oldstable-security</literal>.  Do not target
1119  <replaceable>distribution</replaceable><literal>-proposed-updates</literal> or  <replaceable>distribution</replaceable><literal>-proposed-updates</literal> or
1120  <literal>stable</literal>!  <literal>stable</literal>!
# Line 1068  stable release, this is <literal>oldstab Line 1122  stable release, this is <literal>oldstab
1122  </listitem>  </listitem>
1123  <listitem>  <listitem>
1124  <para>  <para>
1125  The upload should have urgency=high.  The upload should have <emphasis role="strong">urgency=high</emphasis>.
1126  </para>  </para>
1127  </listitem>  </listitem>
1128  <listitem>  <listitem>
1129  <para>  <para>
1130  Make descriptive, meaningful changelog entries.  Others will rely on them to  Make descriptive, meaningful changelog entries.  Others will rely on them to
1131  determine whether a particular bug was fixed.  Always include an external  determine whether a particular bug was fixed.  Add <literal>closes:</literal>
1132  reference, preferably a CVE identifier, so that it can be cross-referenced.  statements for any <emphasis role="strong">Debian bugs</emphasis> filed.
1133  Include the same information in the changelog for <literal>unstable</literal>,  Always include an external reference, preferably a <emphasis role="strong">CVE
1134  so that it is clear  identifier</emphasis>, so that it can be cross-referenced. However, if a CVE
1135  that the same bug was fixed, as this is very helpful when verifying that the  identifier has not yet been assigned, do not wait for it but continue the
1136  bug is fixed in the next stable release.  If a CVE identifier has not yet been  process. The identifier can be cross-referenced later.
 assigned, the security team will request one so that it can be included in the  
 package and in the advisory.  
1137  </para>  </para>
1138  </listitem>  </listitem>
1139  <listitem>  <listitem>
1140  <para>  <para>
1141  Make sure the version number is proper.  It must be greater than the current  Make sure the <emphasis role="strong">version number</emphasis> is proper.
1142  package, but less than package versions in later distributions.  If in doubt,  It must be greater than the current package, but less than package versions in
1143  test it with <literal>dpkg --compare-versions</literal>.  Be careful not to  later distributions.  If in doubt, test it with <literal>dpkg
1144  re-use a version number that you have already used for a previous upload.  For  --compare-versions</literal>.  Be careful not to re-use a version number that
1145  <literal>testing</literal>, there must be a higher version in  you have already used for a previous upload, or one that conflicts with a
1146  <literal>unstable</literal>.  If there is none yet (for example, if  binNMU. The convention is to append
1147  <literal>testing</literal> and <literal>unstable</literal> have the same  <literal>+</literal><replaceable>codename</replaceable><literal>1</literal>, e.g.
1148  version) you must upload a new version to <literal>unstable</literal> first.  <literal>1:2.4.3-4+etch1</literal>, of course increasing 1 for any subsequent
1149  </para>  uploads.
 </listitem>  
 <listitem>  
 <para>  
 Do not make source-only uploads if your package has any binary-all packages (do  
 not use the <literal>-S</literal> option to  
 <command>dpkg-buildpackage</command>).  The <command>buildd</command>  
 infrastructure will not build those.  This point applies to normal package  
 uploads as well.  
1150  </para>  </para>
1151  </listitem>  </listitem>
1152  <listitem>  <listitem>
1153  <para>  <para>
1154  Unless the upstream source has been uploaded to <literal>security.debian.org  Unless the upstream source has been uploaded to <literal>security.debian.org
1155  </literal> before (by a previous security update), build the upload with full  </literal> before (by a previous security update), build the upload <emphasis
1156  upstream source (<literal>dpkg-buildpackage -sa</literal>).  If there has been  role="strong">with full upstream source</emphasis> (<literal>dpkg-buildpackage
1157  a previous upload to </literal>security.debian.org</literal> with the same  -sa</literal>).  If there has been a previous upload to
1158  upstream version, you may upload without upstream source (<literal>  <literal>security.debian.org</literal> with the same upstream version, you may
1159  dpkg-buildpackage -sd</literal>).  upload without upstream source (<literal> dpkg-buildpackage -sd</literal>).
1160  </para>  </para>
1161  </listitem>  </listitem>
1162  <listitem>  <listitem>
1163  <para>  <para>
1164  Be sure to use the exact same <filename>*.orig.tar.gz</filename> as used in the  Be sure to use the <emphasis role="strong">exact same
1165    <filename>*.orig.tar.{gz,bz2}</filename></emphasis> as used in the
1166  normal archive, otherwise it is not possible to move the security fix into the  normal archive, otherwise it is not possible to move the security fix into the
1167  main archives later.  main archives later.
1168  </para>  </para>
1169  </listitem>  </listitem>
1170  <listitem>  <listitem>
1171  <para>  <para>
1172  Build the package on a clean system which only has packages installed from the  Build the package on a <emphasis role="strong">clean system</emphasis> which only
1173  distribution you are building for.  If you do not have such a system yourself,  has packages installed from the distribution you are building for. If you do not
1174  you can use a debian.org machine (see <xref linkend="server-machines"/> ) or  have such a system yourself, you can use a debian.org machine (see
1175  setup a chroot (see <xref linkend="pbuilder"/> and <xref  <xref linkend="server-machines"/> ) or setup a chroot (see
1176  linkend="debootstrap"/> ).  <xref linkend="pbuilder"/> and <xref linkend="debootstrap"/> ).
1177  </para>  </para>
1178  </listitem>  </listitem>
1179  </itemizedlist>  </itemizedlist>
# Line 1161  archives.  For security uploads, the pla Line 1206  archives.  For security uploads, the pla
1206  </para>  </para>
1207  <para>  <para>
1208  Once an upload to the security queue has been accepted, the package will  Once an upload to the security queue has been accepted, the package will
1209  automatically be rebuilt for all architectures and stored for verification by  automatically be built for all architectures and stored for verification by
1210  the security team.  the security team.
1211  </para>  </para>
1212  <para>  <para>
# Line 1203  control information to place the package Line 1248  control information to place the package
1248  the package (see the <ulink  the package (see the <ulink
1249  url="&url-debian-policy;">Debian Policy Manual</ulink> for  url="&url-debian-policy;">Debian Policy Manual</ulink> for
1250  details).  You must ensure that you include the  details).  You must ensure that you include the
1251  <filename>.orig.tar.gz</filename> in your upload (even if you are not uploading  <filename>.orig.tar.{gz,bz2}</filename> in your upload (even if you are not uploading
1252  a new upstream version), or it will not appear in the new section together with  a new upstream version), or it will not appear in the new section together with
1253  the rest of the package.  If your new section is valid, it will be moved  the rest of the package.  If your new section is valid, it will be moved
1254  automatically.  If it does not, then contact the ftpmasters in order to  automatically.  If it does not, then contact the ftpmasters in order to
# Line 1224  described in <xref linkend="override-fil Line 1269  described in <xref linkend="override-fil
1269  If for some reason you want to completely remove a package (say, if it is an  If for some reason you want to completely remove a package (say, if it is an
1270  old compatibility library which is no longer required), you need to file a bug  old compatibility library which is no longer required), you need to file a bug
1271  against <literal>ftp.debian.org</literal> asking that the package be removed;  against <literal>ftp.debian.org</literal> asking that the package be removed;
1272  as all bugs, this bug should normally have normal severity.  Make sure you  as all bugs, this bug should normally have normal severity.
1273  indicate which distribution the package should be removed from.  Normally, you  The bug title should be in the form <literal>RM: <replaceable>package
1274  can only have packages removed from <literal>unstable</literal> and  </replaceable> <replaceable>[architecture list]</replaceable> --
1275  <literal>experimental</literal>.  Packages are not removed from  <replaceable>reason</replaceable></literal>, where <replaceable>package</replaceable>
1276    is the package to be removed and <replaceable>reason</replaceable> is a
1277    short summary of the reason for the removal request.
1278    <replaceable>[architecture list]</replaceable> is optional and only needed
1279    if the removal request only applies to some architectures, not all. Note
1280    that the <command>reportbug</command> will create a title conforming
1281    to these rules when you use it to report a bug against the <literal>
1282    ftp.debian.org</literal> pseudo-package.
1283    </para>
1284    
1285    <para>
1286    If you want to remove a package you maintain, you should note this in
1287    the bug title by prepending <literal>ROM</literal> (Request Of Maintainer).
1288    There are several other standard acronyms used in the reasoning for a package
1289    removal, see <ulink url="http://&ftp-master-host;/removals.html"></ulink>
1290    for a complete list. That page also provides a convenient overview of
1291    pending removal requests.
1292    </para>
1293    
1294    <para>
1295    Note that removals can only be done for the <literal>unstable
1296    </literal>, <literal>experimental</literal> and <literal>stable
1297    </literal> distribution.  Packages are not removed from
1298  <literal>testing</literal> directly.  Rather, they will be removed  <literal>testing</literal> directly.  Rather, they will be removed
1299  automatically after the package has been removed from  automatically after the package has been removed from
1300  <literal>unstable</literal> and no package in <literal>testing</literal>  <literal>unstable</literal> and no package in <literal>testing
1301  depends on it.  </literal> depends on it.
1302  </para>  </para>
1303  <para>  <para>
1304  There is one exception when an explicit removal request is not necessary: If a  There is one exception when an explicit removal request is not necessary: If a
# Line 1251  supersedes the one to be removed. Line 1318  supersedes the one to be removed.
1318  <para>  <para>
1319  Usually you only ask for the removal of a package maintained by yourself.  If  Usually you only ask for the removal of a package maintained by yourself.  If
1320  you want to remove another package, you have to get the approval of its  you want to remove another package, you have to get the approval of its
1321  maintainer.  maintainer. Should the package be orphaned and thus have no maintainer,
1322    you should first discuss the removal request on &email-debian-qa;. If
1323    there is a consensus that the package should be removed, you should
1324    reassign and retitle the <literal>O:</literal> bug filed against the
1325    <literal>wnpp</literal> package instead of filing a new bug as
1326    removal request.
1327  </para>  </para>
1328  <para>  <para>
1329  Further information relating to these and other package removal related topics  Further information relating to these and other package removal related topics
# Line 1266  role="package">apt</systemitem> package. Line 1338  role="package">apt</systemitem> package.
1338  showpkg <replaceable>package</replaceable></literal>, the program will show  showpkg <replaceable>package</replaceable></literal>, the program will show
1339  details for <replaceable>package</replaceable>, including reverse depends.  details for <replaceable>package</replaceable>, including reverse depends.
1340  Other useful programs include <literal>apt-cache rdepends</literal>,  Other useful programs include <literal>apt-cache rdepends</literal>,
1341  <command>apt-rdepends</command> and <command>grep-dctrl</command>.  Removal of  <command>apt-rdepends</command>, <command>build-rdeps</command> (in the
1342    <systemitem role="package">devscripts</systemitem> package) and
1343    <command>grep-dctrl</command>.  Removal of
1344  orphaned packages is discussed on &email-debian-qa;.  orphaned packages is discussed on &email-debian-qa;.
1345  </para>  </para>
1346  <para>  <para>
# Line 1275  should either be reassigned to another p Line 1349  should either be reassigned to another p
1349  code has evolved into another package (e.g.  <literal>libfoo12</literal> was  code has evolved into another package (e.g.  <literal>libfoo12</literal> was
1350  removed because <literal>libfoo13</literal> supersedes it) or closed if the  removed because <literal>libfoo13</literal> supersedes it) or closed if the
1351  software is simply no longer part of Debian.  software is simply no longer part of Debian.
1352    When closing the bugs,
1353    to avoid marking the bugs as fixed in versions of the packages
1354    in previous Debian releases, they should be marked as fixed
1355    in the version <literal>&lt;most-recent-version-ever-in-Debian&gt;+rm</literal>.
1356  </para>  </para>
1357  <section id="s5.9.2.1">  <section id="s5.9.2.1">
1358  <title>Removing packages from <filename>Incoming</filename></title>  <title>Removing packages from <filename>Incoming</filename></title>
# Line 1296  occur too often anyway. Line 1374  occur too often anyway.
1374  <section id="s5.9.3">  <section id="s5.9.3">
1375  <title>Replacing or renaming packages</title>  <title>Replacing or renaming packages</title>
1376  <para>  <para>
1377  When you make a mistake naming your package, you should follow a two-step  When the upstream maintainers for one of your packages chose to
1378  process to rename it.  First, set your <filename>debian/control</filename> file  rename their software (or you made a mistake naming your package),
1379  to replace and conflict with the obsolete name of the package (see the <ulink  you should follow a two-step process to rename it. In the first
1380  url="&url-debian-policy;">Debian Policy Manual</ulink> for  step, change the <filename>debian/control</filename> file to
1381  details).  Once you've uploaded the package and the package has moved into the  reflect the new name and to replace, provide and conflict with the
1382  archive, file a bug against <literal>ftp.debian.org</literal> asking to remove  obsolete package name (see the <ulink url="&url-debian-policy;">
1383  the package with the obsolete name.  Do not forget to properly reassign the  Debian Policy Manual</ulink> for details).  Please note that you
1384  package's bugs at the same time.  should only add a <literal>Provides</literal> relation if all
1385    packages depending on the obsolete package name continue to work
1386    after the renaming. Once you've uploaded the package and the package
1387    has moved into the archive, file a bug against <literal>
1388    ftp.debian.org</literal> asking to remove the package with the
1389    obsolete name (see <xref linkend="removing-pkgs"/>).  Do not forget
1390    to properly reassign the package's bugs at the same time.
1391  </para>  </para>
1392  <para>  <para>
1393  At other times, you may make a mistake in constructing your package and wish to  At other times, you may make a mistake in constructing your package and wish to
# Line 1313  Note that this applies to each part of y Line 1397  Note that this applies to each part of y
1397  you wish to replace the upstream source tarball of your package, you will need  you wish to replace the upstream source tarball of your package, you will need
1398  to upload it with a different version.  An easy possibility is to replace  to upload it with a different version.  An easy possibility is to replace
1399  <filename>foo_1.00.orig.tar.gz</filename> with  <filename>foo_1.00.orig.tar.gz</filename> with
1400  <filename>foo_1.00+0.orig.tar.gz</filename>.  This restriction gives each file  <filename>foo_1.00+0.orig.tar.gz</filename> or
1401  on the ftp site a unique name, which helps to ensure consistency across the  <filename>foo_1.00.orig.tar.bz2</filename>.  This restriction gives each
1402  mirror network.  file on the ftp site a unique name, which helps to ensure consistency
1403    across the mirror network.
1404  </para>  </para>
1405  </section>  </section>
1406    
# Line 1581  source code). Line 1666  source code).
1666  <para>  <para>
1667  The ``magic'' for a recompilation-only NMU is triggered by using a suffix  The ``magic'' for a recompilation-only NMU is triggered by using a suffix
1668  appended to the package version number, following the form <literal>  appended to the package version number, following the form <literal>
1669  b<replaceable>number<replaceable>.  b<replaceable>number</replaceable></literal>.
1670  For instance, if the latest version you are recompiling against was version  For instance, if the latest version you are recompiling against was version
1671  <literal>2.9-3<literal>, your binary-only NMU should carry a version of  <literal>2.9-3</literal>, your binary-only NMU should carry a version of
1672  <literal>2.9-3+b1</literal>.  If the latest version was <literal>3.4+b1  <literal>2.9-3+b1</literal>.  If the latest version was <literal>3.4+b1
1673  </literal> (i.e, a native package with a previous recompilation NMU), your  </literal> (i.e, a native package with a previous recompilation NMU), your
1674  binary-only NMU should have a version number of <literal>3.4+b2</literal>.  binary-only NMU should have a version number of <literal>3.4+b2</literal>.
# Line 1712  flavor of Debian built with <command>gcc Line 1797  flavor of Debian built with <command>gcc
1797  also enable Debian to recompile entire distributions quickly.  also enable Debian to recompile entire distributions quickly.
1798  </para>  </para>
1799  <para>  <para>
1800  The buildds admins of each arch can be contacted at the mail address  The wanna-build team, in charge of the buildds,
1801  <literal><replaceable>arch</replaceable>@buildd.debian.org</literal>.  can be reached at <literal>debian-wb-team@lists.debian.org</literal>.
1802    To determine who (wanna-build team, release team) and how (mail, BTS)
1803    to contact, refer to <ulink url="&url-wb-team;"></ulink>.
1804  </para>  </para>
1805    
1806    <para>
1807    When requesting binNMUs or give-backs (retries after a failed build),
1808    please use the format described at <ulink url="&url-release-wb;"/>.
1809    </para>
1810    
1811  </section>  </section>
1812    
1813  </section>  </section>
# Line 1754  fail also, and indicate this to a human Line 1847  fail also, and indicate this to a human
1847  In order to prevent autobuilders from needlessly trying to build your package,  In order to prevent autobuilders from needlessly trying to build your package,
1848  it must be included in <filename>packages-arch-specific</filename>, a list used  it must be included in <filename>packages-arch-specific</filename>, a list used
1849  by the <command>wanna-build</command> script.  The current version is available  by the <command>wanna-build</command> script.  The current version is available
1850  as <ulink  as <ulink url="&url-buildd-p-a-s;"/>;
 url="&url-cvsweb;srcdep/Packages-arch-specific?cvsroot=dak"></ulink>;  
1851  please see the top of the file for whom to contact for changes.  please see the top of the file for whom to contact for changes.
1852  </para>  </para>
1853  </listitem>  </listitem>
# Line 1776  role="package">ftp.debian.org</systemite Line 1868  role="package">ftp.debian.org</systemite
1868  <section id="nmu">  <section id="nmu">
1869  <title>Non-Maintainer Uploads (NMUs)</title>  <title>Non-Maintainer Uploads (NMUs)</title>
1870  <para>  <para>
1871  Under certain circumstances it is necessary for someone other than the official  Every package has one or more maintainers. Normally, these are the people who
1872  package maintainer to make a release of a package.  This is called a  work on and upload new versions of the package. In some situations, it is
1873  non-maintainer upload, or NMU.  useful that other developers can upload a new version as well, for example if
1874  </para>  they want to fix a bug in a package they don't maintain, when the maintainer
1875  <para>  needs help to respond to issues.  Such uploads are called
1876  This section handles only source NMUs, i.e.  NMUs which upload a new version of  <emphasis>Non-Maintainer Uploads (NMU)</emphasis>.
 the package.  For binary-only NMUs by porters or QA members, please see <xref  
 linkend="binary-only-nmu"/> .  If a buildd builds and uploads a package, that  
 too is strictly speaking a binary NMU.  See <xref linkend="wanna-build"/> for  
 some more information.  
 </para>  
 <para>  
 The main reason why NMUs are done is when a developer needs to fix another  
 developer's package in order to address serious problems or crippling bugs or  
 when the package maintainer is unable to release a fix in a timely fashion.  
 </para>  
 <para>  
 First and foremost, it is critical that NMU patches to source should be as  
 non-disruptive as possible.  Do not do housekeeping tasks, do not change the  
 name of modules or files, do not move directories; in general, do not fix  
 things which are not broken.  Keep the patch as small as possible.  If things  
 bother you aesthetically, talk to the Debian maintainer, talk to the upstream  
 maintainer, or submit a bug.  However, aesthetic changes must  
 <emphasis>not</emphasis> be made in a non-maintainer upload.  
 </para>  
 <para>  
 And please remember the Hippocratic Oath: Above all, do no harm.  It is better  
 to leave a package with an open grave bug than applying a non-functional patch,  
 or one that hides the bug instead of resolving it.  
1877  </para>  </para>
1878    
1879  <section id="nmu-guidelines">  <section id="nmu-guidelines">
1880  <title>How to do a NMU</title>  <title>When and how to do an NMU</title>
1881  <para>  
 NMUs which fix important, serious or higher severity bugs are encouraged and  
 accepted.  You should endeavor to reach the current maintainer of the package;  
 they might be just about to upload a fix for the problem, or have a better  
 solution.  
 </para>  
 <para>  
 NMUs should be made to assist a package's maintainer in resolving bugs.  
 Maintainers should be thankful for that help, and NMUers should respect the  
 decisions of maintainers, and try to personally help the maintainer by their  
 work.  
 </para>  
1882  <para>  <para>
1883  A NMU should follow all conventions, written down in this section.  For an  Before doing an NMU, consider the following questions:
 upload to <literal>testing</literal> or <literal>unstable</literal>, this  
 order of steps is recommended:  
1884  </para>  </para>
1885  <itemizedlist>  <itemizedlist>
1886  <listitem>  <listitem>
1887  <para>  <para>
1888  Make sure that the package's bugs that the NMU is meant to address are all  Does your NMU really fix bugs? Fixing cosmetic issues or changing the
1889  filed in the Debian Bug Tracking System (BTS).  If they are not, submit them  packaging style in NMUs is discouraged.
 immediately.  
1890  </para>  </para>
1891  </listitem>  </listitem>
1892  <listitem>  <listitem>
1893  <para>  <para>
1894  Wait a few days for the response from the maintainer.  If you don't get any  Did you give enough time to the maintainer? When was the bug reported to the
1895  response, you may want to help them by sending the patch that fixes the bug.  BTS? Being busy for a week or two isn't unusual.  Is the bug so severe that it
1896  Don't forget to tag the bug with the patch keyword.  needs to be fixed right now, or can it wait a few more days?
1897  </para>  </para>
1898  </listitem>  </listitem>
1899  <listitem>  <listitem>
1900  <para>  <para>
1901  Wait a few more days.  If you still haven't got an answer from the maintainer,  How confident are you about your changes? Please remember the Hippocratic Oath:
1902  send them a mail announcing your intent to NMU the package.  Prepare an NMU as  "Above all, do no harm." It is better to leave a package with an open grave bug
1903  described in this section, and test it carefully on your machine (cf.  <xref  than applying a non-functional patch, or one that hides the bug instead of
1904  linkend="sanitycheck"/> ).  Double check that your patch doesn't have any  resolving it. If you are not 100% sure of what you did, it might be a good idea
1905  unexpected side effects.  Make sure your patch is as small and as  to seek advice from others. Remember that if you break something in your NMU,
1906  non-disruptive as it can be.  many people will be very unhappy about it.
1907  </para>  </para>
1908  </listitem>  </listitem>
1909  <listitem>  <listitem>
1910  <para>  <para>
1911  Upload your package to incoming in <filename>DELAYED/7-day</filename> (cf.  Have you clearly expressed your intention to NMU, at least in the BTS?
1912  <xref linkend="delayed-incoming"/> ), send the final patch to the maintainer  It is also a good idea to try to contact the
1913  via the BTS, and explain to them that they have 7 days to react if they want to  maintainer by other means (private email, IRC).
 cancel the NMU.  
1914  </para>  </para>
1915  </listitem>  </listitem>
1916  <listitem>  <listitem>
1917  <para>  <para>
1918  Follow what happens, you're responsible for any bug that you introduced with  If the maintainer is usually active and responsive, have you tried to contact
1919  your NMU.  You should probably use <xref linkend="pkg-tracking-system"/> (PTS)  him? In general it should be considered preferable that a maintainer takes care
1920  to stay informed of the state of the package after your NMU.  of an issue himself and that he is given the chance to review and correct your
1921    patch, because he can be expected to be more aware of potential issues which an
1922    NMUer might miss. It is often a better use of everyone's time if the maintainer
1923    is given an opportunity to upload a fix on their own.
1924  </para>  </para>
1925  </listitem>  </listitem>
1926  </itemizedlist>  </itemizedlist>
1927  <para>  <para>
1928  At times, the release manager or an organized group of developers can announce  When doing an NMU, you must first make sure that your intention to NMU is
1929  a certain period of time in which the NMU rules are relaxed.  This usually  clear.  Then, you must send a patch with the differences between the
1930  involves shortening the period during which one is to wait before uploading the  current package and your proposed NMU to the BTS. The
1931  fixes, and shortening the DELAYED period.  It is important to notice that even  <literal>nmudiff</literal> script in the <literal>devscripts</literal> package
1932  in these so-called bug squashing party times, the NMU'er has to file bugs and  might be helpful.
1933  contact the developer first, and act later.  Please see <xref  </para>
1934  linkend="qa-bsp"/> for details.  <para>
1935  </para>  While preparing the patch, you should better be aware of any package-specific
1936  <para>  practices that the maintainer might be using. Taking them into account reduces
1937  For the <literal>testing</literal> distribution, the rules may be changed by  the burden of getting your changes integrated back in the normal package
1938  the release managers.  Please take additional care, and acknowledge that the  workflow and thus increases the possibilities that that will happen. A good
1939  usual way for a package to enter <literal>testing</literal> is through  place where to look for for possible package-specific practices is
1940  <literal>unstable</literal>.  <ulink url="&url-debian-policy;ch-source.html#s-readmesource"><literal>debian/README.source</literal></ulink>.
1941  </para>  </para>
1942  <para>  <para>
1943  For the stable distribution, please take extra care.  Of course, the release  Unless you have an excellent reason not to do so, you must then give some time
1944  managers may also change the rules here.  Please verify before you upload that  to the maintainer to react (for example, by uploading to the
1945  all your changes are OK for inclusion into the next stable release by the  <literal>DELAYED</literal> queue).  Here are some recommended values to use for delays:
 release manager.  
1946  </para>  </para>
1947    <itemizedlist>
1948    <listitem>
1949  <para>  <para>
1950  When a security bug is detected, the security team may do an NMU, using their  Upload fixing only release-critical bugs older than 7 days: 2 days
 own rules.  Please refer to <xref linkend="bug-security"/> for more  
 information.  
1951  </para>  </para>
1952    </listitem>
1953    <listitem>
1954  <para>  <para>
1955  For the differences for Porters NMUs, please see <xref  Upload fixing only release-critical and important bugs: 5 days
 linkend="source-nmu-when-porter"/> .  
1956  </para>  </para>
1957    </listitem>
1958    <listitem>
1959  <para>  <para>
1960  Of course, it is always possible to agree on special rules with a maintainer  Other NMUs: 10 days
 (like the maintainer asking please upload this fix directly for me, and no diff  
 required).  
1961  </para>  </para>
1962  </section>  </listitem>
1963    </itemizedlist>
1964    
 <section id="nmu-version">  
 <title>NMU version numbering</title>  
1965  <para>  <para>
1966  Whenever you have made a change to a package, no matter how trivial, the  Those delays are only examples. In some cases, such as uploads fixing security
1967  version number needs to change.  This enables our packing system to function.  issues, or fixes for trivial bugs that blocking a transition, it is desirable
1968  </para>  that the fixed package reaches <literal>unstable</literal> sooner.
 <para>  
 If you are doing a non-maintainer upload (NMU), you should add a new minor  
 version number to the <replaceable>debian-revision</replaceable> part of the  
 version number (the portion after the last hyphen).  This extra minor number  
 will start at `1'.  For example, consider the package `foo', which is at  
 version 1.1-3.  In the archive, the source package control file would be  
 <filename>foo_1.1-3.dsc</filename>.  The upstream version is `1.1' and the  
 Debian revision is `3'.  The next NMU would add a new minor number `.1' to the  
 Debian revision; the new source control file would be  
 <filename>foo_1.1-3.1.dsc</filename>.  
1969  </para>  </para>
1970    
1971  <para>  <para>
1972  The Debian revision minor number is needed to avoid stealing one of the package  Sometimes, release managers decide to allow NMUs with shorter delays for a
1973  maintainer's version numbers, which might disrupt their work.  It also has the  subset of bugs (e.g release-critical bugs older than 7 days). Also, some
1974  benefit of making it visually clear that a package in the archive was not made  maintainers list themselves in the <ulink url="&url-low-threshold-nmu;">Low
1975  by the official maintainer.  Threshold NMU list</ulink>, and accept that NMUs are uploaded without delay. But
1976    even in those cases, it's still a good idea to give the maintainer a few days
1977    to react before you upload, especially if the patch wasn't available in the BTS
1978    before, or if you know that the maintainer is generally active.
1979  </para>  </para>
1980    
1981  <para>  <para>
1982  If there is no <replaceable>debian-revision</replaceable> component in the  After you upload an NMU, you are responsible for the possible problems that you
1983  version number then one should be created, starting at `0.1' (but in case of a  might have introduced. You must keep an eye on the package (subscribing to the
1984  debian native package still upload it as native package).  If it is absolutely  package on the PTS is a good way to achieve this).
 necessary for someone other than the usual maintainer to make a release based  
 on a new upstream version then the person making the release should start with  
 the <replaceable>debian-revision</replaceable> value `0.1'.  The usual  
 maintainer of a package should start their  
 <replaceable>debian-revision</replaceable> numbering at `1'.  
1985  </para>  </para>
1986    
1987  <para>  <para>
1988  If you upload a package to <literal>testing</literal> or <literal>stable  This is not a license to perform NMUs thoughtlessly.  If you NMU when it is
1989  </literal>, sometimes, you need to fork the version number tree.  For this,  clear that the maintainers are active and would have acknowledged a patch in a
1990  version numbers like 1.1-3sarge0.1 could be used.  timely manner, or if you ignore the recommendations of this document, your
1991    upload might be a cause of conflict with the maintainer.
1992    You should always be prepared to
1993    defend the wisdom of any NMU you perform on its own merits.
1994  </para>  </para>
1995  </section>  </section>
1996    
1997  <section id="nmu-changelog">  <section id="nmu-changelog">
1998  <title>Source NMUs must have a new changelog entry</title>  <title>NMUs and debian/changelog</title>
 <para>  
 Anyone who is doing a source NMU must create a changelog entry, describing  
 which bugs are fixed by the NMU, and generally why the NMU was required and  
 what it fixed.  The changelog entry will have the email address of the person  
 who uploaded it in the log entry and the NMU version number in it.  
 </para>  
1999  <para>  <para>
2000  By convention, source NMU changelog entries start with the line  Just like any other (source) upload, NMUs must add an entry to
2001    <literal>debian/changelog</literal>, telling what has changed with this
2002    upload.  The first line of this entry must explicitely mention that this upload is an NMU, e.g.:
2003  </para>  </para>
2004  <screen>  <screen>
2005    * Non-maintainer upload    * Non-maintainer upload.
2006  </screen>  </screen>
 </section>  
2007    
 <section id="nmu-patch">  
 <title>Source NMUs and the Bug Tracking System</title>  
2008  <para>  <para>
2009  Maintainers other than the official package maintainer should make as few  The way to version NMUs differs for native and non-native packages.
2010  changes to the package as possible, and they should always send a patch as a  </para>
2011  unified context diff (<literal>diff -u</literal>) detailing their changes to  <para>
2012  the Bug Tracking System.  If the package is a native package (without a debian revision in the version number),
2013    the version must be the version of the last maintainer upload, plus
2014    <literal>+nmu<replaceable>X</replaceable></literal>, where
2015    <replaceable>X</replaceable> is a counter starting at <literal>1</literal>.
2016    If
2017    the last upload was also an NMU, the counter should be increased.  For example,
2018    if the current version is <literal>1.5</literal>, then an NMU would get
2019    version <literal>1.5+nmu1</literal>.
2020    </para>
2021    <para>
2022    If the package is a not a native package, you should add a minor version number
2023    to the debian revision part of the version number (the portion after the last
2024    hyphen). This extra number must start at 1.  For example,
2025    if the current version is <literal>1.5-2</literal>, then an NMU would get
2026    version <literal>1.5-2.1</literal>. If a new upstream version
2027    is packaged in the NMU, the debian revision is set to <literal>0</literal>, for
2028    example <literal>1.6-0.1</literal>.
2029    </para>
2030    <para>
2031    In both cases, if the last upload was also an NMU, the counter should
2032    be increased. For example, if the current version is
2033    <literal>1.5+nmu3</literal> (a native package which has already been
2034    NMUed), the NMU would get version <literal>1.5+nmu4</literal>.  .
2035    </para>
2036    <para>
2037    A special versioning scheme is needed to avoid disrupting the maintainer's
2038    work, since using an integer for the Debian revision will potentially
2039    conflict with a maintainer upload already in preparation at the time of an
2040    NMU, or even one sitting in the ftp NEW queue.
2041    It also has the
2042    benefit of making it visually clear that a package in the archive was not made
2043    by the official maintainer.
2044  </para>  </para>
2045    
2046  <para>  <para>
2047  What if you are simply recompiling the package?  If you just need to recompile  If you upload a package to testing or stable, you sometimes need to "fork" the
2048  it for a single architecture, then you may do a binary-only NMU as described in  version number tree. This is the case for security uploads, for example.  For
2049  <xref linkend="binary-only-nmu"/> which doesn't require any patch to be sent.  this, a version of the form
2050  If you want the package to be recompiled for all architectures, then you do a  <literal>+deb<replaceable>XY</replaceable>u<replaceable>Z</replaceable></literal>
2051  source NMU as usual and you will have to send a patch.  should be used, where <replaceable>X</replaceable> and
2052    <replaceable>Y</replaceable> are the major and minor release numbers, and
2053    <replaceable>Z</replaceable> is a counter starting at <literal>1</literal>.
2054    When the release number is not yet known (often the case for
2055    <literal>testing</literal>, at the beginning of release cycles), the lowest
2056    release number higher than the last stable release number must be used.  For
2057    example, while Etch (Debian 4.0) is stable, a security NMU to stable for a
2058    package at version <literal>1.5-3</literal> would have version
2059    <literal>1.5-3+deb40u1</literal>, whereas a security NMU to Lenny would get
2060    version <literal>1.5-3+deb50u1</literal>. After the release of Lenny, security
2061    uploads to the <literal>testing</literal> distribution will be versioned
2062    <literal>+deb51uZ</literal>, until it is known whether that release will be
2063    Debian 5.1 or Debian 6.0 (if that becomes the case, uploads will be versioned
2064    as <literal>+deb60uZ</literal>.
2065  </para>  </para>
2066    </section>
2067    
2068    <section id="nmu-delayed">
2069    <title>Using the <literal>DELAYED/</literal> queue</title>
2070    
2071  <para>  <para>
2072  Bugs fixed by source NMUs used to be tagged fixed instead of closed, but since  Having to wait for a response after you request permission to NMU is
2073  version tracking is in place, such bugs are now also closed with the NMU  inefficient, because it costs the NMUer a context switch to come back to the
2074  version.  issue.
2075    The <literal>DELAYED</literal> queue (see <xref linkend="delayed-incoming"/>)
2076    allows the developer doing the NMU to perform all the necessary tasks at the
2077    same time. For instance, instead of telling the maintainer that you will
2078    upload the updated
2079    package in 7 days, you should upload the package to
2080    <literal>DELAYED/7</literal> and tell the maintainer that he has 7 days to
2081    react.  During this time, the maintainer can ask you to delay the upload some
2082    more, or cancel your upload.
2083  </para>  </para>
2084    
2085  <para>  <para>
2086  Also, after doing an NMU, you have to send the information to the existing bugs  The <literal>DELAYED</literal> queue should not be used to put additional
2087  that are fixed by your NMU, including the unified diff.  Historically, it was  pressure on the maintainer. In particular, it's important that you are
2088  custom to open a new bug and include a patch showing all the changes you have  available to cancel or delay the upload before the delay expires since the
2089  made.  The normal maintainer will either apply the patch or employ an alternate  maintainer cannot cancel the upload himself.
 method of fixing the problem.  Sometimes bugs are fixed independently upstream,  
 which is another good reason to back out an NMU's patch.  If the maintainer  
 decides not to apply the NMU's patch but to release a new version, the  
 maintainer needs to ensure that the new upstream version really fixes each  
 problem that was fixed in the non-maintainer release.  
2090  </para>  </para>
2091    
2092  <para>  <para>
2093  In addition, the normal maintainer should <emphasis>always</emphasis> retain  If you make an NMU to <literal>DELAYED</literal> and the maintainer updates
2094  the entry in the changelog file documenting the non-maintainer upload -- and of  his package before the delay expires, your upload will be rejected because a
2095  course, also keep the changes.  If you revert some of the changes, please  newer version is already available in the archive.
2096  reopen the relevant bug reports.  Ideally, the maintainer will take care to include your proposed changes (or
2097    at least a solution for the problems they address) in that upload.
2098  </para>  </para>
2099    
2100  </section>  </section>
2101    
2102  <section id="nmu-build">  <section id="nmu-maintainer">
2103  <title>Building source NMUs</title>  <title>NMUs from the maintainer's point of view</title>
2104    
2105  <para>  <para>
2106  Source NMU packages are built normally.  Pick a distribution using the same  When someone NMUs your package, this means they want to help you to keep it in
2107  rules as found in <xref linkend="distribution"/> , follow the other  good shape.  This gives users fixed packages faster.  You
2108  instructions in <xref linkend="upload"/> .  can consider asking the NMUer to become a co-maintainer of the package.
2109    Receiving an NMU on a package is not a bad
2110    thing; it just means that the package is interesting enough for other people to
2111    work on it.
2112  </para>  </para>
2113    
2114  <para>  <para>
2115  Make sure you do <emphasis>not</emphasis> change the value of the maintainer in  To acknowledge an NMU, include its changes and changelog entry in your next
2116  the <filename>debian/control</filename> file.  Your name as given in the NMU  maintainer upload.  If you do not acknowledge the NMU by including the
2117  entry of the <filename>debian/changelog</filename> file will be used for  NMU changelog entry in your changelog, the bugs will remain closed in the
2118  signing the changes file.  BTS but will be listed as affecting your maintainer version of the package.
2119  </para>  </para>
2120    
2121  </section>  </section>
2122    
2123  <section id="ack-nmu">  <section id="nmu-binnmu">
2124  <title>Acknowledging an NMU</title>  <title>Source NMUs vs Binary-only NMUs (binNMUs)</title>
2125    
2126  <para>  <para>
2127  If one of your packages has been NMU'ed, you have to incorporate the changes in  The full name of an NMU is <emphasis>source NMU</emphasis>.  There is also
2128  your copy of the sources.  This is easy, you just have to apply the patch that  another type, namely the <emphasis>binary-only NMU</emphasis>, or
2129  has been sent to you.  Once this is done, you have to close the bugs that have  <emphasis>binNMU</emphasis>.  A binNMU is also a package upload by someone
2130  been tagged fixed by the NMU.  The easiest way is to use the  other than the package's maintainer.  However, it is a binary-only upload.
 <literal>-v</literal> option of <command>dpkg-buildpackage</command>, as this  
 allows you to include just all changes since your last maintainer upload.  
 Alternatively, you can close them manually by sending the required mails to the  
 BTS or by adding the required <literal>closes: #nnnn</literal> in the changelog  
 entry of your next upload.  
2131  </para>  </para>
2132    
2133  <para>  <para>
2134  In any case, you should not be upset by the NMU.  An NMU is not a personal  When a library (or other dependency) is updated, the packages using it may need
2135  attack against the maintainer.  It is a proof that someone cares enough about  to be rebuilt.  Since no changes to the source are needed, the same source
2136  the package that they were willing to help you in your work, so you should be  package is used.
 thankful.  You may also want to ask them if they would be interested in helping  
 you on a more frequent basis as co-maintainer or backup maintainer (see <xref  
 linkend="collaborative-maint"/> ).  
2137  </para>  </para>
 </section>  
2138    
 <section id="nmu-vs-qa">  
 <title>NMU vs QA uploads</title>  
2139  <para>  <para>
2140  Unless you know the maintainer is still active, it is wise to check the package  BinNMUs are usually triggered on the buildds by wanna-build.
2141  to see if it has been orphaned.  The current list of orphaned packages which  An entry is added to debian/changelog,
2142  haven't had their maintainer set correctly is available at <ulink  explaining why the upload was needed and increasing the version number as
2143  url="&url-debian-qa-orphaned;"></ulink>.  If you perform an NMU on an  described in <xref linkend="binary-only-nmu"/>.
2144  improperly orphaned package, please set the maintainer to <literal>Debian QA Group  This entry should not be included in the next upload.
 &lt;packages@qa.debian.org&gt;</literal>.  
2145  </para>  </para>
 </section>  
2146    
 <section id="nmu-who">  
 <title>Who can do an NMU</title>  
2147  <para>  <para>
2148  Only official, registered Debian Developers can do binary or source NMUs.  A  Buildds upload packages for their architecture to the archive as binary-only
2149  Debian Developer is someone who has their key in the Debian key ring.  uploads.  Strictly speaking, these are binNMUs.  However, they are not normally
2150  Non-developers, however, are encouraged to download the source package and  called NMU, and they don't add an entry to debian/changelog.
 start hacking on it to fix problems; however, rather than doing an NMU, they  
 should just submit worthwhile patches to the Bug Tracking System.  Maintainers  
 almost always appreciate quality patches and bug reports.  
2151  </para>  </para>
2152    
2153  </section>  </section>
2154    
2155  <section id="nmu-terms">  <section id="nmu-qa-upload">
2156  <title>Terminology</title>  <title>NMUs vs QA uploads</title>
2157    
2158  <para>  <para>
2159  There are two new terms used throughout this section: ``binary-only NMU'' and  NMUs are uploads of packages by somebody else than their assigned maintainer.
2160  ``source NMU''.  These terms are used with specific technical meaning  There is
2161  throughout this document.  Both binary-only and source NMUs are similar, since  another type of upload where the uploaded package is not yours: QA uploads. QA
2162  they involve an upload of a package by a developer who is not the official  uploads are uploads of orphaned packages.
 maintainer of that package.  That is why it's a  
 <literal>non-maintainer</literal> upload.  
2163  </para>  </para>
2164    
2165  <para>  <para>
2166  A source NMU is an upload of a package by a developer who is not the official  QA uploads are very much like normal maintainer uploads: they may fix anything,
2167  maintainer, for the purposes of fixing a bug in the package.  Source NMUs  even minor issues; the version numbering is normal, and there is no need to use
2168  always involves changes to the source (even if it is just a change to  a delayed upload.  The difference is that you are not listed as the Maintainer
2169  <filename>debian/changelog</filename>).  This can be either a change to the  or Uploader for the package.  Also, the changelog entry of a QA upload has a
2170  upstream source, or a change to the Debian bits of the source.  Note, however,  special first line:
 that source NMUs may also include architecture-dependent packages, as well as  
 an updated Debian diff.  
2171  </para>  </para>
2172    
2173    <screen>
2174     * QA upload.
2175    </screen>
2176    
2177  <para>  <para>
2178  A binary-only NMU is a recompilation and upload of a binary package for a given  If you want to do an NMU, and it seems that the maintainer is not active, it is
2179  architecture.  As such, it is usually part of a porting effort.  A binary-only  wise to check if the package is orphaned
2180  NMU is a non-maintainer uploaded binary version of a package, with no source  (this information is displayed on the package's Package Tracking System page).
2181  changes required.  There are many cases where porters must fix problems in the  When doing the first QA upload to an
2182  source in order to get them to compile for their target architecture; that  orphaned package, the maintainer should be set to <literal>Debian QA Group
2183  would be considered a source NMU rather than a binary-only NMU.  As you can  &lt;packages@qa.debian.org&gt;</literal>.  Orphaned packages which did
2184  see, we don't distinguish in terminology between porter NMUs and non-porter  not yet have a QA upload still have their old maintainer set.  There is a list
2185  NMUs.  of them at <ulink url="&url-orphaned-not-qa;"/>.
2186  </para>  </para>
2187    
2188  <para>  <para>
2189  Both classes of NMUs, source and binary-only, can be lumped under the term  Instead of doing a QA upload, you can also consider adopting the package by
2190  ``NMU''.  However, this often leads to confusion, since most people think  making yourself the maintainer.  You don't need permission from anybody to
2191  ``source NMU'' when they think ``NMU''.  So it's best to be careful: always use  adopt an orphaned package, you can just set yourself as maintainer and upload
2192  ``binary NMU'' or ``binNMU'' for binary-only NMUs.  the new version (see <xref linkend="adopting"/>).
2193  </para>  </para>
2194    
2195  </section>  </section>
2196    
2197  </section>  </section>
# Line 2192  after they have undergone some degree of Line 2289  after they have undergone some degree of
2289  They must be in sync on all architectures and mustn't have dependencies that  They must be in sync on all architectures and mustn't have dependencies that
2290  make them uninstallable; they also have to have generally no known  make them uninstallable; they also have to have generally no known
2291  release-critical bugs at the time they're installed into <literal>testing  release-critical bugs at the time they're installed into <literal>testing
2292  <literal>.  This way, <literal>testing</literal> should always be close to  </literal>.  This way, <literal>testing</literal> should always be close to
2293  being a release candidate.  Please see below for details.  being a release candidate.  Please see below for details.
2294  </para>  </para>
2295  </section>  </section>
# Line 2232  available in <literal>unstable</literal> Line 2329  available in <literal>unstable</literal>
2329  <listitem>  <listitem>
2330  <para>  <para>
2331  It must be available on all architectures on which it has previously been built  It must be available on all architectures on which it has previously been built
2332  in <literal>unstable</literal>.  <xref linkend="madison"/> may be of interest  in <literal>unstable</literal>.  <xref linkend="dak-ls"/> may be of interest
2333  to check that information;  to check that information;
2334  </para>  </para>
2335  </listitem>  </listitem>
# Line 2318  Consider this example: Line 2415  Consider this example:
2415  </informaltable>  </informaltable>
2416  <para>  <para>
2417  The package is out of date on alpha in <literal>unstable</literal>, and will  The package is out of date on alpha in <literal>unstable</literal>, and will
2418  not go to <literal>testing. Removing the package would not help at all, the  not go to <literal>testing</literal>. Removing the package would not help at all, the
2419  package is still out of date on <literal>alpha</literal>, and will not  package is still out of date on <literal>alpha</literal>, and will not
2420  propagate to testing.  propagate to testing.
2421  </para>  </para>

Legend:
Removed from v.5219  
changed lines
  Added in v.7071

  ViewVC Help
Powered by ViewVC 1.1.5