X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=3b1206feb930bff99b49e0076307e098b909c228;hp=b93f6b3e9c023773291aa7bf110f437d10098da1;hb=af4a79e2cde3500ee7977db96bf127159508ddab;hpb=3b99d1b9e1df05d1f610146e6a2192cd1f38b5f3 diff --git a/developers-reference.sgml b/developers-reference.sgml index b93f6b3..3b1206f 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -6,7 +6,7 @@ %commondata; - + Packages

There are two types of Debian packages, namely source and binary packages.

-Source packages consist of either two or three files: a .dsc -file, and either a .tar.gz file or both an -.orig.tar.gz and a .diff.gz file. +Source packages consist of either two or three files: a .dsc +file, and either a .tar.gz file or both an +.orig.tar.gz and a .diff.gz file.

If a package is developed specially for Debian and is not distributed -outside of Debian, there is just one .tar.gz file which +outside of Debian, there is just one .tar.gz file which contains the sources of the program. If a package is distributed -elsewhere too, the .orig.tar.gz file stores the so-called +elsewhere too, the .orig.tar.gz file stores the so-called upstream source code, that is the source code that's distributed from the upstream maintainer (often the author of -the software). In this case, the .diff.gz contains the +the software). In this case, the .diff.gz contains the changes made by the Debian maintainer.

-The .dsc lists all the files in the source package together +The .dsc file lists all the files in the source package together with checksums (md5sums) and some additional info about the package (maintainer, version, etc.). @@ -728,47 +835,43 @@ the package (maintainer, version, etc.).

The directory system described in the previous chapter is itself contained within distribution directories. Each -distribution is actually contained in the pool directory in the +distribution is actually contained in the pool directory in the top-level of the Debian archive itself.

To summarize, the Debian archive has a root directory within an FTP server. For instance, at the mirror site, ftp.us.debian.org, the Debian archive itself is contained in /debian, which is a common location -(another is /pub/debian). +(another is /pub/debian).

A distribution is comprised of Debian source and binary packages, and the -respective Sources and Packages index files, containing +respective Sources and Packages index files, containing the header information from all those packages. The former are kept in the -pool/ directory, while the latter are kept in the dists/ -directory of the archive (because of backwards compatibility). +pool/ directory, while the latter are kept in the dists/ +directory of the archive (for backwards compatibility). Stable, testing, and unstable

There are always distributions called stable (residing in -dists/stable), one called testing (residing in -dists/testing), and one called unstable (residing in -dists/unstable). This reflects the development process of the +dists/stable), one called testing (residing in +dists/testing), and one called unstable (residing in +dists/unstable). This reflects the development process of the Debian project.

Active development is done in the unstable distribution (that's why this distribution is sometimes called the development distribution). Every Debian developer can update his or her packages in this distribution at any time. Thus, the contents of this -distribution change from day-to-day. Since no special effort is done +distribution changes from day-to-day. Since no special effort is done to make sure everything in this distribution is working properly, it is sometimes literally unstable.

-Packages get copied from unstable to testing if they -satisfy certain criteria. To get into testing distribution, a -package needs to be in the archive for two weeks and not have any -release critical bugs. After that period, it will propagate into -testing as soon as anything it depends on is also added. This -process is automatic. You can see some notes on this system as well -as update_excuses (describing which packages are valid -candidates, which are not, and why not) at . +The testing distribution is generated automatically by taking +packages from unstable if they satisfy certain criteria. Those +criteria should ensure a good quality for packages within testing. + are launched each day after the +new packages have been installed.

After a period of development, once the release manager deems fit, the testing distribution is frozen, meaning that the policies @@ -788,16 +891,17 @@ that time (although it can be found at &archive-host;). This development cycle is based on the assumption that the unstable distribution becomes stable after passing a period of being in testing. Even once a distribution is -considered stable, a few bugs inevitably remain &mdash that's why the +considered stable, a few bugs inevitably remain — that's why the stable distribution is updated every now and then. However, these updates are tested very carefully and have to be introduced into the archive individually to reduce the risk of introducing new bugs. You can find proposed additions to stable in the -proposed-updates directory. Those packages in -proposed-updates that pass muster are periodically moved as a +proposed-updates directory. Those packages in +proposed-updates that pass muster are periodically moved as a batch into the stable distribution and the revision level of the -stable distribution is incremented (e.g., ‘3.0’ becomes ‘3.0r1’, -‘2.2r4’ becomes ‘2.0r5’, and so forth). +stable distribution is incremented (e.g., ‘3.0’ becomes +‘3.0r1’, ‘2.2r4’ becomes ‘2.2r5’, and +so forth).

Note that development under unstable continues during the freeze period, since the unstable distribution remains in @@ -805,7 +909,7 @@ place in parallel with testing. Experimental

-The experimental distribution is a specialty distribution. +The experimental distribution is a special distribution. It is not a full distribution in the same sense as `stable' and `unstable' are. Instead, it is meant to be a temporary staging area for highly experimental software where there's a good chance that the @@ -833,13 +937,16 @@ access. Some experimental software can still go into unstable, with a few warnings in the description, but that isn't recommended because packages from unstable are expected to propagate to testing and -thus to stable. +thus to stable. You should not be afraid to use +experimental since it does not cause any pain to the ftpmasters, +the experimental packages are automatically removed once you upload +the package in unstable with a higher version number.

New software which isn't likely to damage your system can go directly into unstable.

An alternative to experimental is to use your personal web space -on people.debian.org (klecker.debian.org). +on people.debian.org. Release code names @@ -879,6 +986,322 @@ real distribution directories use the code names, while symbolic links for stable, testing, and unstable point to the appropriate release directories. + + The Incoming system +

+The Incoming system is responsible of collecting updated packages and +installing them in the Debian archive. It consists of a set of +directories and scripts that are installed both on &ftp-master-host; +and &non-us-host;. +

+Packages are uploaded by all the maintainers into a directory called +unchecked. This directory is scanned every 15 minutes by the katie script +that verifies the integrity of the uploaded packages and the cryptographic +signatures. If the package is considered ready to be installed, it +is moved into the accepted directory. If this is the first upload of +the package, it is moved in the new directory, where it waits +for an approval of the ftpmasters. If the package contains files to be installed +"by-hand" is is moved in the byhand directory, where it waits +for a manual installation by the ftpmasters. Otherwise, if any error has been detected, +the package is refused and is moved in the reject directory. +

+Once the package is accepted the system sends a confirmation +mail to the maintainer, closes all the bugs marked as fixed by the upload +and the auto-builders may start recompiling it. The package is now publicly +accessible at (there is no +such URL for packages in the non-US archive) until it is really installed +in the Debian archive. This happens only once a day, the package +is then removed from incoming and installed in the pool along with all +the other packages. Once all the other updates (generating new +Packages and Sources index files for example) have been +made, a special script is called to ask all the primary mirrors to update +themselves. +

+All debian developers have write access to the unchecked +directory in order to upload their packages, they also have that access +to the reject directory in order to remove their bad uploads +or to move some files back in the unchecked directory. But +all the other directories are only writable by the ftpmasters, that is +why you can not remove an upload once it has been accepted. + + Delayed incoming +

+The unchecked directory has a special DELAYED +subdirectory. It is itself subdivided in nine directories +called 1-day to 9-day. Packages which are uploaded in +one of those directories will be moved in the real unchecked +directory after the corresponding number of days. +This is done by a script that is run each day and which moves the +packages between the directories. Those which are in "1-day" are +installed in unchecked while the others are moved in the +adjacent directory (for example, a package in 5-day will +be moved in 4-day). This feature is particularly useful +for people who are doing non-maintainer uploads. Instead of +waiting before uploading a NMU, it is uploaded as soon as it is +ready but in one of those DELAYED/x-day directories. +That leaves the corresponding number of days for the maintainer +to react and upload another fix themselves if they are not +completely satisfied with the NMU. Alternatively they can remove +the NMU. +

+The use of that delayed feature can be simplified with a bit +of integration with your upload tool. For instance, if you use +dupload (see ), you can add this +snippet to your configuration file: + +$delay = ($ENV{DELAY} || 7); +$cfg{'delayed'} = { + fqdn => "&ftp-master-host;", + login => "yourdebianlogin", + incoming => "/org/ftp.debian.org/incoming/DELAYED/$delay-day/", + dinstall_runs => 1, + method => "scpb" +}; + +Once you've made that change, dupload can be used to +easily upload a package in one of the delayed directories: +DELAY=5 dupload --to delayed <changes-file> + + + The testing scripts +

+The testing scripts are run each day after the installation of the +updated packages. They generate the Packages files for +the testing distribution, but they do so in an intelligent manner +trying to avoid any inconsistency and trying to use only +non-buggy packages. +

The inclusion of a package from unstable is conditional on the following: + + +The package must have been available in unstable for several days; +the precise number depends on the upload's urgency field. It +is 10 days for low urgency, 5 days for medium urgency and 2 days for high +urgency. Those delays may be doubled during a freeze; + +It must have less release-critical bugs than the version available +in testing; + +It must be available on all architectures on which it has been +previously built. may be of interest to +check that information; + +It must not break any dependency of a package that is already available +in testing; + +The packages on which it depends must either be available in testing +or they must be accepted into testing at the same time (and they will +if they respect themselves all the criteria); + +

+The scripts are generating some output files to explain why some packages +are kept out of testing. They are available at . Alternatively, it is possible to use +the grep-excuses program part of the +devscripts package. It can be easily put in a crontab +to keep someone informed of the progression of his packages in testing. +

+The update_excuses file does not always give the precise reason +why the package is refused, one may have to find it on their own by looking +what would break with the inclusion of the package. The gives some more information +about the usual problems which may be causing such troubles. +

+Sometimes, some packages never enter testing because the set of +inter-relationship is too complicated and can not be sorted out +by the scripts. In that case, the release manager must be +contacted, and he will force the inclusion of the packages. + + Package's information +

+ + On the web +

+Each package has several dedicated web pages that contain a lot of +information. http://&packages-host;/package-name +will display each version of the package +available in the various distributions. The per-version detailed +information includes the package description, +the dependencies and links to download the package. +

+The bug tracking system sorts the bugs by package, you can +watch the bugs of each package at +http://&bugs-host;/package-name. + + The madison utility +

+madison is a command-line utility that is available +on both &ftp-master-host; and &non-us-host;. It +uses a single argument corresponding to a package name. In result +it displays which version of the package is available for each +architecture and distribution combination. An example will explain +it better. +

+ +$ madison libdbd-mysql-perl +libdbd-mysql-perl | 1.2202-4 | stable | source, alpha, arm, i386, m68k, powerpc, sparc +libdbd-mysql-perl | 1.2216-2 | testing | source, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc +libdbd-mysql-perl | 1.2216-2.0.1 | testing | alpha +libdbd-mysql-perl | 1.2219-1 | unstable | source, alpha, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc + +

+In this example, you can see that the version in unstable differs from +the version in testing and that there has been a binary-only NMU of the +package for the alpha architecture. Each time the package has been +recompiled on most of the architectures. + + The Package Tracking System +

+The Package Tracking System (PTS) is basically a tool to track by mail +the activity of a source package. You just have to subscribe +to a source package to start getting the mails related to it. +You get the same mails than the maintainer. Each mail +sent through the PTS is classified and associated to one of +the keyword listed below. This will let you select the mails that +you want to receive. +

+By default you will get: + + bts + +All the bug reports and following discussions. + + bts-control + +The control mails notifying a status change in one of the bugs. + + upload-source + +The confirmation mail from katie when an uploaded source +package is accepted. + + katie-other + +Other warning and error mails from katie (like the +override disparity for the section or priority field). + + default + +Any non-automatic mail sent to the PTS by people who wanted to +contact the subscribers of the package. + + summary + +In the future, you may receive regular summary mails to keep you +informed of the package's status (bug statistics, porting overview, +progression in testing, ...). + +

+You can also decide to receive some more information: + + upload-binary + +The confirmation mail from katie when an uploaded binary +package is accepted (to check that your package is recompiled for all +architectures). + + cvs + +CVS commits if the maintainer has setup a system to forward commit +notification to the PTS. + + + The PTS email interface +

+You can control your subscription(s) to the PTS by sending +various commands to pts@qa.debian.org. + + + +subscribe <srcpackage> [<email>] + + Subscribes email to communications related to the source package + srcpackage. Sender address is used if the second argument is + not present. If srcpackage is not a valid source package, + you'll get a warning. However if it's a valid binary package, the PTS + will subscribe you to the corresponding source package. + +unsubscribe <srcpackage> [<email>] + + Removes a previous subscription to the source package srcpackage + using the specified email address or the sender address if the second + argument is left out. + +which [<email>] + + Lists all subscriptions for the sender or the email address optionally + specified. + +keyword [<email>] + + Tells you the keywords that you are accepting. Each mail sent through + the Package Tracking System is associated to a keyword and you receive + only the mails associated to keywords that you are accepting. Here is + the list of available keywords: + + bts: mails coming from the Debian Bug Tracking System + bts-control: reply to mails sent to + control@bugs.debian.org + summary: automatic summary mails about the state of a package + cvs: notification of CVS commits + upload-source: announce of a new source upload that + has been accepted + upload-binary: announce of a new binary-only upload (porting) + katie-other: other mails from ftpmasters + (override disparity, etc.) + default: all the other mails (those which aren't "automatic") + + +keyword <srcpackage> [<email>] + + Same as previous item but for the given source package since + you may select a different set of keywords for each source package. + +keyword [<email>] {+|-|=} <list of keywords> + + Accept (+) or refuse (-) mails associated to the given keyword(s). + Define the list (=) of accepted keywords. + +keyword <srcpackage> [<email>] {+|-|=} <list of keywords> + + Same as previous item but overrides the keywords list for the + indicated source package. + +quit | thanks | -- + + Stops processing commands. All following lines are ignored by + the bot. + + + Filtering PTS mails +

+Once you are subscribed to a package, you will get the mails sent to +srcpackage@packages.qa.debian.org. Those mails +have special headers appended to let you filter them in a special +mailbox with procmail. The added headers are +X-Loop, X-PTS-Package, X-PTS-Keyword and +X-Unsubscribe. +

+Here is an example of added headers for a source upload notification +on the dpkg package: + +X-Loop: dpkg@&pts-host; +X-PTS-Package: dpkg +X-PTS-Keyword: upload-source +X-Unsubscribe: echo 'unsubscribe dpkg' | mail pts@qa.debian.org + + + Forwarding CVS commits in the PTS +

+If you use a publicly accessible CVS repository for maintaining +your Debian package you may want to forward the commit notification +to the PTS so that the subscribers (possible co-maintainers) can +closely follow the package's evolution. +

+It's very easy to setup. Once your CVS repository generates commit +notifications, you just have to make sure it sends a copy of those mails +to srcpackage_cvs@&pts-host;. Only people who +accepts the cvs keyword will receive the notifications. + Managing Packages

@@ -898,7 +1321,7 @@ more information.

Assuming no one else is already working on your prospective package, you must then submit a bug report () against the -pseudo package wnpp +pseudo-package wnpp describing your plan to create a new package, including, but not limiting yourself to, a description of the package, the license of the prospective package and the current URL where it can be downloaded @@ -951,7 +1374,7 @@ completed. This file will be installed in /usr/share/doc/package/changelog.gz for native packages.

-The debian/changelog file conform to a certain structure, +The debian/changelog file conforms to a certain structure, with a number of different fields. One field of note, the distribution, is described in . More information about the structure of this file can be found in @@ -998,7 +1421,7 @@ to emit errors (they will start with E). For more information on lintian, see . Downgrade the package to the previous version (if one exists) — this -tests the postrm and prerm scripts. +tests the postrm and prerm scripts. Remove the package, then reinstall it. @@ -1007,7 +1430,7 @@ Remove the package, then reinstall it. Generating the changes file

When a package is uploaded to the Debian FTP archive, it must be -accompanied by a .changes file, which gives directions to the +accompanied by a .changes file, which gives directions to the archive maintainers for its handling. This is usually generated by dpkg-genchanges during the normal package build process.

@@ -1026,8 +1449,8 @@ id="upload-bugfix">.

The first time a version is uploaded which corresponds to a particular upstream version, the original source tar file should be uploaded and -included in the .changes file. Subsequently, this very same -tar file should be used to build the new diffs and .dsc +included in the .changes file. Subsequently, this very same +tar file should be used to build the new diffs and .dsc files, and will not need to be re-uploaded.

By default, dpkg-genchanges and @@ -1039,7 +1462,7 @@ may be modified by using -sa to always include it or

If no original source is included in the upload, the original source tar-file used by dpkg-source when constructing the -.dsc file and diff to be uploaded must be +.dsc file and diff to be uploaded must be byte-for-byte identical with the one already in the archive. @@ -1109,7 +1532,7 @@ fix. Uploading to stable

Uploading to stable means that the package will be placed into the -proposed-updates directory of the Debian archive for further +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 @@ -1149,52 +1572,51 @@ inclusion. Uploading to ftp-master

To upload a package, you need a personal account on -ftp-master.debian.org, which you should have as an +&ftp-master-host;, which you should have as an official maintainer. If you use scp or rsync -to transfer the files, place them into &us-upload-dir;; +to transfer the files, place them into &us-upload-dir;; if you use anonymous FTP to upload, place them into -/pub/UploadQueue/. Please note that you should transfer +&upload-queue;. Please note that you should transfer the changes file last. Otherwise, your upload may be rejected because the archive maintenance software will parse the changes file and see that not all files have been uploaded. If you don't want to bother with transferring the changes file last, you can simply copy your files to a temporary directory on ftp-master and then move them to -&us-upload-dir;. +&us-upload-dir;.

-Note: Do not upload to ftp-master packages -containing software that is patent-restricted by the United States -government, nor any cryptographic packages which belong to -contrib or non-free. If you can't upload it to -ftp-master, then neither can you upload it to the overseas -upload queues on chiark or erlangen. Uploads of +Note: Do not upload to ftp-master cryptographic +packages which belong to contrib or non-free. Uploads of such software should go to non-us (see ). If you are not sure whether U.S. patent -controls or cryptographic controls apply to your package, post a -message to &email-debian-devel; and ask. -

-You may also find the Debian packages dupload or -dput useful -when uploading packages. These handy program are distributed with -defaults for uploading via ftp to ftp-master, -chiark, and erlangen. They can also be configured to -use ssh or rsync. See , and for more information. -

-After uploading your package, you can check how the archive maintenance -software will process it by running dinstall on your changes -file: dinstall -n foo.changes - - Uploading to non-US (pandora) +id="upload-non-us">). Furthermore packages containing code that is +patent-restricted by the United States government can not be uploaded to +ftp-master; depending on the case they may still be uploaded to +non-US/non-free (it's in non-free because of distribution issues +and not because of the license of the software). If you can't upload it to +ftp-master, then neither can you upload it to the overseas upload +queues on chiark or erlangen. If you are not sure +whether U.S. patent controls or cryptographic controls apply to your +package, post a message to &email-debian-devel; and ask. +

+You may also find the Debian packages or + useful +when uploading packages. These handy programs help automate the +process of uploading packages into Debian. +

+After uploading your package, you can check how the archive +maintenance software will process it by running dinstall +on your changes file: dinstall -n foo.changes. +Note that dput can do this for you automatically. + + Uploading to non-US

As discussed above, export controlled software should not be uploaded to ftp-master. Instead, upload the package to non-us.debian.org, placing the files in -&non-us-upload-dir; (both and can be used also, with the right invocation). By default, +&non-us-upload-dir; (again, both and can do this for you if invoked properly). By default, you can use the same account/password that works on ftp-master. If you use anonymous FTP to upload, place the -files into /pub/UploadQueue/. +files into &upload-queue;.

You can check your upload the same way it's done on ftp-master, with: @@ -1232,7 +1654,7 @@ residents consult a lawyer before doing uploads to non-US. Uploads via chiark

If you have a slow network connection to ftp-master, there are -alternatives. One is to upload files to Incoming via a +alternatives. One is to upload files to Incoming via a upload queue in Europe on chiark. For details connect to .

@@ -1252,12 +1674,12 @@ Another upload queue is available in Germany: just upload the files via anonymous FTP to .

The upload must be a complete Debian upload, as you would put it into -ftp-master's Incoming, i.e., a .changes files -along with the other files mentioned in the .changes. The -queue daemon also checks that the .changes is correctly +ftp-master's Incoming, i.e., a .changes files +along with the other files mentioned in the .changes. The +queue daemon also checks that the .changes is correctly signed with GnuPG or OpenPGP by a Debian developer, so that no bogus files can find their way to ftp-master via this queue. Please also make sure that -the Maintainer field in the .changes contains +the Maintainer field in the .changes contains your e-mail address. The address found there is used for all replies, just as on ftp-master.

@@ -1296,7 +1718,7 @@ the ``debian-changes'' lists. This is now done automatically by the archive maintenance software when it runs (usually once a day). You just need to use a recent dpkg-dev (>= 1.4.1.2). The mail generated by the archive maintenance software will contain the OpenPGP/GnuPG signed -.changes files that you uploaded with your package. +.changes files that you uploaded with your package. Previously, dupload used to send those announcements, so please make sure that you configured your dupload not to send those announcements (check its documentation and look for @@ -1307,10 +1729,6 @@ If a package is released with the Distribution: set to package is released with Distribution: set to `unstable', or `experimental', the announcement will be posted to &email-debian-devel-changes; instead. -

-The dupload program is clever enough to determine -where the announcement should go, and will automatically mail the -announcement to the right list. See . Notification that a new package has been installed @@ -1325,8 +1743,8 @@ distribution is handled manually. When uploads are handled manually, the change to the archive may take up to a month to occur. Please be patient.

-In any case, you will receive email notification indicating that the -package has added to the archive, which also indicates which bugs will +In any case, you will receive an email notification indicating that the +package has been added to the archive, which also indicates which bugs will be closed by the upload. Please examine this notification carefully, checking if any bugs you meant to close didn't get triggered.

@@ -1451,36 +1869,35 @@ 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. Try the following steps first, -and if they don't work, it is probably OK to do an NMU: +as a last resort or with permission. The following protocol should +be respected to do an NMU:

-Make sure that the package bug is in the Debian Bug Tracking System -(BTS). If not, submit a bug. +Make sure that the package's bug is in the Debian Bug Tracking System +(BTS). If not, submit a bug. -Email the maintainer, and offer to help fix the package bug. Give it a -few days. - -Go ahead and fix the bug, submitting a patch to the right bug in the -BTS. Build the package and test it as discussed in . Use it locally. - -Wait a couple of weeks for a response. - -Email the maintainer, asking if it is OK to do an NMU. +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 +the bug. Don't forget to tag the bug with the "patch" keyword. +Wait a few more days. If you still haven't got an answer from the +maintainer, send him a mail announcing your intent to NMU the package. +Prepare an NMU as described in , test it +carefully on your machine (cf. ). Double check that your patch doesn't have any unexpected side effects. -Make sure your patch is as small and as non-disruptive as it can be. +Make sure your patch is as small and as non-disruptive as it can be. -Wait another week for a response. +Upload your package to incoming in DELAYED/7-day (cf. +), send the final patch to the maintainer via +the BTS, and explain to them that they have 7 days to react if they want +to cancel the NMU. -Go ahead and do the source NMU, as described in . +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. - - How to do a source NMU

The following applies to porters insofar as they are playing the dual @@ -1527,11 +1944,7 @@ absolutely 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 debian-revision value `0.1'. The usual maintainer of a package should start their -debian-revision numbering at `1'. Note that if you do -this, you'll have to invoke dpkg-buildpackage with the --sa switch to force the build system to pick up the new -source package (normally it only looks for Debian revisions of '0' or -'1' — it's not yet clever enough to know about `0.1'). +debian-revision numbering at `1'. @@ -1603,7 +2016,23 @@ the debian/control file. Your name as given in the NMU entry of the debian/changelog file will be used for signing the changes file. - + Acknowledging an NMU +

+If one of your packages has been NMUed, you have to incorporate the +changes in your copy of the sources. This is easy, you just have +to apply the patch that has been sent to you. Once this is done, you +have to close the bugs that have been tagged fixed by the NMU. You +can either close them manually by sending the required mails to the +BTS or by adding the required closes: #nnnn in the changelog +entry of your next upload. +

+In any case, you should not be upset by the NMU. An NMU is not a +personal attack against the maintainer. It is a proof that +someone cares enough about the package and that they were willing to help +you in your work, so you should be thankful. You may also want to +ask them if they would be interested to help you on a more frequent +basis as co-maintainer or backup maintainer +(see ). Porting and Being Ported @@ -1650,9 +2079,11 @@ are set properly. The best way to validate this is to use the debootstrap package to create an unstable chroot environment. Within that chrooted environment, install the build-essential package and any package -dependencies mention in Build-Depends and/or +dependencies mentioned in Build-Depends and/or Build-Depends-Indep. Finally, try building your package -within that chrooted environment. +within that chrooted environment. These steps can be automated +by the use of the pbuilder program which is provided by +the package of the same name.

See the for instructions on setting build dependencies. @@ -1665,7 +2096,7 @@ Manual">. Setting your architecture to ``i386'' is usually incorrect. Make sure your source package is correct. Do dpkg-source -x package.dsc to make sure your source package unpacks properly. Then, in there, try building your package from scratch with -dpkg-buildpackage. +dpkg-buildpackage. Make sure you don't ship your source package with the debian/files or debian/substvars files. @@ -1720,7 +2151,7 @@ package, using the `binary-arch' target in debian/rules. Sometimes the initial porter upload is problematic because the environment in which the package was built was not good enough (outdated or obsolete library, bad compiler, ...). Then you may just need to recompile it in -an updated environment. However, you do have to bump the version number in +an updated environment. However, you have to bump the version number in this case, so that the old bad package can be replaced in the Debian archive (katie refuses to install new packages if they don't have a version number greater than the currently available one). Despite the @@ -1816,7 +2247,7 @@ conjunction with auto-builders, which are ``slave'' hosts which simply check out and attempt to auto-build packages which need to be ported. There is also an email interface to the system, which allows porters to ``check out'' a source package (usually one which -cannot yet be autobuilt) and work on it. +cannot yet be auto-built) and work on it.

buildd is not yet available as a package; however, most porting efforts are either using it currently or planning to use @@ -1849,13 +2280,49 @@ headers for cross-compiling in a way similar to enhanced to support cross-compiling. - + + Collaborative maintenance +

+"Collaborative maintenance" is a term describing the sharing of Debian +package maintenance duties by several people. This collaboration is +almost a good idea, since it generally results in higher quality and +faster bug fix turnaround time. It is strongly recommended that +packages in which a priority of Standard or which are part of +the base set have co-maintainers.

+

+Generally there is a primary maintainer and one or more +co-maintainers. The primary maintainer is the whose name is listed in +the Maintainer field of the debian/control file. +Co-maintainers are all the other maintainers.

+

+In its most basic form, the process of adding a new co-maintainer is +quite easy: + +

+Setup the co-maintainer with access to the sources you build the +package from. Generally this implies you are using a network-capable +version control system, such as CVS or +Subversion.

+ + +

+Add the co-maintainer's correct maintainer name and address to the +Uploaders field in the global part of the +debian/control file.

+ + +

+Using the PTS (), the co-maintainers +should subscribe themselves to the appropriate source package.

+ +

+ Moving, Removing, Renaming, Adopting, and Orphaning Packages

-Some archive manipulation operation are not automated in the Debian +Some archive manipulation operations are not automated in the Debian upload process. These procedures should be manually followed by maintainers. This chapter gives guidelines in what to do in these cases. @@ -1911,11 +2378,17 @@ If in doubt concerning whether a package is disposable, email package. When invoked as apt-cache showpkg package, the program will show details for package, including reverse depends. +

+Once the package has been removed, the package's bugs should be handled. +They should either be reassigned to another package in the case where +the actual code has evolved into another package (e.g. libfoo12 +was removed because libfoo13 supersedes it) or closed if the +software is simply no more part of Debian. - Removing packages from Incoming + Removing packages from Incoming

-In the past, it was possible to remove packages from incoming. -With the introduction of the New Incoming system this is no longer +In the past, it was possible to remove packages from incoming. +However, with the introduction of the new incoming system, this is no longer possible. Instead, you have to upload a new revision of your package with a higher version as the package you want to replace. Both versions will be installed in the archive but only the higher version will actually be @@ -1932,13 +2405,14 @@ obsolete name of the package (see the for details). Once you've uploaded 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. +obsolete name. Do not forget to properly reassign the package's bugs +at the same time. Orphaning a package

If you can no longer maintain a package, you need to inform the others about that, and see that the package is marked as orphaned. -you should set the package maintainer to Debian QA Group +You should set the package maintainer to Debian QA Group &orphan-address; and submit a bug report against the pseudo package wnpp. The bug report should be titled O: package -- short description @@ -1949,10 +2423,11 @@ of the message (no, don't use CC:, because that way the message's subject won't indicate the bug number).

If the package is especially crucial to Debian, you should instead submit -a bug against wnpp and title it RFA: package -- +a bug against wnpp and title it RFA: package -- short description and set its severity to -important. Definitely copy the message to debian-devel in this -case, as described above. +important. RFA stands for Request For Adoption. +Definitely copy the message to debian-devel in this case, as described +above.

Read instructions on the for more information. @@ -1971,16 +2446,17 @@ current maintainer and ask them if you may take over the package. However, without their assent, you may not take over the package. Even if they ignore you, that is still not grounds to take over a package. If you really feel that a maintainer has gone AWOL (absent -without leave), post a query to &email-debian-private;. +without leave), post a query to &email-debian-private;. You may also +inform the QA group (cf. ).

If you take over an old package, you probably want to be listed as the package's official maintainer in the bug system. This will happen automatically once you upload a new version with an updated Maintainer: field, although it can take a few hours after the upload is done. If you do not expect to upload a new version for a while, -send an email to &email-override; so that bug reports will go to you -right away. - +you can use to get the bug reports. However, +make sure that the old maintainer has no problem with the fact that +they will continue to receive the bugs during that time. Handling package bugs @@ -1996,9 +2472,11 @@ id="submit-bug">. If you want to be a good maintainer, you should periodically check the for your packages. The BTS contains all the open bugs against your packages. +You can check them by browsing this page: +http://&bugs-host;/yourlogin@debian.org.

Maintainers interact with the BTS via email addresses at -bugs.debian.org. Documentation on available commands can be +&bugs-host;. Documentation on available commands can be found at , or, if you have installed the doc-debian package, you can look at the local files &file-bts-docs;. @@ -2015,8 +2493,13 @@ maintainer address. Responding to bugs

-Make sure that any discussions you have about bugs are sent both to +Make sure that any discussion you have about bugs are sent both to the original submitter of the bug, and the bug itself (e.g., +123@bugs.debian.org). If you're writing a new +mail and you don't remember the submitter email address, you can +use the 123-submitter@bugs.debian.org email to +contact the submitter and to record your mail within the +bug log (that means you don't need to send a copy of the mail to 123@bugs.debian.org).

You should never close bugs via the bug server close @@ -2029,17 +2512,82 @@ closed. As a package maintainer, you will often find bugs in other packages or have bugs reported against your packages which are actually bugs in other packages. The document the technical operation of the BTS, such as +instructions"> document the technical operations of the BTS, such as how to file, reassign, merge, and tag bugs. This section contains some guidelines for managing your own bugs, based on the collective Debian developer experience.

Filing bugs for problems that you find in other packages is one of the "civic obligations" of maintainership, see -for details. +for details. However handling the bugs on your own packages is +even more important.

-&FIXME;Talk about tags, forwarding bugs, or else break it into -different sections... +Here's a list of steps that you may follow to handle a bug report: + + +Decide whether the report corresponds to a real bug or not. Sometimes +users are just calling a program in the wrong way because they haven't +read the documentation. If you diagnose this, just close the bug with +enough information to let the user correct his problem (give pointers +to the good documentation and so on). If the same report comes up +again and again you may ask yourself if the documentation is good +enough or if the program shouldn't detect its misuse in order to +give an informative error message. This is an issue that may need +to be brought to the upstream author. +

+If the bug submitter disagree with your decision to close the bug, +they may reopen it until you find an agreement on how to handle it. +If you don't find any, you may want to tag the bug wontfix +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). + + +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 +be reassigned to, you may either ask for help on &email-debian-devel; or +reassign it to debian-policy to let them decide which +package is in fault. +

+Sometimes you also have to adjust the severity of the bug so that it +matches our definition of the severity. That's because people tend to +inflate the severity of bugs to make sure their bugs are fixed quickly. +Some bugs may even be dropped to wishlist severity when the requested +change is just cosmetic. + +The bug submitter may have forgotten to provide some information, in that +case you have to ask him the information required. You may use the +moreinfo tag to mark the bug as such. Moreover if you can't +reproduce the bug, you tag it unreproducible. Anyone who +can reproduce the bug is then invited to provide more information +on how to reproduce it. After a few months, if this information has not +been sent by someone, the bug may be closed. + +If the bug is related to the packaging, you just fix it. If you are not +able to fix it yourself, then tag the bug as help. You can +also ask for help on &email-debian-devel; or &email-debian-qa;. If it's an +upstream problem, you have to forward it to the upstream author. +Forwarding a bug is not enough, you have to check at each release if +the bug has been fixed or not. If it has, you just close it, otherwise +you have to remind the author about it. If you have the required skills +you can prepare a patch that fixes the bug and that you send at the +same time to the author. Make sure to send the patch in the BTS and to +tag the bug as patch. + +If you have fixed a bug in your local copy, or if a fix has been +committed to the CVS repository, you may tag the bug as +pending to let people know that the bug is corrected and that +it will be closed with the next upload (add the closes: in +the changelog). This is particularly useful if you +are several developers working on the same package. + +Once a corrected package is available in the unstable +distribution, you can close the bug. This can be done automatically, +read . + When bugs are closed by new uploads @@ -2070,12 +2618,12 @@ used: /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig -The author prefers the closes: #XXX) syntax, as +The author prefers the closes: #XXX syntax, as one of the most concise and easiest to integrate with the text of the changelog.

If you want to close bugs the old fashioned, manual way, it is usually -sufficient to mail the .changes file to +sufficient to mail the .changes file to XXX-done@bugs.debian.org, where XXX is your bug number. @@ -2104,23 +2652,214 @@ faced during packaging. It also lists various advice collected on several mailing lists. By following them, you will make Debian's quality even better. + + Packaging tools and common cases + + Helper scripts +

+To help you in your packaging effort, you can use helper scripts. +The best scripts available are provided by debhelper. +With dh_make (package dh-make), you can +generate in a few seconds a package that is mostly ready. However that +apparent simplicity is hiding many things done by the helper scripts. +You have to know what is done by them, that's why you are strongly +encouraged to read the corresponding manual pages, starting with +debhelper(1). That's required because you'll have to +understand what is going on to be able to use them wisely and to +fix bugs in a pretty way. +

+debhelper is very useful because it lets you follow the latest Debian policy +without doing many modifications since the changes that can be automated are +almost always automatically done by a debhelper script. Furthermore it +offers enough flexibility to be able to use it in conjunction with +some hand crafted shell invocations within the rules file. +

+You can however decide to not use any helper script, and still write +some very good rules file. Many examples are available +at . + + + + Package with multiple patches +

+Big packages tend to have many upstream bugs that you want to fix within +the Debian package. If you just correct the bug in the source, all the +fixes are directly integrated in the .diff.gz file and you +can't easily differentiate the various patches that you applied. It gets +very messy when you have to update the package to a new upstream version +which integrates some of the fixes (but not all). +

+The good solution is to keep separate patches within the +debian/patches directory and to apply them on the fly at +build time. The package dbs provides an +implementation of such a system, you just have to build-depend on dbs to +be able to use its functionalities. The package +hello-dbs is a simple example that demonstrates how to +use dbs. +

+Additionally, dbs provides facilities to create the patches and to keep +track of what they are for. + + Multiple binary packages +

+A single source package will often build several binary packages, either +to provide several flavors of the same software (examples are the +vim-* packages) or to make several small packages instead of a big one +(it's interesting if the user doesn't need all the packages and can thus +save some disk space). +

+The second case can be easily managed by dh_install (from +debhelper) to move files from the build directory to +the package's temporary trees. +

+The first case is a bit more difficult since it involves multiple recompiles +of the same software but with different configure options. The +vim is an example of how to manage this with an +hand crafted rules file. + + + Handling debconf translations +

+Like porters, translators have a difficult task. Since they work on many +packages, they cannot keep track of every change in packages in order to +be informed when a translated string is outdated. Fortunately +debconf can automatically report outdated translations, +if package maintainers follow some basic guidelines described below. +

+Translators can use debconf-getlang (package +debconf-utils) to write a templates.xx +file containing both English and localized fields (where xx is +the language code, may be followed by a country code). This file can be +put into the debian subdirectory without any change. +

+When building a binary package, debian/templates.xx files are +merged along with debian/templates to generate the +templates file contained in the binary package. This is +automatically done by dh_installdebconf (package +debhelper). If you do not use debhelper, you can +do the same with debconf-mergetemplate +(package debconf-utils). +

+When the package maintainer needs to update the templates file, they only +change debian/templates. When English strings in this file +and in debian/templates.xx differ, translators do know that +their translation is outdated. +

+Please see the page about + +at the Debian web site, it contains more detailed instructions, including a +full example. + + + + Specific packaging practices + + + + Libraries +

+Libraries are always difficult to package for various reasons. The policy +imposes many constraints to ease their maintenance and to make sure +upgrades are as simple as possible when a new upstream version comes out. +A breakage in a library can result in dozens of dependent packages to +break... +

+Good practices for library packaging have been grouped in +. + + Other specific packages +

+Several subsets of packages have special sub-policies and corresponding +packaging rules and practices: + + +Perl related packages have a , +some examples of packages following that policy are +libdbd-pg-perl (binary perl module) or +libmldbm-perl (arch independent perl module). + +Python related packages have their python policy: +&file-python-policy; (in the python package). + +Emacs related packages have the . + +Java related packages have their . + +Ocaml related packages have their ocaml policy: &file-ocaml-policy; (in +the ocaml package). A good example is the camlzip +source package. + + + + Configuration management + + The wise use of debconf +

+Debconf is a configuration management system, it is used by all the +various packaging scripts (postinst mainly) to request feedback from the +user concerning how to configure the package. Direct user interactions +must now be avoided in favor of debconf interaction. This will enable +non-interactive installations in the future. +

+Debconf is a great tool but it is often badly used ... many common mistakes +are listed in the man page. +It is something that you must read if you decide to use debconf. + + + - Miscellaenous advice + Miscellaneous advice Writing useful descriptions

The description of the package (as defined by the corresponding field in the control file) is usually the first information -available to the user before he installs it. As such, it should -provide all the required information that can help him decide whether -or not he will install it. +available to the user before they install it. As such, it should +provide all the required information to let him decide whether +to install the package.

-For example, apart from the usual description that you will copy from the +For example, apart from the usual description that you adapt from the upstream README, you should include the URL of the -website if there's any. If the package is not yet considered stable +web site if there's any. If the package is not yet considered stable by the author, you may also want to warn the user that the package is not ready for production use. +

+For consistency and for an aesthetic concern, you should capitalize the +first letter of the description. +

+Last but not least, since the first user impression is based on +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. + @@ -2155,11 +2894,17 @@ which are reported more than once, or setting bug severities to neither the bug submitter nor the package maintainer, you should not actually close the bug (unless you secure permission from the maintainer). +

+From time to time you may want to check what has been going on +with the bug reports that you submitted. Take this opportunity to +close those that you can't reproduce anymore. To find +out all the bugs you submitted, you just have to visit +http://&bugs-host;/from:<your-email-addr>. Reporting lots of bugs at once

Reporting a great number of bugs for the same problem on a great -number of different packages &mdash i.e., more than 10 &mdash is a deprecated +number of different packages — i.e., more than 10 — is a deprecated practice. Take all possible steps to avoid submitting bulk bugs at all. For instance, if checking for the problem can be automated, add a new check to lintian so that an error or warning @@ -2200,19 +2945,37 @@ If you do not get a reply after a few weeks you should collect all useful information about this maintainer. Start by logging into the and doing a full search to check whether the maintainer is on vacation -and when he was last seen. Collect any important package names -he maintains and any Release Critical bugs filled against them. +and when they were last seen. Collect any important package names +they maintain and any Release Critical bugs filed against them.

Send all this information to &email-debian-qa;, in order to let the QA people do whatever is needed. - + Contacting other maintainers +

+During your lifetime within Debian, you will have to contact other +maintainers for various reasons. You may want to discuss a new +way of cooperating between a set of related packages, or you may +simply remind someone that a new upstream version is available +and that you need it. +

+Looking up the email address of the maintainer for the package can be +distracting. Fortunately, there is a simple email alias, +<package>@&packages-host;, which provides a way to +email the maintainer, whatever their individual email address (or +addresses) may be. Replace <package> with the name of +a source or a binary package. +

+You may also be interested in contacting the persons who are +subscribed to a given source package via . +You can do so by using the <package-name>@&pts-host; +email address. Interacting with prospective Debian developers

-Debian's success depends on it's ability to attract and retain new and +Debian's success depends on its ability to attract and retain new and talented volunteers. If you are an experienced developer, we recommend that you get involved with the process of bringing in new developers. This section describes how to help new prospective @@ -2231,7 +2994,7 @@ id="&url-sponsors;">. New maintainers usually have certain difficulties creating Debian packages — this is quite understandable. That is why the sponsor is there, to check the package and verify that it is good enough for inclusion in Debian. -(Note that if the sponsored package is new, the FTP admins will also have to +(Note that if the sponsored package is new, the ftpmasters will also have to inspect it before letting it in.)

Sponsoring merely by signing the upload or just recompiling is @@ -2241,9 +3004,43 @@ doesn't matter that you left the prospective developer's name both in the changelog and the control file, the upload can still be traced to you.

If you are an application manager for a prospective developer, you can also -be their sponsor. That way you can also verify the how the applicant is +be their sponsor. That way you can also verify how the applicant is handling the 'Tasks and Skills' part of their application. + Managing sponsored packages +

+By uploading a sponsored package to Debian, you are certifying that +the package meets minimum Debian standards. That implies that you +must build and test the package on your own system before uploading. +

+You can not simply upload a binary .deb from the sponsoree. In +theory, you should only ask only for the diff file, and the location of the +original source tarball, and then you should download the source and apply +the diff yourself. In practice, you may want to use the source package +built by your sponsoree. In that case, you have to check that they haven't +altered the upstream files in the .orig.tar.gz file that +they're providing. +

+Do not be afraid to write the sponsoree back and point out changes +that need to be made. It often takes several rounds of back-and-forth +email before the package is in acceptable shape. Being a sponsor +means being a mentor. +

+Once the package meets Debian standards, build the package with +dpkg-buildpackage -us -uc and sign it +with debsign -m <your-email-addr> <changes-file> +before uploading it to the incoming directory. +

+The Maintainer field of the control file and the +changelog should list the person who did the packaging, i.e. the +sponsoree. The sponsoree will therefore get all the BTS mail about the +package. +

+If you prefer to leave a more evident trace of your sponsorship job, you +can add a line stating it in the most recent changelog entry. +

+You are encouraged to keep tabs on the package you sponsor using +. Advocating new developers

@@ -2277,7 +3074,7 @@ endorse any particular tool to the exclusion of a competing tool. Most of the descriptions of these packages come from the actual package descriptions themselves. Further information can be found in the package documentation itself. You can also see more info with the -command apt-cache show package_name. +command apt-cache show <package-name>. @@ -2409,7 +3206,7 @@ The dput package and script does much the same thing as dupload, but in a different way. It has some features over dupload, such as the ability to check the GnuPG signature and checksums before uploading, and the -possibility of running dinstall in dry-run mode after the +possibility of running dinstall in dry-run mode after the upload. @@ -2437,16 +3234,29 @@ depends. Or, you can test how your package behaves when installed into a bare base system. + + pbuilder +

+pbuilder constructs a chrooted system, and builds +a package inside the chroot. It is very useful to check that +a package's build-dependencies are correct, and to be sure that +unnecessary and wrong build dependencies will not exist in the +resulting package. + + devscripts

devscripts is a package containing a few wrappers -and tools which you may find helpful for maintaining your Debian +and tools which are very helpful for maintaining your Debian packages. Example scripts include debchange and dch, which manipulate your debian/changelog file from the command-line, and debuild, which is a -wrapper around dpkg-buildpackage. - +wrapper around dpkg-buildpackage. The bts +utility is also very helpful to update the state of bug reports on the +command line, as is uscan to watch for new upstream +versions of your packages. Check the devscripts(1) manual +page for a complete list of available scripts. @@ -2465,7 +3275,7 @@ finalizing a version and listing the package's current bugs. debget is a package containing a convenient script which can be helpful in downloading files from the Debian archive. You can use it to download source packages, for instance (although -apt-get source package does pretty much the same +apt-get source <package-name> does pretty much the same thing). @@ -2474,7 +3284,7 @@ thing). alien dpkg-repack grep-dctrl - pbuilder --> +-->