X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=26f9f3450540646aa1a48e6a11520b80a9a72d55;hb=d435c3ecc576c1551bba2714b96c839ac30397e1;hp=79a60492c16be7e96d672822c15bbfe7108037ea;hpb=8e61d80da8ddea01cc9381b35c986c11aba067b4;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index 79a6049..26f9f34 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -6,7 +6,7 @@ %commondata; - + +It is technically possible to upload a package into several distributions +at the same time but it usually doesn't make sense to use that feature +because the dependencies of the package may vary with the distribution. +In particular, it never makes sense to combine the experimental +distribution with anything else. Uploading to stable

Uploading to stable means that the package will be placed into the -proposed-updates directory of the Debian archive for further +stable-proposed-updates directory of the Debian archive for further testing before it is actually included in stable.

Extra care should be taken when uploading to stable. Basically, a @@ -1560,13 +1535,29 @@ packages (by messing with Provides or shlibs files), possibly making those other packages uninstallable, is strongly discouraged.

The Release Team (which can be reached at &email-debian-release;) will -regularly evaluate the uploads in proposed-updates and decide if +regularly evaluate the uploads in stable-proposed-updates and decide if your package can be included in stable. Please be clear (and verbose, if necessary) in your changelog entries for uploads to stable, because otherwise the package won't be considered for inclusion. - + Uploading to testing-proposed-updates +

+The testing distribution is fed with packages from unstable according to the rules +explained in . However, the release manager may stop the testing +scripts when he wants to freeze the distribution. In that case, you may want to +upload to testing-proposed-udaptes to provide fixed packages during the freeze. +

+Keep in mind that packages uploaded there are not automatically processed, they +have to go through the hands of the release manager. So you'd better have a good +reason to upload there. In order to know what a good reason is in the +release manager's eyes, you should read the instructions that he regularly +gives on &email-debian-devel-announce;. +

+You should not upload to testing-proposed-updates when you can update your +packages through unstable. If you can't (for example because you have a +newer development version in unstable), you may use it but it is recommended to ask +the authorization of the release manager before. Uploading a package @@ -1854,13 +1845,8 @@ distribution, i.e., stable, unstable, or experimental. Porters have slightly different rules than non-porters, due to their unique circumstances (see ).

-When a security bug is detected, a fixed package should be uploaded -as soon as possible. In this case, the Debian security officers get in -contact with the package maintainer to make sure a fixed package is -uploaded within a reasonable time (less than 48 hours). If the package -maintainer cannot provide a fixed package fast enough or if he/she -cannot be reached in time, a security officer may upload a fixed -package (i.e., do a source NMU). +When a security bug is detected, the security team may do an NMU. +Please refer to for more information.

During the release cycle (see ), NMUs which fix serious or higher severity bugs are encouraged and accepted. Even @@ -1869,14 +1855,14 @@ maintainer of the package; they might be just about to upload a fix for the problem. As with any source NMU, the guidelines found in need to be followed.

-Bug fixes to unstable by non-maintainers are also acceptable, but only -as a last resort or with permission. The following protocol should -be respected to do an NMU: +Uploading bug fixes to unstable by non-maintainers should only be done +by following this protocol:

-Make sure that the package's bug is in the Debian Bug Tracking System -(BTS). If not, submit a bug. +Make sure that the package's bugs that the NMU is meant to address are all +filed in the Debian Bug Tracking System (BTS). +If they are not, submit them immediately. Wait a few days the response from the maintainer. If you don't get any response, you may want to help him by sending the patch that fixes @@ -1897,7 +1883,15 @@ to cancel the NMU. Follow what happens, you're responsible for any bug that you introduced with your NMU. You should probably use (PTS) to stay informed of the state of the package after your NMU. - + +

+At times, the release manager or an organized group of developers can +announce a certain period of time in which the NMU rules are relaxed. +This usually involves shortening the period during which one is to wait +before uploading the fixes, and shortening the DELAYED period. It is +important to notice that even in these so-called "bug squashing party" +times, the NMUer has to file bugs and contact the developer first, +and act later. How to do a source NMU

@@ -2408,6 +2402,17 @@ that package, and the package has moved into the archive, file a bug against ftp.debian.org asking to remove the package with the obsolete name. Do not forget to properly reassign the package's bugs at the same time. +

+At other times, you may make a mistake in constructing your package, and +wish to replace it. The only way to do this is to increase the version +number, and upload a new version. The old version will be expired in +the usual manner. Note that this applies to each part of your package, +including the sources: if you wish to replace the upstream source tarball +of your package, you will need to upload it with a different version. An +easy possibility is to replace foo_1.00.orig.tar.gz with +foo_1.00+0.orig.tar.gz. This restriction gives each file +on the ftp site a unique name, which helps to ensure consistency across the +mirror network. Orphaning a package

@@ -2543,9 +2548,8 @@ to let people know that the bug exists but that it won't be corrected. If this situation is unacceptable, you (or the submitter) may want to require a decision of the technical committee by reassigning the bug to tech-ctte (you may use the clone command of -the BTS if you wish to keep it reported against your package). - +the BTS if you wish to keep it reported against your package). Before +doing so, please read the . If the bug is real but it's caused by another package, just reassign the bug the right package. If you don't know which package it should @@ -2599,6 +2603,7 @@ maintainers with security problems or fix them themselves, sending security advisories, and maintaining security.debian.org. + What to do when you learn of a security problem @@ -2744,10 +2749,12 @@ When packaging the fix, keep the following points in mind: new version to unstable first. Do not make source-only uploads if your package has any - binary-all packages. The buildd infrastructure will not build - those. This point applies to normal package uploads as well. + binary-all packages (do not use the -S option to + dpkg-buildpackage). The buildd infrastructure will + not build those. This point applies to normal package uploads as + well. - Always upload with full source (use the -sa option + Always build with full source (use the -sa option for dpkg-buildpackage). Be sure to use the exact same .orig.tar.gz as used in the @@ -2759,28 +2766,34 @@ When packaging the fix, keep the following points in mind: are building for. If you do not have such a system yourself, you can use a debian.org machine (see ) or setup a chroot (see and - ). + ). Uploading the fixed package -

-Once you have created and tested the new package, it needs to be -uploaded so it can be installed in the archives. For security uploads, -the place to upload to is +

+DO NOT upload a package to the security upload queue without +prior authorization from the security team. If the package does not +exactly meet the team's requirements, it will cause many problems and +delays in dealing with the unwanted upload. +

+Once you have created and tested the new package, and it has been +approved by the security team, it needs to be uploaded so that it can +be installed in the archives. For security uploads, the place to +upload to is ftp://security.debian.org/pub/SecurityUploadQueue/ .

-Once an upload to the security queue has been accepted the package +Once an upload to the security queue has been accepted, the package will automatically be rebuilt for all architectures and stored for verification by the security team.

-Uploads waiting for acceptance or verification are only accessible by -the security team. This is necessary since there might be fixes for -security problems that can not be disclosed yet. +Uploads which are waiting for acceptance or verification are only +accessible by the security team. This is necessary since there might +be fixes for security problems that cannot be disclosed yet.

-If a member of the security team accepts a package it will be +If a member of the security team accepts a package, it will be installed on security.debian.org as well as the proper distribution-proposed-updates on ftp-master or in the non-US archive. @@ -2962,6 +2975,13 @@ full example. /etc/modutils/ for module configuration. --> + Packages using autoconf/automake +

+Some very good packaging practices for packages using autoconf and/or +automake have been synthetized in &file-bpp-autotools;. You're strongly +encouraged to read this file and to follow the given recommandations. + + Libraries

Libraries are always difficult to package for various reasons. The policy @@ -3054,7 +3074,8 @@ that description, you should be careful to avoid English mistakes. Ensure that you spell check it. ispell has a special option (-g) for that: ispell -d american -g debian/control. - +If you want someone to proofread the description that you +intend to use you may ask on &email-debian-l10n-english;.