| 21 |
</para> |
</para> |
| 22 |
<para> |
<para> |
| 23 |
Assuming no one else is already working on your prospective package, you must |
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 |
then submit a bug report (<xref linkend="submit-bug"/>) against the |
| 25 |
pseudo-package <systemitem role="package">wnpp</systemitem> describing your |
pseudo-package <systemitem role="package">wnpp</systemitem> describing your |
| 26 |
plan to create a new package, including, but not limiting yourself to, a |
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 |
description of the package, the license of the prospective package, and the |
| 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 separate 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 &email-ftpmaster; |
| 53 |
|
a reply to the email you receive as a maintainer after your upload, or reply to |
| 54 |
|
the rejection email in case you are already re-uploading. |
| 55 |
</para> |
</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 |
| 58 |
|
<literal>Closes: #<replaceable>nnnnn</replaceable></literal>. |
| 59 |
This is useful for the security team to track vulnerabilities. If an upload is |
This is useful for the security team to track vulnerabilities. If an upload is |
| 60 |
made to fix the bug before the advisory ID is known, it is encouraged to modify |
made to fix the bug before the advisory ID is known, it is encouraged to modify |
| 61 |
the historical changelog entry with the next upload. Even in this case, please |
the historical changelog entry with the next upload. Even in this case, please |
| 122 |
The <filename>debian/changelog</filename> file conforms to a certain structure, |
The <filename>debian/changelog</filename> file conforms to a certain structure, |
| 123 |
with a number of different fields. One field of note, the |
with a number of different fields. One field of note, the |
| 124 |
<literal>distribution</literal>, is described in <xref |
<literal>distribution</literal>, is described in <xref |
| 125 |
linkend="distribution"/> . More information about the structure of this file |
linkend="distribution"/>. More information about the structure of this file |
| 126 |
can be found in the Debian Policy section titled |
can be found in the Debian Policy section titled |
| 127 |
<filename>debian/changelog</filename>. |
<filename>debian/changelog</filename>. |
| 128 |
</para> |
</para> |
| 129 |
<para> |
<para> |
| 130 |
Changelog entries can be used to automatically close Debian bugs when the |
Changelog entries can be used to automatically close Debian bugs when the |
| 131 |
package is installed into the archive. See <xref linkend="upload-bugfix"/> . |
package is installed into the archive. See <xref linkend="upload-bugfix"/>. |
| 132 |
</para> |
</para> |
| 133 |
<para> |
<para> |
| 134 |
It is conventional that the changelog entry of a package that contains a new |
It is conventional that the changelog entry of a package that contains a new |
| 135 |
upstream version of the software looks like this: |
upstream version of the software looks like this: |
| 136 |
</para> |
</para> |
| 137 |
<screen> |
<screen> |
| 138 |
* new upstream version |
* New upstream release. |
| 139 |
</screen> |
</screen> |
| 140 |
<para> |
<para> |
| 141 |
There are tools to help you create entries and finalize the |
There are tools to help you create entries and finalize the |
| 142 |
<filename>changelog</filename> for release — see <xref linkend="devscripts"/> |
<filename>changelog</filename> for release — see <xref linkend="devscripts"/> |
| 143 |
and <xref linkend="dpkg-dev-el"/> . |
and <xref linkend="dpkg-dev-el"/>. |
| 144 |
</para> |
</para> |
| 145 |
<para> |
<para> |
| 146 |
See also <xref linkend="bpp-debian-changelog"/> . |
See also <xref linkend="bpp-debian-changelog"/>. |
| 147 |
</para> |
</para> |
| 148 |
</section> |
</section> |
| 149 |
|
|
| 174 |
</para> |
</para> |
| 175 |
<para> |
<para> |
| 176 |
Normally, a package should <emphasis>not</emphasis> be uploaded if it causes |
Normally, a package should <emphasis>not</emphasis> be uploaded if it causes |
| 177 |
lintian to emit errors (they will start with <literal>E</literal>). |
<command>lintian</command> to emit errors (they will start with <literal>E</literal>). |
| 178 |
</para> |
</para> |
| 179 |
<para> |
<para> |
| 180 |
For more information on <command>lintian</command>, see <xref |
For more information on <command>lintian</command>, see <xref |
| 181 |
linkend="lintian"/> . |
linkend="lintian"/>. |
| 182 |
</para> |
</para> |
| 183 |
</listitem> |
</listitem> |
| 184 |
<listitem> |
<listitem> |
| 185 |
<para> |
<para> |
| 186 |
Optionally run <xref linkend="debdiff"/> to analyze changes from an older |
Optionally run <command>debdiff</command> (see <xref linkend="debdiff"/>) to analyze changes from an older |
| 187 |
version, if one exists. |
version, if one exists. |
| 188 |
</para> |
</para> |
| 189 |
</listitem> |
</listitem> |
| 203 |
Copy the source package in a different directory and try unpacking it and |
Copy the source package in a different directory and try unpacking it and |
| 204 |
rebuilding it. This tests if the package relies on existing files outside of |
rebuilding it. This tests if the package relies on existing files outside of |
| 205 |
it, or if it relies on permissions being preserved on the files shipped inside |
it, or if it relies on permissions being preserved on the files shipped inside |
| 206 |
the .diff.gz file. |
the <filename>.diff.gz</filename> file. |
| 207 |
</para> |
</para> |
| 208 |
</listitem> |
</listitem> |
| 209 |
</itemizedlist> |
</itemizedlist> |
| 224 |
<listitem> |
<listitem> |
| 225 |
<para> |
<para> |
| 226 |
the (more common) packages where there's an original source tarball file |
the (more common) packages where there's an original source tarball file |
| 227 |
accompanied by another file that contains the patches applied for Debian |
accompanied by another file that contains the changes made by Debian |
| 228 |
</para> |
</para> |
| 229 |
</listitem> |
</listitem> |
| 230 |
</itemizedlist> |
</itemizedlist> |
| 231 |
<para> |
<para> |
| 232 |
For the native packages, the source package includes a Debian source control |
For the native packages, the source package includes a Debian source control |
| 233 |
file (<literal>.dsc</literal>) and the source tarball |
file (<filename>.dsc</filename>) and the source tarball |
| 234 |
(<literal>.tar.gz</literal>). A source package of a non-native package |
(<filename>.tar.{gz,bz2,lzma}</filename>). A source package of a non-native package |
| 235 |
includes a Debian source control file, the original source tarball |
includes a Debian source control file, the original source tarball |
| 236 |
(<literal>.orig.tar.gz</literal>) and the Debian patches |
(<filename>.orig.tar.{gz,bz2,lzma}</filename>) and the Debian changes |
| 237 |
(<literal>.diff.gz</literal>). |
(<filename>.diff.gz</filename> for the source format “1.0” or |
| 238 |
|
<filename>.debian.tar.{gz,bz2,lzma}</filename> for the source format “3.0 (quilt)”). |
| 239 |
</para> |
</para> |
| 240 |
<para> |
<para> |
| 241 |
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 |
| 242 |
<citerefentry> <refentrytitle>dpkg-buildpackage</refentrytitle> |
by <command>dpkg-source</command> at build time. Nowadays it is recommended |
| 243 |
<manvolnum>1</manvolnum> </citerefentry>. The rest of this section relates |
to be explicit about the desired source format by putting either “3.0 (quilt)” |
| 244 |
only to non-native packages. |
or “3.0 (native)” in <filename>debian/source/format</filename>. |
| 245 |
|
The rest of this section relates only to non-native packages. |
| 246 |
</para> |
</para> |
| 247 |
<para> |
<para> |
| 248 |
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 |
| 254 |
<para> |
<para> |
| 255 |
By default, <command>dpkg-genchanges</command> and |
By default, <command>dpkg-genchanges</command> and |
| 256 |
<command>dpkg-buildpackage</command> will include the original source tar file |
<command>dpkg-buildpackage</command> will include the original source tar file |
| 257 |
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 |
| 258 |
indicating a new upstream version. This behavior may be modified by using |
from the preceding entry. This behavior may be modified by using |
| 259 |
<literal>-sa</literal> to always include it or <literal>-sd</literal> to always |
<literal>-sa</literal> to always include it or <literal>-sd</literal> to always |
| 260 |
leave it out. |
leave it out. |
| 261 |
</para> |
</para> |
| 268 |
</para> |
</para> |
| 269 |
<para> |
<para> |
| 270 |
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 |
| 271 |
present in the .orig.tar.gz will not be preserved, as diff does not store file |
present in the <filename>*.orig.tar.{gz,bz2,lzma}</filename> will not be preserved, as diff does not store file |
| 272 |
permissions in the patch. |
permissions in the patch. However when using source format “3.0 (quilt)”, |
| 273 |
|
permissions of files inside the <filename>debian</filename> directory are |
| 274 |
|
preserved since they are stored in a tar archive. |
| 275 |
</para> |
</para> |
| 276 |
</section> |
</section> |
| 277 |
|
|
| 281 |
Each upload needs to specify which distribution the package is intended for. |
Each upload needs to specify which distribution the package is intended for. |
| 282 |
The package build process extracts this information from the first line of the |
The package build process extracts this information from the first line of the |
| 283 |
<filename>debian/changelog</filename> file and places it in the |
<filename>debian/changelog</filename> file and places it in the |
| 284 |
<literal>Distribution</literal> field of the <literal>.changes</literal> file. |
<literal>Distribution</literal> field of the <filename>.changes</filename> file. |
| 285 |
</para> |
</para> |
| 286 |
<para> |
<para> |
| 287 |
There are several possible values for this field: <literal>stable</literal>, |
There are several possible values for this field: <literal>stable</literal>, |
| 288 |
<literal>unstable</literal>, <litersl>testing-proposed-updates</literal> and |
<literal>unstable</literal>, <literal>testing-proposed-updates</literal> and |
| 289 |
<literal>experimental</literal>. Normally, packages are uploaded into |
<literal>experimental</literal>. Normally, packages are uploaded into |
| 290 |
<literal>unstable</literal>. |
<literal>unstable</literal>. |
| 291 |
</para> |
</para> |
| 292 |
<para> |
<para> |
| 293 |
Actually, there are two other possible distributions: <literal>stable-security |
Actually, there are two other possible distributions: <literal>stable-security</literal> |
| 294 |
</literal> and <literal>testing-security</literal>, but read |
and <literal>testing-security</literal>, but read |
| 295 |
<xref linkend="bug-security"/> for more information on those. |
<xref linkend="bug-security"/> for more information on those. |
| 296 |
</para> |
</para> |
| 297 |
<para> |
<para> |
| 299 |
time. |
time. |
| 300 |
</para> |
</para> |
| 301 |
<section id="upload-stable"> |
<section id="upload-stable"> |
| 302 |
<title>Special case: uploads to the <literal>stable</literal> distribution</title> |
<title>Special case: uploads to the <literal>stable</literal> and |
| 303 |
|
<literal>oldstable</literal> distributions</title> |
| 304 |
<para> |
<para> |
| 305 |
Uploading to <literal>stable</literal> means that the package will transfered |
Uploading to <literal>stable</literal> means that the package will transferred |
| 306 |
to the <literal>proposed-updates-new</literal>-queue for review by the stable |
to the <literal>proposed-updates-new</literal> queue for review by the stable |
| 307 |
release managers, and if approved will be installed in |
release managers, and if approved will be installed in |
| 308 |
<filename>stable-proposed-updates</filename> directory of the Debian archive. |
<filename>stable-proposed-updates</filename> directory of the Debian archive. |
| 309 |
From there, it will be included in <literal>stable</literal> with the next |
From there, it will be included in <literal>stable</literal> with the next |
| 310 |
point release. |
point release. |
| 311 |
</para> |
</para> |
| 312 |
<para> |
<para> |
| 313 |
|
To ensure that your upload will be accepted, you should discuss the changes |
| 314 |
|
with the stable release team before you upload. For that, send a mail to |
| 315 |
|
the &email-debian-release; mailing list, including the patch you want to |
| 316 |
|
apply to the package version currently in <literal>stable</literal>. Always |
| 317 |
|
be verbose and detailed in your changelog entries for uploads to the |
| 318 |
|
<literal>stable</literal> distribution. |
| 319 |
|
</para> |
| 320 |
|
<para> |
| 321 |
Extra care should be taken when uploading to <literal>stable</literal>. |
Extra care should be taken when uploading to <literal>stable</literal>. |
| 322 |
Basically, a package should only be uploaded to <literal>stable</literal> if |
Basically, a package should only be uploaded to <literal>stable</literal> if |
| 323 |
one of the following happens: |
one of the following happens: |
| 345 |
used for Debian security advisories are automatically copied to the appropriate |
used for Debian security advisories are automatically copied to the appropriate |
| 346 |
<filename>proposed-updates</filename> archive when the advisory is released. |
<filename>proposed-updates</filename> archive when the advisory is released. |
| 347 |
See <xref linkend="bug-security"/> for detailed information on handling |
See <xref linkend="bug-security"/> for detailed information on handling |
| 348 |
security problems. |
security problems. If the security teams deems the problem to be too |
| 349 |
|
benign to be fixed through a <literal>DSA</literal>, the stable release |
| 350 |
|
managers are usually willing to include your fix nonetheless in a regular |
| 351 |
|
upload to <literal>stable</literal>. |
| 352 |
</para> |
</para> |
| 353 |
<para> |
<para> |
| 354 |
Changing anything else in the package that isn't important is discouraged, |
Changing anything else in the package that isn't important is discouraged, |
| 359 |
running <literal>stable</literal>, so that their dependencies are limited to |
running <literal>stable</literal>, so that their dependencies are limited to |
| 360 |
the libraries (and other packages) available in <literal>stable</literal>; |
the libraries (and other packages) available in <literal>stable</literal>; |
| 361 |
for example, a package uploaded to <literal>stable</literal> that depends on |
for example, a package uploaded to <literal>stable</literal> that depends on |
| 362 |
a library package that only exists in <literal>unstable</literal> will be |
a library package that only exists in <literal>unstable</literal> will be |
| 363 |
rejected. Making changes to dependencies of other packages (by messing with |
rejected. Making changes to dependencies of other packages (by messing with |
| 364 |
<literal>Provides</literal> or <literal>shlibs</literal> files), possibly |
<literal>Provides</literal> or <filename>shlibs</filename> files), possibly |
| 365 |
making those other packages uninstallable, is strongly discouraged. |
making those other packages uninstallable, is strongly discouraged. |
| 366 |
</para> |
</para> |
| 367 |
<para> |
<para> |
| 368 |
The Release Team (which can be reached at |
Uploads to the <literal>oldstable</literal> distributions are possible as |
| 369 |
&email-debian-release;) will regularly evaluate the uploads to |
long as it hasn't been archived. The same rules as for <literal>stable</literal> |
| 370 |
<literal>stable-proposed-updates</literal> and decide if your package can be |
apply. |
|
included in <literal>stable</literal>. Please be clear (and verbose, if |
|
|
necessary) in your changelog entries for uploads to |
|
|
<literal>stable</literal>, because otherwise the package won't be considered |
|
|
for inclusion. |
|
|
</para> |
|
|
<para> |
|
|
It's best practice to speak with the stable release manager |
|
|
<emphasis>before</emphasis> uploading to |
|
|
<literal>stable</literal>/<literal>stable-proposed-updates</literal>, so |
|
|
that the uploaded package fits the needs of the next point release. |
|
| 371 |
</para> |
</para> |
| 372 |
</section> |
</section> |
| 373 |
|
|
| 387 |
<title>Uploading to <literal>ftp-master</literal></title> |
<title>Uploading to <literal>ftp-master</literal></title> |
| 388 |
<para> |
<para> |
| 389 |
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 |
| 390 |
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 |
| 391 |
the directory <ulink |
the directory <ulink |
| 392 |
url="ftp://&ftp-master-host;&upload-queue;">&upload-queue;</ulink>. |
url="ftp://&ftp-upload-host;&upload-queue;">&upload-queue;</ulink>. |
| 393 |
To get the files processed there, they need to be signed with a key in the |
To get the files processed there, they need to be signed with a key in the |
| 394 |
Debian Developers keyring or the Debian Maintainers keyring |
Debian Developers keyring or the Debian Maintainers keyring |
| 395 |
(see <ulink url="&url-wiki-dm;"></ulink>). |
(see <ulink url="&url-wiki-dm;"></ulink>). |
| 400 |
changes file and see that not all files have been uploaded. |
changes file and see that not all files have been uploaded. |
| 401 |
</para> |
</para> |
| 402 |
<para> |
<para> |
| 403 |
You may also find the Debian packages <xref linkend="dupload"/> or <xref |
You may also find the Debian packages <link linkend="dupload">dupload</link> |
| 404 |
linkend="dput"/> useful when uploading packages. These handy programs help |
or <link linkend="dput">dput</link> useful when uploading packages.These |
| 405 |
automate the process of uploading packages into Debian. |
handy programs help automate the process of uploading packages into Debian. |
| 406 |
</para> |
</para> |
| 407 |
<para> |
<para> |
| 408 |
For removing packages, please see the README file in that ftp directory, and |
For removing packages, please see |
| 409 |
the Debian package <xref linkend="dcut"/> . |
<ulink url="ftp://&ftp-upload-host;&upload-queue;README"/> and |
| 410 |
|
the Debian package <link linkend="dcut">dcut</link>. |
| 411 |
</para> |
</para> |
| 412 |
</section> |
</section> |
| 413 |
|
|
| 414 |
<section id="delayed-incoming"> |
<section id="delayed-incoming"> |
| 415 |
<title>Delayed uploads</title> |
<title>Delayed uploads</title> |
| 416 |
|
|
| 417 |
<para> |
<para> |
| 418 |
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 |
| 419 |
</literal>. The upload-directory is |
package to arrive in the archive only a few days later. For example, |
| 420 |
<literal>gluck:~tfheen/DELAYED/[012345678]-day</literal>. 0-day is uploaded |
when preparing a <link linkend="nmu">Non-Maintainer Upload</link>, |
| 421 |
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 |
|
| 422 |
</para> |
</para> |
| 423 |
<screen> |
|
|
[tfheen_delayed] |
|
|
method = scp |
|
|
fqdn = gluck.debian.org |
|
|
incoming = ~tfheen |
|
|
</screen> |
|
| 424 |
<para> |
<para> |
| 425 |
in <filename>~/.dput.cf</filename> should work fine for uploading to the |
An upload to the delayed directory keeps the package in |
| 426 |
<literal>DELAYED</literal> queue. |
<ulink url="http://ftp-master.debian.org/deferred.html">the deferred uploads queue</ulink>. |
| 427 |
|
When the specified waiting time is over, the package is moved into |
| 428 |
|
the regular incoming directory for processing. |
| 429 |
|
This is done through automatic uploading to |
| 430 |
|
<literal>&ftp-upload-host;</literal> in upload-directory |
| 431 |
|
<literal>DELAYED/[012345678]-day</literal>. 0-day is uploaded |
| 432 |
|
multiple times per day to <literal>&ftp-upload-host;</literal>. |
| 433 |
</para> |
</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 |
|
|
| 441 |
<title>Security uploads</title> |
<title>Security uploads</title> |
| 442 |
<para> |
<para> |
| 443 |
Do <emphasis role="strong">NOT</emphasis> upload a package to the security |
Do <emphasis role="strong">NOT</emphasis> upload a package to the security |
| 444 |
upload queue (<literal>oldstable-security</literal>, <literal>stable-security |
upload queue (<literal>oldstable-security</literal>, <literal>stable-security</literal>, |
| 445 |
</literal>, etc.) without prior authorization from the security team. If the |
etc.) without prior authorization from the security team. If the |
| 446 |
package does not exactly meet the team's requirements, it will cause many |
package does not exactly meet the team's requirements, it will cause many |
| 447 |
problems and delays in dealing with the unwanted upload. For details, please |
problems and delays in dealing with the unwanted upload. For details, please |
| 448 |
see section <xref linkend="bug-security"/> . |
see <xref linkend="bug-security"/>. |
| 449 |
</para> |
</para> |
| 450 |
</section> |
</section> |
| 451 |
|
|
| 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 <link linkend="delayed-incoming">delayed uploads</link>. |
| 465 |
</para> |
</para> |
| 466 |
</section> |
</section> |
| 467 |
|
|
| 472 |
For the most part, uploads are automatically handled on a daily basis by the |
For the most part, uploads are automatically handled on a daily basis by the |
| 473 |
archive maintenance tools, <command>katie</command>. Specifically, updates to |
archive maintenance tools, <command>katie</command>. Specifically, updates to |
| 474 |
existing packages to the <literal>unstable</literal> distribution are handled |
existing packages to the <literal>unstable</literal> distribution are handled |
| 475 |
automatically. In other cases, notably new packages, placing the uploaded |
automatically. In other cases, notably new packages, placing the uploaded |
| 476 |
package into the distribution is handled manually. When uploads are handled |
package into the distribution is handled manually. When uploads are handled |
| 477 |
manually, the change to the archive may take up to a month to occur. Please |
manually, the change to the archive may take up to a month to occur. Please |
| 478 |
be patient. |
be patient. |
| 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 |
| 536 |
<para> |
<para> |
| 537 |
Note that the <literal>Section</literal> field describes both the section as |
Note that the <literal>Section</literal> field describes both the section as |
| 538 |
well as the subsection, which are described in <xref |
well as the subsection, which are described in <xref |
| 539 |
linkend="archive-sections"/> . If the section is main, it should be omitted. |
linkend="archive-sections"/>. If the section is main, it should be omitted. |
| 540 |
The list of allowable subsections can be found in <ulink |
The list of allowable subsections can be found in <ulink |
| 541 |
url="&url-debian-policy;ch-archive.html#s-subsections"></ulink>. |
url="&url-debian-policy;ch-archive.html#s-subsections"></ulink>. |
| 542 |
</para> |
</para> |
| 547 |
<para> |
<para> |
| 548 |
Every developer has to be able to work with the Debian <ulink |
Every developer has to be able to work with the Debian <ulink |
| 549 |
url="&url-bts;">bug tracking system</ulink>. This includes |
url="&url-bts;">bug tracking system</ulink>. This includes |
| 550 |
knowing how to file bug reports properly (see <xref linkend="submit-bug"/> ), |
knowing how to file bug reports properly (see <xref linkend="submit-bug"/>), |
| 551 |
how to update them and reorder them, and how to process and close them. |
how to update them and reorder them, and how to process and close them. |
| 552 |
</para> |
</para> |
| 553 |
<para> |
<para> |
| 600 |
<para> |
<para> |
| 601 |
When responding to bugs, make sure that any discussion you have about bugs is |
When responding to bugs, make sure that any discussion you have about bugs is |
| 602 |
sent both to the original submitter of the bug, and to the bug itself (e.g., |
sent both to the original submitter of the bug, and to the bug itself (e.g., |
| 603 |
<email>123@&bugs-host;</email>). If you're writing a new mail and you |
<email><replaceable>123</replaceable>@&bugs-host;</email>). If you're writing a new mail and you |
| 604 |
don't remember the submitter email address, you can use the |
don't remember the submitter email address, you can use the |
| 605 |
<email>123-submitter@&bugs-host;</email> email to contact the submitter |
<email><replaceable>123</replaceable>-submitter@&bugs-host;</email> email to contact the submitter |
| 606 |
<emphasis>and</emphasis> to record your mail within the bug log (that means you |
<emphasis>and</emphasis> to record your mail within the bug log (that means you |
| 607 |
don't need to send a copy of the mail to <email>123@&bugs-host;</email>). |
don't need to send a copy of the mail to <email><replaceable>123</replaceable>@&bugs-host;</email>). |
| 608 |
</para> |
</para> |
| 609 |
<para> |
<para> |
| 610 |
If you get a bug which mentions FTBFS, this means Fails to build from source. |
If you get a bug which mentions FTBFS, this means Fails to build from source. |
| 613 |
<para> |
<para> |
| 614 |
Once you've dealt with a bug report (e.g. fixed it), mark it as |
Once you've dealt with a bug report (e.g. fixed it), mark it as |
| 615 |
<literal>done</literal> (close it) by sending an explanation message to |
<literal>done</literal> (close it) by sending an explanation message to |
| 616 |
<email>123-done@&bugs-host;</email>. If you're fixing a bug by changing |
<email><replaceable>123</replaceable>-done@&bugs-host;</email>. If you're fixing a bug by changing |
| 617 |
and uploading the package, you can automate bug closing as described in <xref |
and uploading the package, you can automate bug closing as described in <xref |
| 618 |
linkend="upload-bugfix"/> . |
linkend="upload-bugfix"/>. |
| 619 |
</para> |
</para> |
| 620 |
<para> |
<para> |
| 621 |
You should <emphasis>never</emphasis> close bugs via the bug server |
You should <emphasis>never</emphasis> close bugs via the bug server |
| 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><replaceable>packagename</replaceable>@packages.debian.org</email> and explaining |
| 682 |
|
your reasons in that mail. Please note that a simple reassignment is |
| 683 |
|
<emphasis>not</emphasis> e-mailed to the maintainers of the package |
| 684 |
|
being reassigned to, so they won't know about it until they look at |
| 685 |
|
a bug overview for their packages. |
| 686 |
</para> |
</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 |
| 740 |
<listitem> |
<listitem> |
| 741 |
<para> |
<para> |
| 742 |
If you have fixed a bug in your local copy, or if a fix has been committed to |
If you have fixed a bug in your local copy, or if a fix has been committed to |
| 743 |
the CVS repository, you may tag the bug as <literal>pending</literal> to let |
the VCS repository, you may tag the bug as <literal>pending</literal> to let |
| 744 |
people know that the bug is corrected and that it will be closed with the next |
people know that the bug is corrected and that it will be closed with the next |
| 745 |
upload (add the <literal>closes:</literal> in the |
upload (add the <literal>closes:</literal> in the |
| 746 |
<filename>changelog</filename>). This is particularly useful if you are |
<filename>changelog</filename>). This is particularly useful if you are |
| 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> |
| 792 |
We prefer the <literal>closes: #<replaceable>XXX</replaceable></literal> |
We prefer the <literal>closes: #<replaceable>XXX</replaceable></literal> |
| 793 |
syntax, as it is the most concise entry and the easiest to integrate with the |
syntax, as it is the most concise entry and the easiest to integrate with the |
| 794 |
text of the <filename>changelog</filename>. Unless specified different by the |
text of the <filename>changelog</filename>. Unless specified different by the |
| 795 |
<replaceable>-v</replaceable>-switch to <command>dpkg-buildpackage</command>, |
<literal>-v</literal>-switch to <command>dpkg-buildpackage</command>, |
| 796 |
only the bugs closed in the most recent changelog entry are closed (basically, |
only the bugs closed in the most recent changelog entry are closed (basically, |
| 797 |
exactly the bugs mentioned in the changelog-part in the |
exactly the bugs mentioned in the changelog-part in the |
| 798 |
<filename>.changes</filename> file are closed). |
<filename>.changes</filename> file are closed). |
| 799 |
</para> |
</para> |
| 800 |
<para> |
<para> |
| 801 |
Historically, uploads identified as <link linkend="nmu">Non-maintainer |
Historically, uploads identified as <link linkend="nmu">non-maintainer |
| 802 |
upload (NMU)</link> were tagged <literal>fixed</literal> instead of being |
upload (NMU)</link> were tagged <literal>fixed</literal> instead of being |
| 803 |
closed, but that practice was ceased with the advent of version-tracking. The |
closed, but that practice was ceased with the advent of version-tracking. The |
| 804 |
same applied to the tag <literal>fixed-in-experimental</literal>. |
same applied to the tag <literal>fixed-in-experimental</literal>. |
| 810 |
to the bug tracking system's control address, |
to the bug tracking system's control address, |
| 811 |
&email-bts-control;. To close any remaining bugs that were |
&email-bts-control;. To close any remaining bugs that were |
| 812 |
fixed by your upload, email the <filename>.changes</filename> file to |
fixed by your upload, email the <filename>.changes</filename> file to |
| 813 |
<email>XXX-done@&bugs-host;</email>, where <replaceable>XXX</replaceable> |
<email><replaceable>XXX</replaceable>-done@&bugs-host;</email>, where <replaceable>XXX</replaceable> |
| 814 |
is the bug number, and put Version: YYY and an empty line as the first two |
is the bug number, and put Version: <replaceable>YYY</replaceable> and an empty line as the first two |
| 815 |
lines of the body of the email, where <replaceable>YYY</replaceable> is the |
lines of the body of the email, where <replaceable>YYY</replaceable> is the |
| 816 |
first version where the bug has been fixed. |
first version where the bug has been fixed. |
| 817 |
</para> |
</para> |
| 819 |
Bear in mind that it is not obligatory to close bugs using the changelog as |
Bear in mind that it is not obligatory to close bugs using the changelog as |
| 820 |
described above. If you simply want to close bugs that don't have anything to |
described above. If you simply want to close bugs that don't have anything to |
| 821 |
do with an upload you made, do it by emailing an explanation to |
do with an upload you made, do it by emailing an explanation to |
| 822 |
<email>XXX-done@&bugs-host;</email>. Do <emphasis |
<email><replaceable>XXX</replaceable>-done@&bugs-host;</email>. Do <emphasis |
| 823 |
role="strong">not</emphasis> close bugs in the changelog entry of a version if |
role="strong">not</emphasis> close bugs in the changelog entry of a version if |
| 824 |
the changes in that version of the package don't have any bearing on the bug. |
the changes in that version of the package don't have any bearing on the bug. |
| 825 |
</para> |
</para> |
| 826 |
<para> |
<para> |
| 827 |
For general information on how to write your changelog entries, see <xref |
For general information on how to write your changelog entries, see <xref |
| 828 |
linkend="bpp-debian-changelog"/> . |
linkend="bpp-debian-changelog"/>. |
| 829 |
</para> |
</para> |
| 830 |
</section> |
</section> |
| 831 |
|
|
| 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> |
| 851 |
<para> |
<para> |
| 852 |
Which versions of the package are known to be affected by the bug. Check each |
Which versions of the package are known to be affected by the bug. Check each |
| 853 |
version that is present in a supported Debian release, as well as |
version that is present in a supported Debian release, as well as |
| 854 |
<literal>testing</literal> and <literal>unstable</literal>. |
<literal>testing</literal> and <literal>unstable</literal>. |
| 855 |
</para> |
</para> |
| 856 |
</listitem> |
</listitem> |
| 862 |
<listitem> |
<listitem> |
| 863 |
<para> |
<para> |
| 864 |
Any fixed packages that you have prepared yourself (send only the |
Any fixed packages that you have prepared yourself (send only the |
| 865 |
<literal>.diff.gz</literal> and <literal>.dsc</literal> files and read <xref |
<filename>.diff.gz</filename> and <filename>.dsc</filename> files and read <xref |
| 866 |
linkend="bug-security-building"/> first) |
linkend="bug-security-building"/> first) |
| 867 |
</para> |
</para> |
| 868 |
</listitem> |
</listitem> |
| 875 |
<listitem> |
<listitem> |
| 876 |
<para> |
<para> |
| 877 |
Any information needed for the advisory (see <xref |
Any information needed for the advisory (see <xref |
| 878 |
linkend="bug-security-advisories"/> ) |
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> |
| 960 |
be sure to mention this fact. |
be sure to mention this fact. |
| 961 |
</para> |
</para> |
| 962 |
<para> |
<para> |
| 963 |
Please note that if secrecy is needed you may not upload a fix to |
Please note that if secrecy is needed you may not upload a fix to |
| 964 |
<literal>unstable</literal> (or |
<literal>unstable</literal> (or |
| 965 |
anywhere else, such as a public CVS repository). It is not sufficient to |
anywhere else, such as a public VCS repository). It is not sufficient to |
| 966 |
obfuscate the details of the change, as the code itself is public, and can (and |
obfuscate the details of the change, as the code itself is public, and can (and |
| 967 |
will) be examined by the general public. |
will) be examined by the general public. |
| 968 |
</para> |
</para> |
| 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"> |
| 1103 |
<systemitem role="package">patchutils</systemitem> package and |
<systemitem role="package">patchutils</systemitem> package and |
| 1104 |
<command>debdiff</command> from <systemitem |
<command>debdiff</command> from <systemitem |
| 1105 |
role="package">devscripts</systemitem> are useful tools for this, see <xref |
role="package">devscripts</systemitem> are useful tools for this, see <xref |
| 1106 |
linkend="debdiff"/> ). |
linkend="debdiff"/>). |
| 1107 |
</para> |
</para> |
| 1108 |
<para> |
<para> |
| 1109 |
Be sure to verify the following items: |
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>! |
| 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. |
|
|
</para> |
|
|
</listitem> |
|
|
<listitem> |
|
|
<para> |
|
|
Make sure the version number is proper. It must be greater than the current |
|
|
package, but less than package versions in later distributions. If in doubt, |
|
|
test it with <literal>dpkg --compare-versions</literal>. Be careful not to |
|
|
re-use a version number that you have already used for a previous upload. For |
|
|
<literal>testing</literal>, there must be a higher version in |
|
|
<literal>unstable</literal>. If there is none yet (for example, if |
|
|
<literal>testing</literal> and <literal>unstable</literal> have the same |
|
|
version) you must upload a new version to <literal>unstable</literal> first. |
|
| 1137 |
</para> |
</para> |
| 1138 |
</listitem> |
</listitem> |
| 1139 |
<listitem> |
<listitem> |
| 1140 |
<para> |
<para> |
| 1141 |
Do not make source-only uploads if your package has any binary-all packages (do |
Make sure the <emphasis role="strong">version number</emphasis> is proper. |
| 1142 |
not use the <literal>-S</literal> option to |
It must be greater than the current package, but less than package versions in |
| 1143 |
<command>dpkg-buildpackage</command>). The <command>buildd</command> |
later distributions. If in doubt, test it with <literal>dpkg |
| 1144 |
infrastructure will not build those. This point applies to normal package |
--compare-versions</literal>. Be careful not to re-use a version number that |
| 1145 |
uploads as well. |
you have already used for a previous upload, or one that conflicts with a |
| 1146 |
|
binNMU. The convention is to append |
| 1147 |
|
<literal>+</literal><replaceable>codename</replaceable><literal>1</literal>, e.g. |
| 1148 |
|
<literal>1:2.4.3-4+lenny1</literal>, of course increasing 1 for any subsequent |
| 1149 |
|
uploads. |
| 1150 |
</para> |
</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,lzma}</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> |
| 1183 |
<title>Uploading the fixed package</title> |
<title>Uploading the fixed package</title> |
| 1184 |
<para> |
<para> |
| 1185 |
Do <emphasis role="strong">NOT</emphasis> upload a package to the security |
Do <emphasis role="strong">NOT</emphasis> upload a package to the security |
| 1186 |
upload queue (<literal>oldstable-security</literal>, <literal>stable-security |
upload queue (<literal>oldstable-security</literal>, <literal>stable-security</literal>, |
| 1187 |
</literal>, etc.) without prior authorization from the security team. If the |
etc.) without prior authorization from the security team. If the |
| 1188 |
package does not exactly meet the team's requirements, it will cause many |
package does not exactly meet the team's requirements, it will cause many |
| 1189 |
problems and delays in dealing with the unwanted upload. |
problems and delays in dealing with the unwanted upload. |
| 1190 |
</para> |
</para> |
| 1191 |
<para> |
<para> |
| 1192 |
Do <emphasis role="strong">NOT</emphasis> upload your fix to <literal> |
Do <emphasis role="strong">NOT</emphasis> upload your fix to |
| 1193 |
proposed-updates</literal> without coordinating with the security team. |
<literal>proposed-updates</literal> without coordinating with the security team. |
| 1194 |
Packages from <literal>security.debian.org</literal> will be copied into |
Packages from <literal>security.debian.org</literal> will be copied into |
| 1195 |
the <literal>proposed-updates</literal> directory automatically. If a package |
the <literal>proposed-updates</literal> directory automatically. If a package |
| 1196 |
with the same or a higher version number is already installed into the archive, |
with the same or a higher version number is already installed into the archive, |
| 1202 |
Once you have created and tested the new package and it has been approved by |
Once you have created and tested the new package and it has been approved by |
| 1203 |
the security team, it needs to be uploaded so that it can be installed in the |
the security team, it needs to be uploaded so that it can be installed in the |
| 1204 |
archives. For security uploads, the place to upload to is |
archives. For security uploads, the place to upload to is |
| 1205 |
<literal>ftp://security-master.debian.org/pub/SecurityUploadQueue/</literal> . |
<literal>ftp://security-master.debian.org/pub/SecurityUploadQueue/</literal>. |
| 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> |
| 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,lzma}</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 |
| 1259 |
of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly |
of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly |
| 1260 |
different. Correct the subsection as found in the control file of the package, |
different. Correct the subsection as found in the control file of the package, |
| 1261 |
and re-upload that. Also, you'll need to get the override file updated, as |
and re-upload that. Also, you'll need to get the override file updated, as |
| 1262 |
described in <xref linkend="override-file"/> . |
described in <xref linkend="override-file"/>. |
| 1263 |
</para> |
</para> |
| 1264 |
</section> |
</section> |
| 1265 |
|
|
| 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</replaceable> |
| 1274 |
can only have packages removed from <literal>unstable</literal> and |
<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 |
| 1282 |
|
<literal>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</literal>, |
| 1296 |
|
<literal>experimental</literal> and <literal>stable</literal> |
| 1297 |
|
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 |
| 1301 |
depends on it. |
<literal>testing</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 |
| 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 |
| 1337 |
role="package">apt</systemitem> package. When invoked as <literal>apt-cache |
role="package">apt</systemitem> package. When invoked as <literal>apt-cache |
| 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 <command>apt-cache rdepends</command>, |
| 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> |
| 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><most-recent-version-ever-in-Debian>+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> |
| 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;">Debian |
| 1383 |
the package with the obsolete name. Do not forget to properly reassign the |
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>ftp.debian.org</literal> |
| 1388 |
|
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 |
| 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 |
|
|
| 1448 |
It is not OK to simply take over a package that you feel is neglected — that |
It is not OK to simply take over a package that you feel is neglected — that |
| 1449 |
would be package hijacking. You can, of course, contact the current maintainer |
would be package hijacking. You can, of course, contact the current maintainer |
| 1450 |
and ask them if you may take over the package. If you have reason to believe a |
and ask them if you may take over the package. If you have reason to believe a |
| 1451 |
maintainer has gone AWOL (absent without leave), see <xref linkend="mia-qa"/> . |
maintainer has gone AWOL (absent without leave), see <xref linkend="mia-qa"/>. |
| 1452 |
</para> |
</para> |
| 1453 |
<para> |
<para> |
| 1454 |
Generally, you may not take over the package without the assent of the current |
Generally, you may not take over the package without the assent of the current |
| 1464 |
If you take over an old package, you probably want to be listed as the |
If you take over an old package, you probably want to be listed as the |
| 1465 |
package's official maintainer in the bug system. This will happen |
package's official maintainer in the bug system. This will happen |
| 1466 |
automatically once you upload a new version with an updated |
automatically once you upload a new version with an updated |
| 1467 |
<literal>Maintainer:</literal> field, although it can take a few hours after |
<literal>Maintainer</literal> field, although it can take a few hours after |
| 1468 |
the upload is done. If you do not expect to upload a new version for a while, |
the upload is done. If you do not expect to upload a new version for a while, |
| 1469 |
you can use <xref linkend="pkg-tracking-system"/> to get the bug reports. |
you can use <xref linkend="pkg-tracking-system"/> to get the bug reports. |
| 1470 |
However, make sure that the old maintainer has no problem with the fact that |
However, make sure that the old maintainer has no problem with the fact that |
| 1486 |
Porting is the act of building Debian packages for architectures that are |
Porting is the act of building Debian packages for architectures that are |
| 1487 |
different from the original architecture of the package maintainer's binary |
different from the original architecture of the package maintainer's binary |
| 1488 |
package. It is a unique and essential activity. In fact, porters do most of |
package. It is a unique and essential activity. In fact, porters do most of |
| 1489 |
the actual compiling of Debian packages. For instance, for a single |
the actual compiling of Debian packages. For instance, when a maintainer |
| 1490 |
<literal>i386</literal> binary package, there must be a recompile for each |
uploads a (portable) source packages with binaries for the <literal>i386</literal> |
| 1491 |
architecture, which amounts to &number-of-arches; more builds. |
architecture, it will be built for each of the other architectures, |
| 1492 |
|
amounting to &number-of-arches; more builds. |
| 1493 |
</para> |
</para> |
| 1494 |
<section id="kind-to-porters"> |
<section id="kind-to-porters"> |
| 1495 |
<title>Being kind to porters</title> |
<title>Being kind to porters</title> |
| 1521 |
<filename>debian/control</filename> are set properly. The best way to validate |
<filename>debian/control</filename> are set properly. The best way to validate |
| 1522 |
this is to use the <systemitem role="package">debootstrap</systemitem> package |
this is to use the <systemitem role="package">debootstrap</systemitem> package |
| 1523 |
to create an <literal>unstable</literal> chroot environment (see <xref |
to create an <literal>unstable</literal> chroot environment (see <xref |
| 1524 |
linkend="debootstrap"/> ). |
linkend="debootstrap"/>). |
| 1525 |
Within that chrooted environment, install the <systemitem |
Within that chrooted environment, install the <systemitem |
| 1526 |
role="package">build-essential</systemitem> package and any package |
role="package">build-essential</systemitem> package and any package |
| 1527 |
dependencies mentioned in <literal>Build-Depends</literal> and/or |
dependencies mentioned in <literal>Build-Depends</literal> and/or |
| 1528 |
<literal>Build-Depends-Indep</literal>. Finally, try building your package |
<literal>Build-Depends-Indep</literal>. Finally, try building your package |
| 1529 |
within that chrooted environment. These steps can be automated by the use of |
within that chrooted environment. These steps can be automated by the use of |
| 1530 |
the <command>pbuilder</command> program which is provided by the package of the |
the <command>pbuilder</command> program which is provided by the package of the |
| 1531 |
same name (see <xref linkend="pbuilder"/> ). |
same name (see <xref linkend="pbuilder"/>). |
| 1532 |
</para> |
</para> |
| 1533 |
<para> |
<para> |
| 1534 |
If you can't set up a proper chroot, <command>dpkg-depcheck</command> may be of |
If you can't set up a proper chroot, <command>dpkg-depcheck</command> may be of |
| 1535 |
assistance (see <xref linkend="dpkg-depcheck"/> ). |
assistance (see <xref linkend="dpkg-depcheck"/>). |
| 1536 |
</para> |
</para> |
| 1537 |
<para> |
<para> |
| 1538 |
See the <ulink url="&url-debian-policy;">Debian Policy |
See the <ulink url="&url-debian-policy;">Debian Policy |
| 1541 |
</listitem> |
</listitem> |
| 1542 |
<listitem> |
<listitem> |
| 1543 |
<para> |
<para> |
| 1544 |
Don't set architecture to a value other than ``all'' or ``any'' unless you |
Don't set architecture to a value other than <literal>all</literal> or |
| 1545 |
really mean it. In too many cases, maintainers don't follow the instructions |
<literal>any</literal> unless you really mean it. In too many cases, |
| 1546 |
in the <ulink url="&url-debian-policy;">Debian Policy |
maintainers don't follow the instructions in the <ulink |
| 1547 |
Manual</ulink>. Setting your architecture to ``i386'' is usually incorrect. |
url="&url-debian-policy;">Debian Policy Manual</ulink>. Setting your |
| 1548 |
|
architecture to only one architecture (such as <literal>i386</literal> |
| 1549 |
|
or <literal>amd64</literal>) is usually incorrect. |
| 1550 |
</para> |
</para> |
| 1551 |
</listitem> |
</listitem> |
| 1552 |
<listitem> |
<listitem> |
| 1561 |
<para> |
<para> |
| 1562 |
Make sure you don't ship your source package with the |
Make sure you don't ship your source package with the |
| 1563 |
<filename>debian/files</filename> or <filename>debian/substvars</filename> |
<filename>debian/files</filename> or <filename>debian/substvars</filename> |
| 1564 |
files. They should be removed by the `clean' target of |
files. They should be removed by the <literal>clean</literal> target of |
| 1565 |
<filename>debian/rules</filename>. |
<filename>debian/rules</filename>. |
| 1566 |
</para> |
</para> |
| 1567 |
</listitem> |
</listitem> |
| 1577 |
<listitem> |
<listitem> |
| 1578 |
<para> |
<para> |
| 1579 |
Don't depend on the package you're building being installed already (a sub-case |
Don't depend on the package you're building being installed already (a sub-case |
| 1580 |
of the above issue). |
of the above issue). There are, of course, exceptions to this rule, but be |
| 1581 |
|
aware that any case like this needs manual bootstrapping and cannot be done |
| 1582 |
|
by automated package builders. |
| 1583 |
</para> |
</para> |
| 1584 |
</listitem> |
</listitem> |
| 1585 |
<listitem> |
<listitem> |
| 1592 |
</listitem> |
</listitem> |
| 1593 |
<listitem> |
<listitem> |
| 1594 |
<para> |
<para> |
| 1595 |
Make sure your debian/rules contains separate ``binary-arch'' and |
Make sure your <filename>debian/rules</filename> contains separate <literal>binary-arch</literal> |
| 1596 |
``binary-indep'' targets, as the Debian Policy Manual requires. Make sure that |
and <literal>binary-indep</literal> targets, as the Debian Policy Manual |
| 1597 |
both targets work independently, that is, that you can call the target without |
requires. Make sure that both targets work independently, that is, that you |
| 1598 |
having called the other before. To test this, try to run |
can call the target without having called the other before. To test this, |
| 1599 |
<literal>dpkg-buildpackage -B</literal>. |
try to run <command>dpkg-buildpackage -B</command>. |
| 1600 |
</para> |
</para> |
| 1601 |
</listitem> |
</listitem> |
| 1602 |
</orderedlist> |
</orderedlist> |
| 1623 |
-m<replaceable>porter-email</replaceable></literal>. Of course, set |
-m<replaceable>porter-email</replaceable></literal>. Of course, set |
| 1624 |
<replaceable>porter-email</replaceable> to your email address. This will do a |
<replaceable>porter-email</replaceable> to your email address. This will do a |
| 1625 |
binary-only build of only the architecture-dependent portions of the package, |
binary-only build of only the architecture-dependent portions of the package, |
| 1626 |
using the `binary-arch' target in <filename>debian/rules</filename>. |
using the <literal>binary-arch</literal> target in |
| 1627 |
|
<filename>debian/rules</filename>. |
| 1628 |
</para> |
</para> |
| 1629 |
<para> |
<para> |
| 1630 |
If you are working on a Debian machine for your porting efforts and you need to |
If you are working on a Debian machine for your porting efforts and you need to |
| 1638 |
<para> |
<para> |
| 1639 |
Sometimes the initial porter upload is problematic because the environment in |
Sometimes the initial porter upload is problematic because the environment in |
| 1640 |
which the package was built was not good enough (outdated or obsolete library, |
which the package was built was not good enough (outdated or obsolete library, |
| 1641 |
bad compiler, ...). Then you may just need to recompile it in an updated |
bad compiler, etc.). Then you may just need to recompile it in an updated |
| 1642 |
environment. However, you have to bump the version number in this case, so |
environment. However, you have to bump the version number in this case, so |
| 1643 |
that the old bad package can be replaced in the Debian archive |
that the old bad package can be replaced in the Debian archive |
| 1644 |
(<command>katie</command> refuses to install new packages if they don't have a |
(<command>dak</command> refuses to install new packages if they don't have a |
| 1645 |
version number greater than the currently available one). |
version number greater than the currently available one). |
| 1646 |
</para> |
</para> |
| 1647 |
<para> |
<para> |
| 1648 |
You have to make sure that your binary-only NMU doesn't render the package |
You have to make sure that your binary-only NMU doesn't render the package |
| 1649 |
uninstallable. This could happen when a source package generates |
uninstallable. This could happen when a source package generates |
| 1650 |
arch-dependent and arch-independent packages that depend on each other via |
arch-dependent and arch-independent packages that have inter-dependencies |
| 1651 |
$(Source-Version). |
generated using dpkg's substitution variable <literal>$(Source-Version)</literal>. |
| 1652 |
</para> |
</para> |
| 1653 |
<para> |
<para> |
| 1654 |
Despite the required modification of the changelog, these are called |
Despite the required modification of the changelog, these are called |
| 1664 |
</para> |
</para> |
| 1665 |
<para> |
<para> |
| 1666 |
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 |
| 1667 |
appended to the package version number, following the form b<number>. |
appended to the package version number, following the form |
| 1668 |
|
<literal>b<replaceable>number</replaceable></literal>. |
| 1669 |
For instance, if the latest version you are recompiling against was version |
For instance, if the latest version you are recompiling against was version |
| 1670 |
``2.9-3'', your NMU should carry a version of ``2.9-3+b1''. If the latest |
<literal>2.9-3</literal>, your binary-only NMU should carry a version of |
| 1671 |
version was ``3.4+b1'' (i.e, a native package with a previous recompilation |
<literal>2.9-3+b1</literal>. If the latest version was <literal>3.4+b1</literal> |
| 1672 |
NMU), your NMU should have a version number of ``3.4+b2''. <footnote><para> In |
(i.e, a native package with a previous recompilation NMU), your |
| 1673 |
the past, such NMUs used the third-level number on the Debian part of the |
binary-only NMU should have a version number of <literal>3.4+b2</literal>.<footnote><para> |
| 1674 |
revision to denote their recompilation-only status; however, this syntax was |
In the past, such NMUs used the third-level number on the |
| 1675 |
ambiguous with native packages and did not allow proper ordering of |
Debian part of the revision to denote their recompilation-only status; |
| 1676 |
recompile-only NMUs, source NMUs, and security NMUs on the same package, and |
however, this syntax was ambiguous with native packages and did not allow |
| 1677 |
has therefore been abandoned in favor of this new syntax. </para> </footnote> |
proper ordering of recompile-only NMUs, source NMUs, and security NMUs on |
| 1678 |
|
the same package, and has therefore been abandoned in favor of this new syntax. |
| 1679 |
|
</para> </footnote> |
| 1680 |
</para> |
</para> |
| 1681 |
<para> |
<para> |
| 1682 |
Similar to initial porter uploads, the correct way of invoking |
Similar to initial porter uploads, the correct way of invoking |
| 1689 |
<title>When to do a source NMU if you are a porter</title> |
<title>When to do a source NMU if you are a porter</title> |
| 1690 |
<para> |
<para> |
| 1691 |
Porters doing a source NMU generally follow the guidelines found in <xref |
Porters doing a source NMU generally follow the guidelines found in <xref |
| 1692 |
linkend="nmu"/> , just like non-porters. However, it is expected that the wait |
linkend="nmu"/>, just like non-porters. However, it is expected that the wait |
| 1693 |
cycle for a porter's source NMU is smaller than for a non-porter, since porters |
cycle for a porter's source NMU is smaller than for a non-porter, since porters |
| 1694 |
have to cope with a large quantity of packages. Again, the situation varies |
have to cope with a large quantity of packages. Again, the situation varies |
| 1695 |
depending on the distribution they are uploading to. It also varies whether |
depending on the distribution they are uploading to. It also varies whether |
| 1697 |
release managers decide and announce which architectures are candidates. |
release managers decide and announce which architectures are candidates. |
| 1698 |
</para> |
</para> |
| 1699 |
<para> |
<para> |
| 1700 |
If you are a porter doing an NMU for <literal>unstable</literal>, the above |
If you are a porter doing an NMU for <literal>unstable</literal>, the above |
| 1701 |
guidelines for porting should be followed, with two variations. Firstly, the |
guidelines for porting should be followed, with two variations. Firstly, the |
| 1702 |
acceptable waiting period — the time between when the bug is submitted to |
acceptable waiting period — the time between when the bug is submitted to |
| 1703 |
the BTS and when it is OK to do an NMU — is seven days for porters working |
the BTS and when it is OK to do an NMU — is seven days for porters working |
| 1705 |
if the problem is critical and imposes hardship on the porting effort, at the |
if the problem is critical and imposes hardship on the porting effort, at the |
| 1706 |
discretion of the porter group. (Remember, none of this is Policy, just |
discretion of the porter group. (Remember, none of this is Policy, just |
| 1707 |
mutually agreed upon guidelines.) For uploads to <literal>stable</literal> or |
mutually agreed upon guidelines.) For uploads to <literal>stable</literal> or |
| 1708 |
<literal>testing </literal>, please coordinate with the appropriate release |
<literal>testing</literal>, please coordinate with the appropriate release |
| 1709 |
team first. |
team first. |
| 1710 |
</para> |
</para> |
| 1711 |
<para> |
<para> |
| 1712 |
Secondly, porters doing source NMUs should make sure that the bug they submit |
Secondly, porters doing source NMUs should make sure that the bug they submit |
| 1713 |
to the BTS should be of severity `serious' or greater. This ensures that a |
to the BTS should be of severity <literal>serious</literal> or greater. This |
| 1714 |
single source package can be used to compile every supported Debian |
ensures that a single source package can be used to compile every supported |
| 1715 |
architecture by release time. It is very important that we have one version of |
Debian architecture by release time. It is very important that we have one |
| 1716 |
the binary and source package for all architecture in order to comply with many |
version of the binary and source package for all architectures in order to |
| 1717 |
licenses. |
comply with many licenses. |
| 1718 |
</para> |
</para> |
| 1719 |
<para> |
<para> |
| 1720 |
Porters should try to avoid patches which simply kludge around bugs in the |
Porters should try to avoid patches which simply kludge around bugs in the |
| 1759 |
<title>Porter tools</title> |
<title>Porter tools</title> |
| 1760 |
<para> |
<para> |
| 1761 |
Descriptions of several porting tools can be found in <xref |
Descriptions of several porting tools can be found in <xref |
| 1762 |
linkend="tools-porting"/> . |
linkend="tools-porting"/>. |
| 1763 |
</para> |
</para> |
| 1764 |
</section> |
</section> |
| 1765 |
|
|
| 1766 |
<section id="buildd"> |
<section id="wanna-build"> |
| 1767 |
<title><systemitem role="package">buildd</systemitem></title> |
<title><systemitem role="package">wanna-build</systemitem></title> |
| 1768 |
<para> |
<para> |
| 1769 |
The <systemitem role="package">buildd</systemitem> system is used as a |
The <systemitem role="package">wanna-build</systemitem> system is used as a |
| 1770 |
distributed, client-server build distribution system. It is usually used in |
distributed, client-server build distribution system. It is usually used in |
| 1771 |
conjunction with <literal>build daemons</literal>, which are ``slave'' hosts |
conjunction with build daemons running the <systemitem role="package">buildd</systemitem> |
| 1772 |
which simply check out and attempt to auto-build packages which need to be |
program. <literal>Build daemons</literal> are ``slave'' hosts |
| 1773 |
ported. There is also an email interface to the system, which allows porters |
which contact the central <systemitem role="package">wanna-build</systemitem> |
| 1774 |
to ``check out'' a source package (usually one which cannot yet be auto-built) |
system to receive a list of packages that need to be built. |
| 1775 |
and work on it. |
</para> |
| 1776 |
</para> |
<para> |
| 1777 |
<para> |
<systemitem role="package">wanna-build</systemitem> is not yet available as a |
| 1778 |
<systemitem role="package">buildd</systemitem> is not yet available as a |
package; however, all Debian porting efforts are using it for automated |
| 1779 |
package; however, most porting efforts are either using it currently or |
package building. The tool used to do the actual package builds, <systemitem |
| 1780 |
planning to use it in the near future. The actual automated builder is |
role="package">sbuild</systemitem> is available as a package, see its |
| 1781 |
packaged as <systemitem role="package">sbuild</systemitem>, see its description |
description in <xref linkend="sbuild"/>. Please note that the packaged |
| 1782 |
in <xref linkend="sbuild"/> . The complete <systemitem |
version is not the same as the one used on build daemons, but it is close |
| 1783 |
role="package">buildd</systemitem> system also collects a number of as yet |
enough to reproduce problems. |
| 1784 |
unpackaged components which are currently very useful and in use continually, |
</para> |
| 1785 |
such as <command>andrea</command> and <command>wanna-build</command>. |
<para> |
| 1786 |
</para> |
Most of the data produced by <systemitem role="package">wanna-build</systemitem> |
| 1787 |
<para> |
which is generally useful to porters is available on the |
| 1788 |
Some of the data produced by <systemitem role="package">buildd</systemitem> |
web at <ulink url="&url-buildd;"></ulink>. This data includes nightly |
| 1789 |
which is generally useful to porters is available on the web at <ulink |
updated statistics, queueing information and logs for build attempts. |
|
url="&url-buildd;"></ulink>. This data includes nightly updated |
|
|
information from <command>andrea</command> (source dependencies) and |
|
|
<systemitem role="package">quinn-diff</systemitem> (packages needing |
|
|
recompilation). |
|
| 1790 |
</para> |
</para> |
| 1791 |
<para> |
<para> |
| 1792 |
We are quite proud of this system, since it has so many possible uses. |
We are quite proud of this system, since it has so many possible uses. |
| 1796 |
also enable Debian to recompile entire distributions quickly. |
also enable Debian to recompile entire distributions quickly. |
| 1797 |
</para> |
</para> |
| 1798 |
<para> |
<para> |
| 1799 |
The buildds admins of each arch can be contacted at the mail address |
The wanna-build team, in charge of the buildds, |
| 1800 |
<literal><replaceable>arch</replaceable>@buildd.debian.org</literal>. |
can be reached at <literal>debian-wb-team@lists.debian.org</literal>. |
| 1801 |
|
To determine who (wanna-build team, release team) and how (mail, BTS) |
| 1802 |
|
to contact, refer to <ulink url="&url-wb-team;"></ulink>. |
| 1803 |
|
</para> |
| 1804 |
|
|
| 1805 |
|
<para> |
| 1806 |
|
When requesting binNMUs or give-backs (retries after a failed build), |
| 1807 |
|
please use the format described at <ulink url="&url-release-wb;"/>. |
| 1808 |
</para> |
</para> |
| 1809 |
|
|
| 1810 |
</section> |
</section> |
| 1811 |
|
|
| 1812 |
</section> |
</section> |
| 1817 |
Some packages still have issues with building and/or working on some of the |
Some packages still have issues with building and/or working on some of the |
| 1818 |
architectures supported by Debian, and cannot be ported at all, or not within a |
architectures supported by Debian, and cannot be ported at all, or not within a |
| 1819 |
reasonable amount of time. An example is a package that is SVGA-specific (only |
reasonable amount of time. An example is a package that is SVGA-specific (only |
| 1820 |
i386), or uses other hardware-specific features not supported on all |
available for <literal>i386</literal> and <literal>amd64</literal>), or uses |
| 1821 |
architectures. |
other hardware-specific features not supported on all architectures. |
| 1822 |
</para> |
</para> |
| 1823 |
<para> |
<para> |
| 1824 |
In order to prevent broken packages from being uploaded to the archive, and |
In order to prevent broken packages from being uploaded to the archive, and |
| 1836 |
</para> |
</para> |
| 1837 |
<para> |
<para> |
| 1838 |
Additionally, if you believe the list of supported architectures is pretty |
Additionally, if you believe the list of supported architectures is pretty |
| 1839 |
constant, you should change 'any' to a list of supported architectures in |
constant, you should change <literal>any</literal> to a list of supported |
| 1840 |
debian/control. This way, the build will fail also, and indicate this to a |
architectures in <filename>debian/control</filename>. This way, the build will |
| 1841 |
human reader without actually trying. |
fail also, and indicate this to a human reader without actually trying. |
| 1842 |
</para> |
</para> |
| 1843 |
</listitem> |
</listitem> |
| 1844 |
<listitem> |
<listitem> |
| 1845 |
<para> |
<para> |
| 1846 |
In order to prevent autobuilders from needlessly trying to build your package, |
In order to prevent autobuilders from needlessly trying to build your package, |
| 1847 |
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 |
| 1848 |
by the <command>wanna-build</command> script. The current version is available |
by the <command>wanna-build</command> script. The current version is available |
| 1849 |
as <ulink |
as <ulink url="&url-buildd-p-a-s;"/>; |
|
url="&url-cvsweb;srcdep/Packages-arch-specific?cvsroot=dak"></ulink>; |
|
| 1850 |
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. |
| 1851 |
</para> |
</para> |
| 1852 |
</listitem> |
</listitem> |
| 1853 |
</itemizedlist> |
</itemizedlist> |
| 1854 |
<para> |
<para> |
| 1855 |
Please note that it is insufficient to only add your package to |
Please note that it is insufficient to only add your package to |
| 1856 |
Packages-arch-specific without making it fail to build on unsupported |
<filename>Packages-arch-specific</filename> without making it fail to build on unsupported |
| 1857 |
architectures: A porter or any other person trying to build your package might |
architectures: A porter or any other person trying to build your package might |
| 1858 |
accidently upload it without noticing it doesn't work. If in the past some |
accidently upload it without noticing it doesn't work. If in the past some |
| 1859 |
binary packages were uploaded on unsupported architectures, request their |
binary packages were uploaded on unsupported architectures, request their |
| 1860 |
removal by filing a bug against <systemitem |
removal by filing a bug against <systemitem |
| 1861 |
role="package">ftp.debian.org</systemitem> |
role="package">ftp.debian.org</systemitem>. |
| 1862 |
</para> |
</para> |
| 1863 |
</section> |
</section> |
| 1864 |
|
|
| 1867 |
<section id="nmu"> |
<section id="nmu"> |
| 1868 |
<title>Non-Maintainer Uploads (NMUs)</title> |
<title>Non-Maintainer Uploads (NMUs)</title> |
| 1869 |
<para> |
<para> |
| 1870 |
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 |
| 1871 |
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 |
| 1872 |
non-maintainer upload, or NMU. |
useful that other developers can upload a new version as well, for example if |
| 1873 |
</para> |
they want to fix a bug in a package they don't maintain, when the maintainer |
| 1874 |
<para> |
needs help to respond to issues. Such uploads are called |
| 1875 |
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="buildd"/> 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. |
|
| 1876 |
</para> |
</para> |
| 1877 |
|
|
| 1878 |
<section id="nmu-guidelines"> |
<section id="nmu-guidelines"> |
| 1879 |
<title>How to do a NMU</title> |
<title>When and how to do an NMU</title> |
| 1880 |
<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> |
|
| 1881 |
<para> |
<para> |
| 1882 |
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: |
|
| 1883 |
</para> |
</para> |
| 1884 |
<itemizedlist> |
<itemizedlist> |
| 1885 |
<listitem> |
<listitem> |
| 1886 |
<para> |
<para> |
| 1887 |
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 |
| 1888 |
filed in the Debian Bug Tracking System (BTS). If they are not, submit them |
packaging style in NMUs is discouraged. |
|
immediately. |
|
| 1889 |
</para> |
</para> |
| 1890 |
</listitem> |
</listitem> |
| 1891 |
<listitem> |
<listitem> |
| 1892 |
<para> |
<para> |
| 1893 |
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 |
| 1894 |
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 |
| 1895 |
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? |
| 1896 |
</para> |
</para> |
| 1897 |
</listitem> |
</listitem> |
| 1898 |
<listitem> |
<listitem> |
| 1899 |
<para> |
<para> |
| 1900 |
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: |
| 1901 |
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 |
| 1902 |
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 |
| 1903 |
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 |
| 1904 |
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, |
| 1905 |
non-disruptive as it can be. |
many people will be very unhappy about it. |
| 1906 |
</para> |
</para> |
| 1907 |
</listitem> |
</listitem> |
| 1908 |
<listitem> |
<listitem> |
| 1909 |
<para> |
<para> |
| 1910 |
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? |
| 1911 |
<xref linkend="delayed-incoming"/> ), send the final patch to the maintainer |
It is also a good idea to try to contact the |
| 1912 |
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. |
|
| 1913 |
</para> |
</para> |
| 1914 |
</listitem> |
</listitem> |
| 1915 |
<listitem> |
<listitem> |
| 1916 |
<para> |
<para> |
| 1917 |
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 |
| 1918 |
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 |
| 1919 |
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 |
| 1920 |
|
patch, because he can be expected to be more aware of potential issues which an |
| 1921 |
|
NMUer might miss. It is often a better use of everyone's time if the maintainer |
| 1922 |
|
is given an opportunity to upload a fix on their own. |
| 1923 |
</para> |
</para> |
| 1924 |
</listitem> |
</listitem> |
| 1925 |
</itemizedlist> |
</itemizedlist> |
| 1926 |
<para> |
<para> |
| 1927 |
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 |
| 1928 |
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 |
| 1929 |
involves shortening the period during which one is to wait before uploading the |
current package and your proposed NMU to the BTS. The |
| 1930 |
fixes, and shortening the DELAYED period. It is important to notice that even |
<command>nmudiff</command> script in the <systemitem role="package">devscripts</systemitem> package |
| 1931 |
in these so-called bug squashing party times, the NMU'er has to file bugs and |
might be helpful. |
| 1932 |
contact the developer first, and act later. Please see <xref |
</para> |
| 1933 |
linkend="qa-bsp"/> for details. |
<para> |
| 1934 |
</para> |
While preparing the patch, you should better be aware of any package-specific |
| 1935 |
<para> |
practices that the maintainer might be using. Taking them into account reduces |
| 1936 |
For the <literal>testing</literal> distribution, the rules may be changed by |
the burden of getting your changes integrated back in the normal package |
| 1937 |
the release managers. Please take additional care, and acknowledge that the |
workflow and thus increases the possibilities that that will happen. A good |
| 1938 |
usual way for a package to enter <literal>testing</literal> is through |
place where to look for for possible package-specific practices is |
| 1939 |
<literal>unstable</literal>. |
<ulink url="&url-debian-policy;ch-source.html#s-readmesource"><filename>debian/README.source</filename></ulink>. |
| 1940 |
</para> |
</para> |
| 1941 |
<para> |
<para> |
| 1942 |
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 |
| 1943 |
managers may also change the rules here. Please verify before you upload that |
to the maintainer to react (for example, by uploading to the |
| 1944 |
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. |
|
| 1945 |
</para> |
</para> |
| 1946 |
|
<itemizedlist> |
| 1947 |
|
<listitem> |
| 1948 |
<para> |
<para> |
| 1949 |
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. |
|
| 1950 |
</para> |
</para> |
| 1951 |
|
</listitem> |
| 1952 |
|
<listitem> |
| 1953 |
<para> |
<para> |
| 1954 |
For the differences for Porters NMUs, please see <xref |
Upload fixing only release-critical and important bugs: 5 days |
|
linkend="source-nmu-when-porter"/> . |
|
| 1955 |
</para> |
</para> |
| 1956 |
|
</listitem> |
| 1957 |
|
<listitem> |
| 1958 |
<para> |
<para> |
| 1959 |
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). |
|
| 1960 |
</para> |
</para> |
| 1961 |
</section> |
</listitem> |
| 1962 |
|
</itemizedlist> |
| 1963 |
|
|
|
<section id="nmu-version"> |
|
|
<title>NMU version numbering</title> |
|
|
<para> |
|
|
Whenever you have made a change to a package, no matter how trivial, the |
|
|
version number needs to change. This enables our packing system to function. |
|
|
</para> |
|
| 1964 |
<para> |
<para> |
| 1965 |
If you are doing a non-maintainer upload (NMU), you should add a new minor |
Those delays are only examples. In some cases, such as uploads fixing security |
| 1966 |
version number to the <replaceable>debian-revision</replaceable> part of the |
issues, or fixes for trivial bugs that blocking a transition, it is desirable |
| 1967 |
version number (the portion after the last hyphen). This extra minor number |
that the fixed package reaches <literal>unstable</literal> sooner. |
|
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>. |
|
| 1968 |
</para> |
</para> |
| 1969 |
|
|
| 1970 |
<para> |
<para> |
| 1971 |
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 |
| 1972 |
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 |
| 1973 |
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 |
| 1974 |
by the official maintainer. |
Threshold NMU list</ulink>, and accept that NMUs are uploaded without delay. But |
| 1975 |
|
even in those cases, it's still a good idea to give the maintainer a few days |
| 1976 |
|
to react before you upload, especially if the patch wasn't available in the BTS |
| 1977 |
|
before, or if you know that the maintainer is generally active. |
| 1978 |
</para> |
</para> |
| 1979 |
|
|
| 1980 |
<para> |
<para> |
| 1981 |
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 |
| 1982 |
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 |
| 1983 |
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'. |
|
| 1984 |
</para> |
</para> |
| 1985 |
|
|
| 1986 |
<para> |
<para> |
| 1987 |
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 |
| 1988 |
</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 |
| 1989 |
version numbers like 1.1-3sarge0.1 could be used. |
timely manner, or if you ignore the recommendations of this document, your |
| 1990 |
|
upload might be a cause of conflict with the maintainer. |
| 1991 |
|
You should always be prepared to |
| 1992 |
|
defend the wisdom of any NMU you perform on its own merits. |
| 1993 |
</para> |
</para> |
| 1994 |
</section> |
</section> |
| 1995 |
|
|
| 1996 |
<section id="nmu-changelog"> |
<section id="nmu-changelog"> |
| 1997 |
<title>Source NMUs must have a new changelog entry</title> |
<title>NMUs and <filename>debian/changelog</filename></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> |
|
| 1998 |
<para> |
<para> |
| 1999 |
By convention, source NMU changelog entries start with the line |
Just like any other (source) upload, NMUs must add an entry to |
| 2000 |
|
<filename>debian/changelog</filename>, telling what has changed with this |
| 2001 |
|
upload. The first line of this entry must explicitely mention that this upload is an NMU, e.g.: |
| 2002 |
</para> |
</para> |
| 2003 |
<screen> |
<screen> |
| 2004 |
* Non-maintainer upload |
* Non-maintainer upload. |
| 2005 |
</screen> |
</screen> |
|
</section> |
|
| 2006 |
|
|
|
<section id="nmu-patch"> |
|
|
<title>Source NMUs and the Bug Tracking System</title> |
|
| 2007 |
<para> |
<para> |
| 2008 |
Maintainers other than the official package maintainer should make as few |
The way to version NMUs differs for native and non-native packages. |
| 2009 |
changes to the package as possible, and they should always send a patch as a |
</para> |
| 2010 |
unified context diff (<literal>diff -u</literal>) detailing their changes to |
<para> |
| 2011 |
the Bug Tracking System. |
If the package is a native package (without a Debian revision in the version number), |
| 2012 |
|
the version must be the version of the last maintainer upload, plus |
| 2013 |
|
<literal>+nmu<replaceable>X</replaceable></literal>, where |
| 2014 |
|
<replaceable>X</replaceable> is a counter starting at <literal>1</literal>. |
| 2015 |
|
If |
| 2016 |
|
the last upload was also an NMU, the counter should be increased. For example, |
| 2017 |
|
if the current version is <literal>1.5</literal>, then an NMU would get |
| 2018 |
|
version <literal>1.5+nmu1</literal>. |
| 2019 |
|
</para> |
| 2020 |
|
<para> |
| 2021 |
|
If the package is a not a native package, you should add a minor version number |
| 2022 |
|
to the Debian revision part of the version number (the portion after the last |
| 2023 |
|
hyphen). This extra number must start at <literal>1</literal>. For example, |
| 2024 |
|
if the current version is <literal>1.5-2</literal>, then an NMU would get |
| 2025 |
|
version <literal>1.5-2.1</literal>. If a new upstream version |
| 2026 |
|
is packaged in the NMU, the Debian revision is set to <literal>0</literal>, for |
| 2027 |
|
example <literal>1.6-0.1</literal>. |
| 2028 |
|
</para> |
| 2029 |
|
<para> |
| 2030 |
|
In both cases, if the last upload was also an NMU, the counter should |
| 2031 |
|
be increased. For example, if the current version is |
| 2032 |
|
<literal>1.5+nmu3</literal> (a native package which has already been |
| 2033 |
|
NMUed), the NMU would get version <literal>1.5+nmu4</literal>. |
| 2034 |
|
</para> |
| 2035 |
|
<para> |
| 2036 |
|
A special versioning scheme is needed to avoid disrupting the maintainer's |
| 2037 |
|
work, since using an integer for the Debian revision will potentially |
| 2038 |
|
conflict with a maintainer upload already in preparation at the time of an |
| 2039 |
|
NMU, or even one sitting in the ftp NEW queue. |
| 2040 |
|
It also has the |
| 2041 |
|
benefit of making it visually clear that a package in the archive was not made |
| 2042 |
|
by the official maintainer. |
| 2043 |
</para> |
</para> |
| 2044 |
|
|
| 2045 |
<para> |
<para> |
| 2046 |
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 |
| 2047 |
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 |
| 2048 |
<xref linkend="binary-only-nmu"/> which doesn't require any patch to be sent. |
this, a version of the form |
| 2049 |
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> |
| 2050 |
source NMU as usual and you will have to send a patch. |
should be used, where <replaceable>X</replaceable> and |
| 2051 |
|
<replaceable>Y</replaceable> are the major and minor release numbers, and |
| 2052 |
|
<replaceable>Z</replaceable> is a counter starting at <literal>1</literal>. |
| 2053 |
|
When the release number is not yet known (often the case for |
| 2054 |
|
<literal>testing</literal>, at the beginning of release cycles), the lowest |
| 2055 |
|
release number higher than the last stable release number must be used. For |
| 2056 |
|
example, while Lenny (Debian 5.0) is stable, a security NMU to stable for a |
| 2057 |
|
package at version <literal>1.5-3</literal> would have version |
| 2058 |
|
<literal>1.5-3+deb50u1</literal>, whereas a security NMU to Squeeze would get |
| 2059 |
|
version <literal>1.5-3+deb60u1</literal>. After the release of Squeeze, security |
| 2060 |
|
uploads to the <literal>testing</literal> distribution will be versioned |
| 2061 |
|
<literal>+deb61uZ</literal>, until it is known whether that release will be |
| 2062 |
|
Debian 6.1 or Debian 7.0 (if that becomes the case, uploads will be versioned |
| 2063 |
|
as <literal>+deb70uZ</literal>). |
| 2064 |
</para> |
</para> |
| 2065 |
|
</section> |
| 2066 |
|
|
| 2067 |
|
<section id="nmu-delayed"> |
| 2068 |
|
<title>Using the <literal>DELAYED/</literal> queue</title> |
| 2069 |
|
|
| 2070 |
<para> |
<para> |
| 2071 |
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 |
| 2072 |
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 |
| 2073 |
version. |
issue. |
| 2074 |
|
The <literal>DELAYED</literal> queue (see <xref linkend="delayed-incoming"/>) |
| 2075 |
|
allows the developer doing the NMU to perform all the necessary tasks at the |
| 2076 |
|
same time. For instance, instead of telling the maintainer that you will |
| 2077 |
|
upload the updated |
| 2078 |
|
package in 7 days, you should upload the package to |
| 2079 |
|
<literal>DELAYED/7</literal> and tell the maintainer that he has 7 days to |
| 2080 |
|
react. During this time, the maintainer can ask you to delay the upload some |
| 2081 |
|
more, or cancel your upload. |
| 2082 |
</para> |
</para> |
| 2083 |
|
|
| 2084 |
<para> |
<para> |
| 2085 |
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 |
| 2086 |
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 |
| 2087 |
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 |
| 2088 |
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. |
|
| 2089 |
</para> |
</para> |
| 2090 |
|
|
| 2091 |
<para> |
<para> |
| 2092 |
In addition, the normal maintainer should <emphasis>always</emphasis> retain |
If you make an NMU to <literal>DELAYED</literal> and the maintainer updates |
| 2093 |
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 |
| 2094 |
course, also keep the changes. If you revert some of the changes, please |
newer version is already available in the archive. |
| 2095 |
reopen the relevant bug reports. |
Ideally, the maintainer will take care to include your proposed changes (or |
| 2096 |
|
at least a solution for the problems they address) in that upload. |
| 2097 |
</para> |
</para> |
| 2098 |
|
|
| 2099 |
</section> |
</section> |
| 2100 |
|
|
| 2101 |
<section id="nmu-build"> |
<section id="nmu-maintainer"> |
| 2102 |
<title>Building source NMUs</title> |
<title>NMUs from the maintainer's point of view</title> |
| 2103 |
|
|
| 2104 |
<para> |
<para> |
| 2105 |
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 |
| 2106 |
rules as found in <xref linkend="distribution"/> , follow the other |
good shape. This gives users fixed packages faster. You |
| 2107 |
instructions in <xref linkend="upload"/> . |
can consider asking the NMUer to become a co-maintainer of the package. |
| 2108 |
|
Receiving an NMU on a package is not a bad |
| 2109 |
|
thing; it just means that the package is interesting enough for other people to |
| 2110 |
|
work on it. |
| 2111 |
</para> |
</para> |
| 2112 |
|
|
| 2113 |
<para> |
<para> |
| 2114 |
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 |
| 2115 |
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 |
| 2116 |
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 |
| 2117 |
signing the changes file. |
BTS but will be listed as affecting your maintainer version of the package. |
| 2118 |
</para> |
</para> |
| 2119 |
|
|
| 2120 |
</section> |
</section> |
| 2121 |
|
|
| 2122 |
<section id="ack-nmu"> |
<section id="nmu-binnmu"> |
| 2123 |
<title>Acknowledging an NMU</title> |
<title>Source NMUs vs Binary-only NMUs (binNMUs)</title> |
| 2124 |
|
|
| 2125 |
|
<para> |
| 2126 |
|
The full name of an NMU is <emphasis>source NMU</emphasis>. There is also |
| 2127 |
|
another type, namely the <emphasis>binary-only NMU</emphasis>, or |
| 2128 |
|
<emphasis>binNMU</emphasis>. A binNMU is also a package upload by someone |
| 2129 |
|
other than the package's maintainer. However, it is a binary-only upload. |
| 2130 |
|
</para> |
| 2131 |
|
|
| 2132 |
<para> |
<para> |
| 2133 |
If one of your packages has been NMU'ed, you have to incorporate the changes in |
When a library (or other dependency) is updated, the packages using it may need |
| 2134 |
your copy of the sources. This is easy, you just have to apply the patch that |
to be rebuilt. Since no changes to the source are needed, the same source |
| 2135 |
has been sent to you. Once this is done, you have to close the bugs that have |
package is used. |
|
been tagged fixed by the NMU. The easiest way is to use the |
|
|
<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. |
|
| 2136 |
</para> |
</para> |
| 2137 |
|
|
| 2138 |
<para> |
<para> |
| 2139 |
In any case, you should not be upset by the NMU. An NMU is not a personal |
BinNMUs are usually triggered on the buildds by wanna-build. |
| 2140 |
attack against the maintainer. It is a proof that someone cares enough about |
An entry is added to <filename>debian/changelog</filename>, |
| 2141 |
the package that they were willing to help you in your work, so you should be |
explaining why the upload was needed and increasing the version number as |
| 2142 |
thankful. You may also want to ask them if they would be interested in helping |
described in <xref linkend="binary-only-nmu"/>. |
| 2143 |
you on a more frequent basis as co-maintainer or backup maintainer (see <xref |
This entry should not be included in the next upload. |
|
linkend="collaborative-maint"/> ). |
|
| 2144 |
</para> |
</para> |
|
</section> |
|
| 2145 |
|
|
|
<section id="nmu-vs-qa"> |
|
|
<title>NMU vs QA uploads</title> |
|
| 2146 |
<para> |
<para> |
| 2147 |
Unless you know the maintainer is still active, it is wise to check the package |
Buildds upload packages for their architecture to the archive as binary-only |
| 2148 |
to see if it has been orphaned. The current list of orphaned packages which |
uploads. Strictly speaking, these are binNMUs. However, they are not normally |
| 2149 |
haven't had their maintainer set correctly is available at <ulink |
called NMU, and they don't add an entry to <filename>debian/changelog</filename>. |
|
url="&url-debian-qa-orphaned;"></ulink>. If you perform an NMU on an |
|
|
improperly orphaned package, please set the maintainer to <literal>Debian QA Group |
|
|
<packages@qa.debian.org></literal>. |
|
| 2150 |
</para> |
</para> |
| 2151 |
|
|
| 2152 |
</section> |
</section> |
| 2153 |
|
|
| 2154 |
<section id="nmu-who"> |
<section id="nmu-qa-upload"> |
| 2155 |
<title>Who can do an NMU</title> |
<title>NMUs vs QA uploads</title> |
| 2156 |
|
|
| 2157 |
<para> |
<para> |
| 2158 |
Only official, registered Debian Developers can do binary or source NMUs. A |
NMUs are uploads of packages by somebody else than their assigned maintainer. |
| 2159 |
Debian Developer is someone who has their key in the Debian key ring. |
There is |
| 2160 |
Non-developers, however, are encouraged to download the source package and |
another type of upload where the uploaded package is not yours: QA uploads. QA |
| 2161 |
start hacking on it to fix problems; however, rather than doing an NMU, they |
uploads are uploads of orphaned packages. |
|
should just submit worthwhile patches to the Bug Tracking System. Maintainers |
|
|
almost always appreciate quality patches and bug reports. |
|
| 2162 |
</para> |
</para> |
|
</section> |
|
| 2163 |
|
|
|
<section id="nmu-terms"> |
|
|
<title>Terminology</title> |
|
| 2164 |
<para> |
<para> |
| 2165 |
There are two new terms used throughout this section: ``binary-only NMU'' and |
QA uploads are very much like normal maintainer uploads: they may fix anything, |
| 2166 |
``source NMU''. These terms are used with specific technical meaning |
even minor issues; the version numbering is normal, and there is no need to use |
| 2167 |
throughout this document. Both binary-only and source NMUs are similar, since |
a delayed upload. The difference is that you are not listed as the <literal>Maintainer</literal> |
| 2168 |
they involve an upload of a package by a developer who is not the official |
or <literal>Uploader</literal> for the package. Also, the changelog entry of a QA upload has a |
| 2169 |
maintainer of that package. That is why it's a |
special first line: |
|
<literal>non-maintainer</literal> upload. |
|
| 2170 |
</para> |
</para> |
| 2171 |
|
|
| 2172 |
|
<screen> |
| 2173 |
|
* QA upload. |
| 2174 |
|
</screen> |
| 2175 |
|
|
| 2176 |
<para> |
<para> |
| 2177 |
A source NMU is an upload of a package by a developer who is not the official |
If you want to do an NMU, and it seems that the maintainer is not active, it is |
| 2178 |
maintainer, for the purposes of fixing a bug in the package. Source NMUs |
wise to check if the package is orphaned |
| 2179 |
always involves changes to the source (even if it is just a change to |
(this information is displayed on the package's Package Tracking System page). |
| 2180 |
<filename>debian/changelog</filename>). This can be either a change to the |
When doing the first QA upload to an |
| 2181 |
upstream source, or a change to the Debian bits of the source. Note, however, |
orphaned package, the maintainer should be set to <literal>Debian QA Group |
| 2182 |
that source NMUs may also include architecture-dependent packages, as well as |
<packages@qa.debian.org></literal>. Orphaned packages which did |
| 2183 |
an updated Debian diff. |
not yet have a QA upload still have their old maintainer set. There is a list |
| 2184 |
|
of them at <ulink url="&url-orphaned-not-qa;"/>. |
| 2185 |
</para> |
</para> |
| 2186 |
|
|
| 2187 |
<para> |
<para> |
| 2188 |
A binary-only NMU is a recompilation and upload of a binary package for a given |
Instead of doing a QA upload, you can also consider adopting the package by |
| 2189 |
architecture. As such, it is usually part of a porting effort. A binary-only |
making yourself the maintainer. You don't need permission from anybody to |
| 2190 |
NMU is a non-maintainer uploaded binary version of a package, with no source |
adopt an orphaned package, you can just set yourself as maintainer and upload |
| 2191 |
changes required. There are many cases where porters must fix problems in the |
the new version (see <xref linkend="adopting"/>). |
|
source in order to get them to compile for their target architecture; that |
|
|
would be considered a source NMU rather than a binary-only NMU. As you can |
|
|
see, we don't distinguish in terminology between porter NMUs and non-porter |
|
|
NMUs. |
|
| 2192 |
</para> |
</para> |
| 2193 |
|
|
| 2194 |
|
</section> |
| 2195 |
|
|
| 2196 |
|
<section id="nmu-team-upload"> |
| 2197 |
|
<title>NMUs vs team uploads</title> |
| 2198 |
|
|
| 2199 |
<para> |
<para> |
| 2200 |
Both classes of NMUs, source and binary-only, can be lumped under the term |
Sometimes you are fixing and/or updating a package because you are member of a |
| 2201 |
``NMU''. However, this often leads to confusion, since most people think |
packaging team (which uses a mailing list as <literal>Maintainer</literal> or <literal>Uploader</literal>, see <xref |
| 2202 |
``source NMU'' when they think ``NMU''. So it's best to be careful: always use |
linkend="collaborative-maint"/>) but you don't want to add yourself to <literal>Uploaders</literal> |
| 2203 |
``binary NMU'' or ``binNMU'' for binary-only NMUs. |
because you do not plan to contribute regularly to this specific package. If it |
| 2204 |
|
conforms with your team's policy, you can perform a normal upload without |
| 2205 |
|
being listed directly as <literal>Maintainer</literal> or <literal>Uploader</literal>. In that case, you should |
| 2206 |
|
start your changelog entry with the following line: |
| 2207 |
</para> |
</para> |
| 2208 |
|
|
| 2209 |
|
<screen> |
| 2210 |
|
* Team upload. |
| 2211 |
|
</screen> |
| 2212 |
|
|
| 2213 |
</section> |
</section> |
| 2214 |
|
|
| 2215 |
</section> |
</section> |
| 2221 |
maintenance duties by several people. This collaboration is almost always a |
maintenance duties by several people. This collaboration is almost always a |
| 2222 |
good idea, since it generally results in higher quality and faster bug fix |
good idea, since it generally results in higher quality and faster bug fix |
| 2223 |
turnaround times. It is strongly recommended that packages with a priority of |
turnaround times. It is strongly recommended that packages with a priority of |
| 2224 |
<literal>Standard</literal> or which are part of the base set have |
<literal>standard</literal> or which are part of the base set have |
| 2225 |
co-maintainers. |
co-maintainers. |
| 2226 |
</para> |
</para> |
| 2227 |
<para> |
<para> |
| 2241 |
<para> |
<para> |
| 2242 |
Setup the co-maintainer with access to the sources you build the package from. |
Setup the co-maintainer with access to the sources you build the package from. |
| 2243 |
Generally this implies you are using a network-capable version control system, |
Generally this implies you are using a network-capable version control system, |
| 2244 |
such as <command>CVS</command> or <command>Subversion</command>. Alioth (see |
such as <literal>CVS</literal> or <literal>Subversion</literal>. Alioth (see |
| 2245 |
<xref linkend="alioth"/> ) provides such tools, amongst others. |
<xref linkend="alioth"/>) provides such tools, amongst others. |
| 2246 |
</para> |
</para> |
| 2247 |
</listitem> |
</listitem> |
| 2248 |
<listitem> |
<listitem> |
| 2257 |
</listitem> |
</listitem> |
| 2258 |
<listitem> |
<listitem> |
| 2259 |
<para> |
<para> |
| 2260 |
Using the PTS (<xref linkend="pkg-tracking-system"/> ), the co-maintainers |
Using the PTS (<xref linkend="pkg-tracking-system"/>), the co-maintainers |
| 2261 |
should subscribe themselves to the appropriate source package. |
should subscribe themselves to the appropriate source package. |
| 2262 |
</para> |
</para> |
| 2263 |
</listitem> |
</listitem> |
| 2265 |
<para> |
<para> |
| 2266 |
Another form of collaborative maintenance is team maintenance, which is |
Another form of collaborative maintenance is team maintenance, which is |
| 2267 |
recommended if you maintain several packages with the same group of developers. |
recommended if you maintain several packages with the same group of developers. |
| 2268 |
In that case, the Maintainer and Uploaders field of each package must be |
In that case, the <literal>Maintainer</literal> and <literal>Uploaders</literal> field of each package must be |
| 2269 |
managed with care. It is recommended to choose between one of the two |
managed with care. It is recommended to choose between one of the two |
| 2270 |
following schemes: |
following schemes: |
| 2271 |
</para> |
</para> |
| 2272 |
<orderedlist numeration="arabic"> |
<orderedlist numeration="arabic"> |
| 2273 |
<listitem> |
<listitem> |
| 2274 |
<para> |
<para> |
| 2275 |
Put the team member mainly responsible for the package in the Maintainer field. |
Put the team member mainly responsible for the package in the <literal>Maintainer</literal> field. |
| 2276 |
In the Uploaders, put the mailing list address, and the team members who care |
In the <literal>Uploaders</literal>, put the mailing list address, and the team members who care |
| 2277 |
for the package. |
for the package. |
| 2278 |
</para> |
</para> |
| 2279 |
</listitem> |
</listitem> |
| 2280 |
<listitem> |
<listitem> |
| 2281 |
<para> |
<para> |
| 2282 |
Put the mailing list address in the Maintainer field. In the Uploaders field, |
Put the mailing list address in the <literal>Maintainer</literal> field. In the <literal>Uploaders</literal> field, |
| 2283 |
put the team members who care for the package. In this case, you must make |
put the team members who care for the package. In this case, you must make |
| 2284 |
sure the mailing list accept bug reports without any human interaction (like |
sure the mailing list accept bug reports without any human interaction (like |
| 2285 |
moderation for non-subscribers). |
moderation for non-subscribers). |
| 2286 |
</para> |
</para> |
| 2287 |
</listitem> |
</listitem> |
| 2288 |
</orderedlist> |
</orderedlist> |
| 2289 |
|
|
| 2290 |
<para> |
<para> |
| 2291 |
In any case, it is a bad idea to automatically put all team members in the |
In any case, it is a bad idea to automatically put all team members in the |
| 2292 |
Uploaders field. It clutters the Developer's Package Overview listing (see |
<literal>Uploaders</literal> field. It clutters the Developer's Package Overview listing (see |
| 2293 |
<xref linkend="ddpo"/> ) with packages one doesn't really care for, and creates |
<xref linkend="ddpo"/>) with packages one doesn't really care for, and creates |
| 2294 |
a false sense of good maintenance. |
a false sense of good maintenance. For the same reason, team members do |
| 2295 |
|
not need to add themselves to the <literal>Uploaders</literal> field just because they are |
| 2296 |
|
uploading the package once, they can do a “Team upload” (see <xref |
| 2297 |
|
linkend="nmu-team-upload"/>). Conversely, it is a bad idea to keep a |
| 2298 |
|
package with only the mailing list address as a <literal>Maintainer</literal> and no |
| 2299 |
|
<literal>Uploaders</literal>. |
| 2300 |
</para> |
</para> |
| 2301 |
</section> |
</section> |
| 2302 |
|
|
| 2312 |
<para> |
<para> |
| 2313 |
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 |
| 2314 |
make them uninstallable; they also have to have generally no known |
make them uninstallable; they also have to have generally no known |
| 2315 |
release-critical bugs at the time they're installed into <literal>testing |
release-critical bugs at the time they're installed into <literal>testing</literal>. |
| 2316 |
<literal>. This way, <literal>testing</literal> should always be close to |
This way, <literal>testing</literal> should always be close to |
| 2317 |
being a release candidate. Please see below for details. |
being a release candidate. Please see below for details. |
| 2318 |
</para> |
</para> |
| 2319 |
</section> |
</section> |
| 2339 |
or 10 days, depending on the urgency (high, medium or low). Please note that |
or 10 days, depending on the urgency (high, medium or low). Please note that |
| 2340 |
the urgency is sticky, meaning that the highest urgency uploaded since the |
the urgency is sticky, meaning that the highest urgency uploaded since the |
| 2341 |
previous <literal>testing</literal> transition is taken into account. Those |
previous <literal>testing</literal> transition is taken into account. Those |
| 2342 |
delays may be doubled during a freeze, or <literal>testing</literal> |
delays may be doubled during a freeze, or <literal>testing</literal> |
| 2343 |
transitions may be switched off altogether; |
transitions may be switched off altogether; |
| 2344 |
</para> |
</para> |
| 2345 |
</listitem> |
</listitem> |
| 2346 |
<listitem> |
<listitem> |
| 2347 |
<para> |
<para> |
| 2348 |
It must not have new release-critical bugs (RC bugs affecting the version |
It must not have new release-critical bugs (RC bugs affecting the version |
| 2349 |
available in <literal>unstable</literal>, but not affecting the version in |
available in <literal>unstable</literal>, but not affecting the version in |
| 2350 |
<literal>testing</literal>); |
<literal>testing</literal>); |
| 2351 |
</para> |
</para> |
| 2352 |
</listitem> |
</listitem> |
| 2353 |
<listitem> |
<listitem> |
| 2354 |
<para> |
<para> |
| 2355 |
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 |
| 2356 |
in <literal>unstable</literal>. <xref linkend="madison"/> may be of interest |
in <literal>unstable</literal>. <link linkend="dak-ls">dak ls</link> may be of interest |
| 2357 |
to check that information; |
to check that information; |
| 2358 |
</para> |
</para> |
| 2359 |
</listitem> |
</listitem> |
| 2368 |
The packages on which it depends must either be available in |
The packages on which it depends must either be available in |
| 2369 |
<literal>testing</literal> or they must be accepted into |
<literal>testing</literal> or they must be accepted into |
| 2370 |
<literal>testing</literal> at the same time (and they will be if they fulfill |
<literal>testing</literal> at the same time (and they will be if they fulfill |
| 2371 |
all the necessary criteria); |
all the necessary criteria). |
| 2372 |
</para> |
</para> |
| 2373 |
</listitem> |
</listitem> |
| 2374 |
</itemizedlist> |
</itemizedlist> |
| 2401 |
shows build dependencies which are not considered by britney. |
shows build dependencies which are not considered by britney. |
| 2402 |
</para> |
</para> |
| 2403 |
<section id="outdated"> |
<section id="outdated"> |
| 2404 |
<title>out-of-date</title> |
<title>Out-of-date</title> |
| 2405 |
<para> |
<para> |
| 2406 |
<!-- FIXME: better rename this file than document rampant professionalism? --> |
<!-- FIXME: better rename this file than document rampant professionalism? --> |
| 2407 |
For the <literal>testing</literal> migration script, outdated means: There are |
For the <literal>testing</literal> migration script, outdated means: There are |
| 2408 |
different versions in <literal>unstable</literal> for the release architectures |
different versions in <literal>unstable</literal> for the release architectures |
| 2409 |
(except for the architectures in fuckedarches; fuckedarches is a list of |
(except for the architectures in fuckedarches; fuckedarches is a list of |
| 2410 |
architectures that don't keep up (in <filename>update_out.py</filename>), but |
architectures that don't keep up (in <filename>update_out.py</filename>), but |
| 2411 |
currently, it's empty). outdated has nothing whatsoever to do with the |
currently, it's empty). outdated has nothing whatsoever to do with the |
| 2412 |
architectures this package has in <literal>testing</literal>. |
architectures this package has in <literal>testing</literal>. |
| 2413 |
</para> |
</para> |
| 2414 |
<para> |
<para> |
| 2438 |
</tgroup> |
</tgroup> |
| 2439 |
</informaltable> |
</informaltable> |
| 2440 |
<para> |
<para> |
| 2441 |
The package is out of date on alpha in <literal>unstable</literal>, and will |
The package is out of date on <literal>alpha</literal> in <literal>unstable</literal>, and will |
| 2442 |
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 |
| 2443 |
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 |
| 2444 |
propagate to testing. |
propagate to <literal>testing</literal>. |
| 2445 |
</para> |
</para> |
| 2446 |
<para> |
<para> |
| 2447 |
However, if ftp-master removes a package in <literal>unstable</literal> (here |
However, if ftp-master removes a package in <literal>unstable</literal> (here |
| 2475 |
</informaltable> |
</informaltable> |
| 2476 |
<para> |
<para> |
| 2477 |
In this case, the package is up to date on all release architectures in |
In this case, the package is up to date on all release architectures in |
| 2478 |
<literal>unstable</literal> (and the extra <literal>hurd-i386</literal> |
<literal>unstable</literal> (and the extra <literal>hurd-i386</literal> |
| 2479 |
doesn't matter, as it's not a release architecture). |
doesn't matter, as it's not a release architecture). |
| 2480 |
</para> |
</para> |
| 2481 |
<para> |
<para> |
| 2495 |
be removed to allow <literal>b</literal> in. |
be removed to allow <literal>b</literal> in. |
| 2496 |
</para> |
</para> |
| 2497 |
<para> |
<para> |
| 2498 |
Of course, there is another reason to remove a package from <literal>testing |
Of course, there is another reason to remove a package from <literal>testing</literal>: |
| 2499 |
</literal>: It's just too buggy (and having a single RC-bug is enough to be |
It's just too buggy (and having a single RC-bug is enough to be |
| 2500 |
in this state). |
in this state). |
| 2501 |
</para> |
</para> |
| 2502 |
<para> |
<para> |
| 2507 |
</section> |
</section> |
| 2508 |
|
|
| 2509 |
<section id="circular"> |
<section id="circular"> |
| 2510 |
<title>circular dependencies</title> |
<title>Circular dependencies</title> |
| 2511 |
<para> |
<para> |
| 2512 |
A situation which is not handled very well by britney is if package |
A situation which is not handled very well by britney is if package |
| 2513 |
<literal>a</literal> depends on the new version of package |
<literal>a</literal> depends on the new version of package |
| 2551 |
</section> |
</section> |
| 2552 |
|
|
| 2553 |
<section id="s5.13.2.4"> |
<section id="s5.13.2.4"> |
| 2554 |
<title>influence of package in testing</title> |
<title>Influence of package in testing</title> |
| 2555 |
<para> |
<para> |
| 2556 |
Generally, there is nothing that the status of a package in <literal>testing |
Generally, there is nothing that the status of a package in <literal>testing</literal> |
| 2557 |
</literal> means for transition of the next version from <literal>unstable |
means for transition of the next version from <literal>unstable</literal> |
| 2558 |
</literal> to <literal>testing</literal>, with two exceptions: |
to <literal>testing</literal>, with two exceptions: |
| 2559 |
If the RC-bugginess of the package goes down, it may go in even if it is still |
If the RC-bugginess of the package goes down, it may go in even if it is still |
| 2560 |
RC-buggy. The second exception is if the version of the package in <literal> |
RC-buggy. The second exception is if the version of the package in |
| 2561 |
testing</literal> is out of sync on the different arches: Then any arch might |
<literal>testing</literal> is out of sync on the different arches: Then any arch might |
| 2562 |
just upgrade to the version of the source package; however, this can happen |
just upgrade to the version of the source package; however, this can happen |
| 2563 |
only if the package was previously forced through, the arch is in fuckedarches, |
only if the package was previously forced through, the arch is in fuckedarches, |
| 2564 |
or there was no binary package of that arch present in <literal>unstable |
or there was no binary package of that arch present in <literal>unstable</literal> |
| 2565 |
</literal> at all during the <literal>testing</literal> migration. |
at all during the <literal>testing</literal> migration. |
| 2566 |
</para> |
</para> |
| 2567 |
<para> |
<para> |
| 2568 |
In summary this means: The only influence that a package being in <literal> |
In summary this means: The only influence that a package being in |
| 2569 |
testing</literal> has on a new version of the same package is that the new |
<literal>testing</literal> has on a new version of the same package is that the new |
| 2570 |
version might go in easier. |
version might go in easier. |
| 2571 |
</para> |
</para> |
| 2572 |
</section> |
</section> |
| 2573 |
|
|
| 2574 |
<section id="details"> |
<section id="details"> |
| 2575 |
<title>details</title> |
<title>Details</title> |
| 2576 |
<para> |
<para> |
| 2577 |
If you are interested in details, this is how britney works: |
If you are interested in details, this is how britney works: |
| 2578 |
</para> |
</para> |
| 2586 |
is not described here. If you're interested in that, please peruse the code.) |
is not described here. If you're interested in that, please peruse the code.) |
| 2587 |
</para> |
</para> |
| 2588 |
<para> |
<para> |
| 2589 |
Now, the more complex part happens: Britney tries to update <literal>testing |
Now, the more complex part happens: Britney tries to update <literal>testing</literal> |
| 2590 |
</literal> with the valid candidates. For that, britney tries to add each |
with the valid candidates. For that, britney tries to add each |
| 2591 |
valid candidate to the testing distribution. If the number of uninstallable |
valid candidate to the testing distribution. If the number of uninstallable |
| 2592 |
packages in <literal>testing</literal> doesn't increase, the package is |
packages in <literal>testing</literal> doesn't increase, the package is |
| 2593 |
accepted. From that point on, the accepted package is considered to be part |
accepted. From that point on, the accepted package is considered to be part |
| 2600 |
<filename>merkel:/org/&ftp-debian-org;/testing/update_out/</filename> (or |
<filename>merkel:/org/&ftp-debian-org;/testing/update_out/</filename> (or |
| 2601 |
in <filename>merkel:~aba/testing/update_out</filename> to see a setup with |
in <filename>merkel:~aba/testing/update_out</filename> to see a setup with |
| 2602 |
a smaller packages file). Via web, it's at <ulink |
a smaller packages file). Via web, it's at <ulink |
| 2603 |
url="http://&ftp-master-host;/testing/update_out_code/"></ulink> |
url="http://&ftp-master-host;/testing/update_out_code/"></ulink>. |
| 2604 |
</para> |
</para> |
| 2605 |
<para> |
<para> |
| 2606 |
The hints are available via <ulink |
The hints are available via <ulink |
| 2613 |
<section id="t-p-u"> |
<section id="t-p-u"> |
| 2614 |
<title>Direct updates to testing</title> |
<title>Direct updates to testing</title> |
| 2615 |
<para> |
<para> |
| 2616 |
The <literal>testing</literal> distribution is fed with packages from |
The <literal>testing</literal> distribution is fed with packages from |
| 2617 |
<literal>unstable</literal> according to the rules explained above. However, |
<literal>unstable</literal> according to the rules explained above. However, |
| 2618 |
in some cases, it is necessary to upload packages built only for <literal> |
in some cases, it is necessary to upload packages built only for |
| 2619 |
testing</literal>. For that, you may want to upload to <literal> |
<literal>testing</literal>. For that, you may want to upload to |
| 2620 |
testing-proposed-updates</literal>. |
<literal>testing-proposed-updates</literal>. |
| 2621 |
</para> |
</para> |
| 2622 |
<para> |
<para> |
| 2623 |
Keep in mind that packages uploaded there are not automatically processed, they |
Keep in mind that packages uploaded there are not automatically processed, they |
| 2629 |
<para> |
<para> |
| 2630 |
You should not upload to <literal>testing-proposed-updates</literal> when you |
You should not upload to <literal>testing-proposed-updates</literal> when you |
| 2631 |
can update your packages through <literal>unstable</literal>. If you can't |
can update your packages through <literal>unstable</literal>. If you can't |
| 2632 |
(for example because you have a newer development version in <literal>unstable |
(for example because you have a newer development version in <literal>unstable</literal>), |
| 2633 |
</literal>), you may use this facility, but it is recommended that you ask for |
you may use this facility, but it is recommended that you ask for |
| 2634 |
authorization from the release manager first. Even if a package is frozen, |
authorization from the release manager first. Even if a package is frozen, |
| 2635 |
updates through <literal>unstable</literal> are possible, if the upload via |
updates through <literal>unstable</literal> are possible, if the upload via |
| 2636 |
<literal>unstable</literal> does not pull in any new dependencies. |
<literal>unstable</literal> does not pull in any new dependencies. |
| 2637 |
</para> |
</para> |
| 2638 |
<para> |
<para> |
| 2639 |
Version numbers are usually selected by adding the codename of the |
Version numbers are usually selected by adding the codename of the |
| 2640 |
<literal>testing</literal> distribution and a running number, like |
<literal>testing</literal> distribution and a running number, like |
| 2641 |
<literal>1.2sarge1</literal> for the first upload through |
<literal>1.2squeeze1</literal> for the first upload through |
| 2642 |
<literal>testing-proposed-updates</literal> of package version |
<literal>testing-proposed-updates</literal> of package version |
| 2643 |
<literal>1.2</literal>. |
<literal>1.2</literal>. |
| 2644 |
</para> |
</para> |
| 2645 |
<para> |
<para> |
| 2649 |
<listitem> |
<listitem> |
| 2650 |
<para> |
<para> |
| 2651 |
Make sure that your package really needs to go through |
Make sure that your package really needs to go through |
| 2652 |
<literal>testing-proposed-updates</literal>, and can't go through <literal> |
<literal>testing-proposed-updates</literal>, and can't go through |
| 2653 |
unstable</literal>; |
<literal>unstable</literal>; |
| 2654 |
</para> |
</para> |
| 2655 |
</listitem> |
</listitem> |
| 2656 |
<listitem> |
<listitem> |
| 2703 |
<para> |
<para> |
| 2704 |
Such bugs are presumed to have an impact on the chances that the package will |
Such bugs are presumed to have an impact on the chances that the package will |
| 2705 |
be released with the <literal>stable</literal> release of Debian: in general, |
be released with the <literal>stable</literal> release of Debian: in general, |
| 2706 |
if a package has open release-critical bugs filed on it, it won't get into |
if a package has open release-critical bugs filed on it, it won't get into |
| 2707 |
<literal>testing</literal>, and consequently won't be released in <literal> |
<literal>testing</literal>, and consequently won't be released in |
| 2708 |
stable</literal>. |
<literal>stable</literal>. |
| 2709 |
</para> |
</para> |
| 2710 |
<para> |
<para> |
| 2711 |
The <literal>unstable</literal> bug count are all release-critical bugs which |
The <literal>unstable</literal> bug count are all release-critical bugs which |
| 2712 |
are marked to apply to <replaceable>package</replaceable>/<replaceable>version |
are marked to apply to <replaceable>package</replaceable>/<replaceable>version</replaceable> |
| 2713 |
</replaceable> combinations that are available in unstable for a release |
combinations that are available in unstable for a release |
| 2714 |
architecture. The <literal>testing</literal> bug count is defined analogously. |
architecture. The <literal>testing</literal> bug count is defined analogously. |
| 2715 |
</para> |
</para> |
| 2716 |
</section> |
</section> |
| 2722 |
The structure of the distribution archives is such that they can only contain |
The structure of the distribution archives is such that they can only contain |
| 2723 |
one version of a package; a package is defined by its name. So when the source |
one version of a package; a package is defined by its name. So when the source |
| 2724 |
package <literal>acmefoo</literal> is installed into <literal>testing</literal>, |
package <literal>acmefoo</literal> is installed into <literal>testing</literal>, |
| 2725 |
along with its binary packages <literal>acme-foo-bin</literal>, <literal> |
along with its binary packages <literal>acme-foo-bin</literal>, |
| 2726 |
acme-bar-bin</literal>, <literal>libacme-foo1</literal> and <literal> |
<literal>acme-bar-bin</literal>, <literal>libacme-foo1</literal> and |
| 2727 |
libacme-foo-dev</literal>, the old version is removed. |
<literal>libacme-foo-dev</literal>, the old version is removed. |
| 2728 |
</para> |
</para> |
| 2729 |
<para> |
<para> |
| 2730 |
However, the old version may have provided a binary package with an old soname |
However, the old version may have provided a binary package with an old soname |
| 2731 |
of a library, such as <literal>libacme-foo0</literal>. Removing the old |
of a library, such as <literal>libacme-foo0</literal>. Removing the old |
| 2732 |
<literal>acmefoo</literal> will remove <literal>libacme-foo0</literal>, which |
<literal>acmefoo</literal> will remove <literal>libacme-foo0</literal>, which |
| 2733 |
will break any packages which depend on it. |
will break any packages which depend on it. |
| 2734 |
</para> |
</para> |