X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=a16315578dc105b9cd3d3bad14584e972940013c;hp=5ba52bf0c4a46c7e3d96200509477c7d89acd364;hb=ce6b59bbab873eb8355e6e14c57aebebba40897c;hpb=6891820b726709c3993d982665368bb6b5919def diff --git a/developers-reference.sgml b/developers-reference.sgml index 5ba52bf..a163155 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -1,9 +1,17 @@ - - %versiondata; - - + + %versiondata; + + %commondata; + + + + + ]> (DFSG) and with all other policy requirements as -described in the . The DFSG is our definition of ``free -software.'' Check out the Debian Policy Manual for details. -

-The packages which do not apply to the DFSG are placed in the - -Packages in the main section of the Debian archive is what makes up the +official Debian GNU/Linux distribution. +The main section is official because it fully complies with +all our guidelines. The other two sections do not, to different degrees; +as such, they are not officially part of Debian GNU/Linux. +

+Every package in the main section must fully comply with the (DFSG) and +with all other policy requirements as described in the . The DFSG is +our definition of ``free software.'' Check out the Debian Policy +Manual for details. +

+Packages in the contrib section have to comply with the DFSG, +but may fail other requirements. For instance, they may depend on non-free packages.

-The contains a more exact definition of the three -sections. The above discussion is just an introduction. +Packages which do not apply to the DFSG are placed in the +non-free section. These packages are not considered as part +of the Debian distribution, though we support their use, and we +provide infrastructure (such as our bug-tracking system and mailing +lists) for non-free software packages. +

+The +contains a more exact definition of the three sections. The above +discussion is just an introduction.

The separation of the three sections at the top-level of the archive is important for all people who want to distribute Debian, either via FTP servers on the Internet or on CD-ROMs: by distributing only the -main and contrib sections, one can avoid any legal +risks. Some packages in the non-free section do not allow +commercial distribution, for example.

On the other hand, a CD-ROM vendor could easily check the individual -package licenses of the packages in non-free and include as +many on the CD-ROMs as he's allowed to. (Since this varies greatly from +vendor to vendor, this job can't be done by the Debian developers.) Architectures @@ -539,65 +648,70 @@ more and more popular, the kernel was ported to other architectures, too.

The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola -680x0 machines (like Atari, Amiga and Macintoshes), MIPS, and PowerPC. -Newer kernels support more architectures, including ARM, UltraSPARC, -and MIPS. Since Linux supports these platforms, Debian decided that -it should, too. Therefore, Debian has ports underway. In fact, we +680x0 (like Atari, Amiga and Macintoshes), MIPS, and PowerPC. The +Linux 2.2 kernel supports even more architectures, including ARM and +UltraSPARC. Since Linux supports these platforms, Debian decided that +it should, too. Therefore, Debian has ports underway; in fact, we also have ports underway to non-Linux kernel. Aside from i386 (our name for Intel x86), there is m68k, alpha, powerpc, sparc, hurd-i386, -and arm as of this writing. - +and arm, as of this writing.

Debian GNU/Linux 1.3 is only available as i386. Debian 2.0 shipped for i386 and m68k architectures. Debian 2.1 ships for the i386, m68k, alpha, and -sparc architectures. +sparc architectures. Debian 2.2 adds support for the +powerpc and arm architectures. +

+Information for developers or uses about the specific ports are +available at the . Subsections

-The sections - +The sections main, contrib, and non-free +are split into subsections to simplify the installation +process and the maintainance of the archive. Subsections are not +formally defined, except perhaps the `base' subsection. +Subsections simply exist to simplify the organization and browsing of +available packages. Please check the current Debian distribution to +see which sections are available. +

+Note however that with the introduction of package pools (see the top-level +pool/ directory), the subsections in the form of subdirectories +will eventually cease to exist. They will be kept in the packages' `Section' +header fields, though. 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.

If a package is developed specially for Debian and is not distributed -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 +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 +changes made by the Debian maintainer.

-The .dsc lists all the files in the source package together +with checksums (md5sums) and some additional info about +the package (maintainer, version, etc.). Distribution directories

-The directory system described in the previous chapter, are themselves -contained within distribution directories. Each +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, @@ -605,107 +719,134 @@ server. For instance, at the mirror site, contained in /debian, which is a common location (another is /pub/debian).

-Within that archive root, the actual distributions are contained in -the - -archive root/dists/distribution/section/architecture/subsection/packages - +A distribution is comprised of Debian source and binary packages, and the +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). -Extrapolating from this layout, you know that to find the i386 base -packages for the distribution /debian/dists/slink/main/binary-i386/base/. - Stable, unstable, and sometimes frozen + Stable, testing, unstable, and sometimes frozen

-There is always a distribution called dists/stable) and one 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 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 -to test this distribution, it is sometimes ``unstable.'' -

-After a period of development, the +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. +

+After a period of development, once the release manager deems fit, the +testing distribution is renamed to frozen. Once +that has been done, no changes are allowed to that distribution except +bug fixes; that's why it's called ``frozen.'' After another month or +a little longer, depending on the progress, the frozen distribution +goes into a `deep freeze', when no changes are made to it except those +needed for the installation system. This is called a ``test cycle'', and it +can last up to two weeks. There can be several test cycles, until the +distribution is prepared for release, as decided by the release manager. +At the end of the last test cycle, the frozen distribution is +renamed to stable, overriding the old stable distribution, +which is removed at that time.

This development cycle is based on the assumption that the -unstable distribution becomes stable after passing a +period of testing as frozen. Even once a distribution is +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 batch into the stable distribution +and the revision level of the stable distribution is incremented +(e.g., `1.3' becomes `1.3r1', `2.0r2' becomes `2.0r3', and so forth).

-Note that development under unstable continues during the +``freeze'' period, since the unstable distribution remains in +place when the testing is moved to frozen. +Another wrinkle is that when the frozen distribution is +offically released, the old stable distribution is completely removed +from the Debian archives (although they do live on at +archive-host;).

-In summary, there is always a stable, a testing and an +unstable distribution available, and a frozen distribution +shows up for a couple of months from time to time. Experimental +

-The experimental distribution is a specialty 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 +software could break your system. Users who download and install +packages from experimental are expected to have been duly +warned. In short, all bets are off for the experimental +distribution.

Developers should be very selective in the use of the -experimental distribution. Even if a package is highly +unstable, it could still go into unstable; just state a +few warnings in the description. However, if there is a chance that +the software could do grave damage to a system, it might be better to +put it into experimental.

For instance, an experimental encrypted file system should probably go -into experimental. A new, beta, version of some software which uses -completely different configuration might go into experimental at the -maintainer's discretion. New software which isn't likely to damage -your system can go into experimental. A new, beta, version of some software +which uses completely different configuration might go into +experimental at the maintainer's discretion. New software +which isn't likely to damage your system can go into +unstable. If you are working on an incompatible or complex +upgrade situation, you can also use experimental as a staging +area, so that testers can get early access. +

+However, using experimental as a personal staging area is not +always the best idea. You can't replace or upgrade the files in there +on your own (it is done with Debian archive maintenance software). +Additionally, you'll have to remember to ask the archive +maintainers to delete the package once you have uploaded it to +unstable. Using your personal web space on +klecker.debian.org is generally a better idea, so that you put +less strain on the Debian archive maintainers. Release code names

-Every released Debian distribution has a code name: Debian +1.1 is called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0, +`hamm'; Debian 2.1, `slink'; and Debian 2.2, `potato'. There is also +a ``pseudo-distribution'', called `sid', which is the current +`unstable' distribution; since packages are moved from `unstable' to +`testing' as they approach stability, `sid' itself is never released. +As well as the usual contents of a Debian distribution, `sid' contains packages for architectures which are not yet officially supported or released by Debian. These architectures are planned to be integrated into the mainstream distribution at some future date.

-Since the Debian has an open development model (i.e., everyone can -participate and follow the development) even the unstable distribution -is distributed via the Internet on the Debian FTP and HTTP server -network. Thus, if we had called the directory which contains the -development version `unstable', then we would have to rename it +Since Debian has an open development model (i.e., everyone can +participate and follow the development) even the `unstable' and `testing' +distributions are distributed to the Internet through the Debian FTP and +HTTP server network. Thus, if we had called the directory which contains +the release candidate version `testing', then we would have to rename it to `stable' when the version is released, which would cause all FTP -mirrors to re-retrieve the whole distribution (which is already very -large!). +mirrors to re-retrieve the whole distribution (which is quite large).

On the other hand, if we called the distribution directories Debian-x.y from the beginning, people would think that Debian @@ -715,13 +856,13 @@ version. That's the reason why the first official Debian release was 1.1, and not 1.0.)

Thus, the names of the distribution directories in the archive are -determined by their code names and not their release status (i.e., -`slink'). These names stay the same during the development period -and after the release; symbolic links, which can be changed, are made -to indicate the currently released stable distribution. That's why -the real distribution directories use the code names, while symbolic +links for stable, testing, unstable, and +frozen point to the appropriate release directories. Package uploads @@ -729,140 +870,145 @@ appropriate release directories. Announcing new packages

If you want to create a new package for the Debian distribution, you -should first check the list. Checking -the WNPP ensures that no one is already working on packaging that -software, and that effort is not duplicated. Assuming no one else is -already working on your prospective package, you must then send a -short email to -There are a number of reasons why we ask maintainers to follow these -steps: +should first check the list. Checking the WNPP list ensures that +no one is already working on packaging that software, and that effort is +not duplicated. Read the for +more information. +

+Assuming no one else is already working on your prospective package, +you must then submit a short bug () against the +pseudo package wnpp and send a copy to &email-debian-devel; +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 +from. You should set the subject of the bug to ``ITP: foo +-- short description'', substituting the name of the new +package for foo. The severity of the bug report must be +set to wishlist. Please include a Closes: +bug#nnnnn entry on the changelog of the new package in +order for the bug report to be automatically closed once the new +package is installed on the archive (). +

+There are a number of reasons why we ask maintainers to announce their +intentions: It helps the (potentially new) maintainer to tap into the experience -of people on the list, and lets them know if any one else is working +of people on the list, and lets them know if anyone else is working on it already. It lets other people thinking about working on the package know that -there already is a volunteer, and efforts may be shared. The ``intent -to package'' message to It lets the rest of the maintainers know more about the package than -the one line description and the changelog entry ``Initial version'' -that generally gets posted to debian-devel-changes. It is helpful to the people who live off unstable (and form our first -line of testers); we should encourage these people. +line of testers). We should encourage these people. The announcements give maintainers and other interested parties a better feel of what is going on, and what is new, in the project. + + Uploading a package 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 archive maintainers for its handling. This is usually generated by -dpkg-genchanges during the normal package build process.

The changes file is a control file with the following fields:

- - +&control-file-fields;

All of these fields are mandatory for a Debian upload. See the list -of control fields in the for the contents of these fields. -Only the for the contents of these fields. You can close +bugs automatically using the Description field, see . Only the Distribution field is +discussed in this section, since it relates to the archive maintenance +policies. + Picking a distribution

-Notably, the Distribution field, which originates from the debian/changelog file, indicates which distribution the package is intended for. There are four possible values for this field: `stable', `unstable', `frozen', or `experimental'; these values -can also be combined. For instance, if you have a crucial security -fix release of a package, and the package has not diverged between the -changelog's for more information on when to upload to -frozen, you would set the +distribution to `frozen unstable'. (See for +more information on when to upload to frozen.) Note that it +never makes sense to combine the experimental distribution with +anything else. +

+You should avoid combining `stable' with others because of potential +problems with library dependencies (for your package and for the package +built by the build daemons for other architecture). +Also note that setting the distribution to `stable' means that the package will be placed into the proposed-updates -directory of the Debian archive for further testing before it is -actually included in stable. The Release Team (which can be reached at +&email-debian-release;) will decide if your package can be included in +stable, therefore if your changelog entry is not clear enough, you may +want to explain them why you uploaded your package to stable by sending +them a short explication.

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 +files, and will not need to be re-uploaded.

-By default dpkg-genchanges and +dpkg-buildpackage will include the original source tar +file if and only if the Debian revision part of the source version +number is 0 or 1, indicating a new upstream version. This behaviour +may be modified by using -sa to always include it or +-sd to always leave it out.

-If no original source is included in the upload then the original -source tar-file used by Uploading to dpkg-source when constructing the +.dsc file and diff to be uploaded must be +byte-for-byte identical with the one already in the archive. If there +is some reason why this is not the case, the new version of the +original source should be uploaded, possibly by using the -sa +flag. + + Uploading to frozen

The Debian freeze is a crucial time for Debian. It is our chance to synchronize and stabilize our distribution as a whole. Therefore, -care must be taken when uploading to frozen.

It is tempting to always try to get the newest release of software into the release. However, it's much more important that the system as a whole is stable and works as expected.

-The watchword for uploading to no new +The watchword for uploading to frozen is no new code. This is a difficult thing to quantify, so here are some guidelines:

-Fixes for bugs of severity critical, grave, or +serious severity are always allowed for those packages that must exist in the final release -critical, grave, and serious bug fixes are +allowed for non-necessary packages but only if they don't add any new +features -normal bug fixes are allowed (though discouraged) on all packages if -and only if there are no new features +important, normal and minor bug fixes are allowed (though discouraged) +on all packages if and only if there are no new features wishlist fixes are not allowed (they are, after all, not really bugs) @@ -870,192 +1016,220 @@ documentation bug fixes are allowed, since good documentation is important

-Remember, there is statistically a 15% chance that every bug fix will -introduce a new bug. The introduction and discovery of new bugs -either delays release or weakens the final product. There is little -correlation between the severity of the original bug and the severity -of the introduced bug. +Experience has shown that there is statistically a 15% chance that +every bug fix will introduce a new bug. The introduction and +discovery of new bugs either delays release or weakens the final +product. There is little correlation between the severity of the +original bug fixed and the severity of the bug newly introduced by the +fix. Checking the package prior to upload

-Before you upload your package, you should do basic testing on it. -Make sure you try the following activities (you'll need to have an -older version of the Debian package around). +Before you upload your package, you should do basic testing on it. At +a minimum, you should try the following activities (you'll need to +have an older version of the same Debian package around): Install the package and make sure the software works, or upgrade the package from an older version to your new version if a Debian package for it already exists. -Run lintian -v package-version.changes. This will -check the source package as well as the binary package. If you don't -understand the output that lintian over the package. You can run +lintian as follows: lintian -v +package-version.changes. This will check the source +package as well as the binary package. If you don't understand the +output that lintian generates, try adding the -i +switch, which will cause lintian to output a very verbose +description of the problem.

-Normally, a package should not be uploaded if it causes lintian +to emit errors (they will start with E).

-For more information on . +For more information on lintian, see . Downgrade the package to the previous version (if one exists) -- this -tests the postrm and prerm scripts. Remove the package, then reinstall it. - Uploading to Uploading to ftp-master

To upload a package, you need a personal account on -master.debian.org. All maintainers should already -have this account, see . You can use either -/home/Debian/ftp/private/project/Incoming. (You -cannot upload to Incoming on master using anonymous FTP -- you must -use your user-name and password.) +ftp-master.debian.org, which you should have as an +official maintainer. If you use scp or rsync +to transfer the files, place them into &us-upload-dir;; +if you use anonymous FTP to upload, place them into +/pub/UploadQueue/.

-Note: Do not upload to ftp-master packages +containing software that is export-controlled by the United States +government, nor to the overseas upload queues on chiark or +erlangen. This prohibition covers almost all cryptographic +software, and even sometimes software that contains ``hooks'' to +cryptographic software, such as electronic mail readers that support +PGP encryption and authentication. Uploads of such software should go +to non-us (see ). If you are not +sure whether U.S. export controls apply to your package, post a +message to &email-debian-devel; and ask.

-You may also find the Debian package and for more information. - +You may also find the Debian package dupload useful +when uploading packages. This handy program is distributed with +defaults for uploading via ftp to ftp-master, +chiark, and erlangen. It 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 - Uploads via Uploading to non-us (pandora) +

+As discussed above, export controlled software should not be uploaded +to ftp-master. Instead, use scp or non-anonymous +FTP to copy the package to non-us.debian.org, placing +the files in &non-us-upload-dir;. By default, you can +use the same account/password that works on ftp-master.

-If you have a slow network connection to ftp.chiark.greenend.org.uk using anonymous FTP -and read -/pub/debian/private/project/README.how-to-upload. +The program dupload comes with support for uploading to +non-us; please refer to the documentation that comes with +the program for details.

-ftp-master, +with: +dinstall -n foo.changes + + 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 +upload queue in Europe on chiark. For details connect to +. +

+Note: Do not upload packages containing software that is export-controlled by the United States government to the queue on - applies here as well. +chiark. Since this upload queue goes to ftp-master, the +prescription found in applies here as well.

-The program dupload comes with support for uploading to +chiark; please refer to the documentation that comes with the +program for details. - Uploads via Uploads via erlangen

-Another cron-driven upload queue is available in Germany: just upload -the files via anonymous FTP to . +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 +PGP-signed 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 +your e-mail address. The address found there is used for all +replies, just as on ftp-master.

There's no need to move your files into a second directory after the -upload as on chiark. And, in any case, you should get a +mail reply from the queue daemon explaining what happened to your +upload. Hopefully it should have been moved to ftp-master, but in +case of errors you're notified, too.

-Note: Do not upload packages containing software that is export-controlled by the United States government to the queue on - applies here as well. +erlangen. Since this upload queue goes to ftp-master, the +prescription found in applies here as well.

-The program dupload comes with support for uploading to +erlangen; please refer to the documentation that comes with +the program for details. - Uploading to the non-us server + Other Upload Queues +

+Another upload queue is available which is based in the US, and is a +good backup when there are problems reaching ftp-master. You can +upload files, just as in erlangen, to .

-To upload a package to the . Note, that -the .changes file must have a valid PGP signature from one of -the keys of the developers key-ring. +An upload queue is available in Japan: just upload the files via +anonymous FTP to . + Announcing package uploads

-When a package is uploaded an announcement should be posted to one of -the ``debian-changes'' lists. The announcement should give the (source) -package name and version number, and a very short summary of the -changes, in the -If a package is released with the dpkg-dev (>= 1.4.1.2). The mail generated by +the archive maintenance software will contain the PGP/GPG signed +.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 +``dinstall_runs''). +

+If a package is released with the Distribution: set to +`stable', the announcement is sent to &email-debian-changes;. If a +package is released with Distribution: set to `unstable', +`experimental', or `frozen' (when present), the announcement will be +posted to &email-debian-devel-changes; instead.

On occasion, it is necessary to upload a package to both the -stable and unstable distributions; this is done by +putting both distributions in the Distribution: line. In +such a case the upload announcement will go to both of the above +mailing lists.

-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 + + Notification that a new package has been installed

The Debian archive maintainers are responsible for handling package uploads. For the most part, uploads are automatically handled on a -daily basis by an archive maintenance tool called -In any case, you will receive notification indicating that the package -has been uploaded via email. Please examine this notification +daily basis by archive maintenance tools `dak' +(also referred to as katie or dinstall). +Specifically, updates to existing packages to +the `unstable' distribution are handled automatically. In other cases, +notably new packages, placing the uploaded package into the +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 been uploaded. Please examine this notification carefully. You may notice that the package didn't go into the section you thought you set it to go into. Read on for why. The override file

-The debian/control file's debian/control file are -actually just hints. +The debian/control file's Section and +Priority fields do not actually specify where the file will +be placed in the archive, nor its priority. In order to retain the +overall integrity of the archive, it is the archive maintainers who +have control over these fields. The values in the +debian/control file are actually just hints.

The archive maintainers keep track of the canonical sections and -priorities for packages in the control file is not going to work. Instead, you should email -override file. Sometimes the +override file needs correcting. Simply changing the +package's control file is not going to work. Instead, +you should email &email-override; or submit a bug against +ftp.debian.org.

-For more information about , -/usr/doc/debian/bug-log-mailserver.txt, and -/usr/doc/debian/bug-maint-info.txt. +For more information about override files, see , &file-bts-mailing;, and +&file-bts-info;. @@ -1084,9 +1258,9 @@ and ``source NMU''. These terms are used with specific technical meaning throughout this document. Both binary and source NMUs are similar, since they involve an upload of a package by a developer who is not the official maintainer of that package. That is why it's a -non-maintainer upload.

-A source NMU is a upload of a package by a developer who is not the +A source NMU is an upload of a package by a developer who is not the official maintainer, for the purposes of fixing a bug in the package. Source NMUs always involves changes to the source (even if it is just a change to debian/changelog). This can be either a change @@ -1094,7 +1268,7 @@ to the upstream source, or a change to the Debian bits of the source.

A binary NMU is a recompilation and upload of a binary package for a new architecture. As such, it is usually part of a porting effort. A -binary NMU is non-maintainer uploaded binary version of a package +binary NMU is a non-maintainer uploaded binary version of a package (often for another architecture), with no source changes required. There are many cases where porters must fix problems in the source in order to get them to compile for their target architecture; that would @@ -1128,7 +1302,7 @@ slightly different rules than non-porters, due to their unique circumstances (see ).

Only critical changes or security bug fixes make it into stable. When -a security bug is detected a fixed package should be uploaded as soon +a security bug is detected, a fixed package should be uploaded as soon as possible. In this case, the Debian Security Managers should 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 @@ -1137,7 +1311,7 @@ cannot be reached in time, the Security Manager may upload a fixed package (i.e., do a source NMU).

During the release freeze (see ), NMUs which -fix important or higher severity bugs are encouraged and accepted. +fix serious or higher severity bugs are encouraged and accepted. Even during this window, however, you should endeavor to reach the current maintainer of the package; they might be just about to upload a fix for the problem. As with any source NMU, the guidelines found @@ -1189,7 +1363,7 @@ 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 not be made in a non-maintainer upload. @@ -1200,31 +1374,31 @@ the version number needs to change. This enables our packing system to function.

If you are doing a non-maintainer upload (NMU), you should add a new -minor version number to the foo_1.1-3.dsc. 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 -foo_1.1-3.1.dsc. +minor version number to the debian-revision part of the +version number (the portion after the last hyphen). This extra minor +number will start at `1'. For example, consider the package `foo', +which is at version 1.1-3. In the archive, the source package control +file would be foo_1.1-3.dsc. 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 foo_1.1-3.1.dsc.

The Debian revision minor number is needed to avoid stealing one of the package maintainer's version numbers, which might disrupt their work. It also has the benefit of making it visually clear that a package in the archive was not made by the official maintainer.

-If there is no dpkg-buildpackage with the debian-revision component in the version +number then one should be created, starting at `0.1'. If it is +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').

Remember, porters who are simply recompiling a package for a different architecture do not need to renumber. Porters should use new version @@ -1233,52 +1407,54 @@ in some way, i.e., if they are doing a source NMU and not a binary NMU. - Source NMUs must have a new changelog entry + + Source NMUs must have a new changelog entry

A non-maintainer 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 non-maintainer's email address in the log entry and the NMU version -number in it. +number in it.

By convention, source NMU changelog entries start with the line * Non-maintainer upload - +

Source NMUs and the Bug Tracking System

Maintainers other than the official package maintainer should make as few changes to the package as possible, and they should always send a -patch as a unified context diff (diff -u) detailing their changes to the Bug Tracking System.

What if you are simply recompiling the package? In this case, the process is different for porters than it is for non-porters, as mentioned above. If you are not a porter and are doing an NMU that simply requires a recompile (i.e., a new shared library is available -to be linked against, a bug was fixed in debhelper), there must still be a changelog entry; +therefore, there will be a patch. If you are a porter, you are +probably just doing a binary NMU. (Note: this leaves out in the cold +porters who have to do recompiles -- chalk it up as a weakness in how +we maintain our archive.)

If the source NMU (non-maintainer upload) fixes some existing bugs, the bugs in the Bug Tracking System which are fixed need to be -notified but not actually closed by the +non-maintainer. Technically, only the official package maintainer or +the original bug submitter are allowed to close bugs. However, the +person making the non-maintainer release must send a short message to +the relevant bugs explaining that the bugs have been fixed by the NMU. +Using control@bugs.debian.org, the party doing the NMU +should also set the severity of the bugs fixed in the NMU to `fixed'. +This ensures that everyone knows that the bug was fixed in an NMU; +however the bug is left open until the changes in the NMU are +incorporated officially into the package by the official package +maintainer. Also, open a bug with the patches needed to fix the +problem, or make sure that one of the other (already open) bugs has +the patches.

The normal maintainer will either apply the patch or employ an alternate method of fixing the problem. Sometimes bugs are fixed @@ -1288,8 +1464,8 @@ 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.

-In addition, the normal maintainer should always retain the +entry in the changelog file documenting the non-maintainer upload. Building source NMUs @@ -1300,10 +1476,10 @@ same rules as found in . Just as described in fact, all the prescriptions from apply, including the need to announce the NMU to the proper lists.

-Make sure you do debian/control file. Your name from the NMU entry of the -debian/changelog file will be used for signing the changes -file. +Make sure you do not change the value of the maintainer in +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. @@ -1316,19 +1492,19 @@ is part of your duty as a maintainer to be aware of issues of portability. Therefore, even if you are not a porter, you should read most of this chapter.

-Porting is the act of building Debian packages for architectures which +Porting is the act of building Debian packages for architectures that is different from the original architecture of the package maintainer's binary package. It is a unique and essential activity. In fact, porters do most of the actual compiling of Debian packages. -For instance, for one x86 binary package, there has to be a -recompile for each architecture, which is around five more builds. +For instance, for a single i386 binary package, there must be a +recompile for each architecture, which is amounts to five more builds. Being Kind to Porters

Porters have a difficult and unique task, since they are required to deal with a large volume of packages. Ideally, every source package -should build right out of the box; unfortunately, this is often not +should build right out of the box. Unfortunately, this is often not the case. This section contains a checklist of ``gotchas'' often committed by Debian maintainers -- common problems which often stymie porters, and make their jobs unnecessarily more difficult. @@ -1346,17 +1522,15 @@ of things you should check or be aware of. Don't set architecture to a value other than ``all'' or ``any'' unless you really mean it. In too many cases, maintainers don't follow the -instructions in the . Setting your architecture to ``x86'' -is usually incorrect. +instructions in the . 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. -Make sure you don't ship your binary package with the +Make sure you don't ship your source package with the debian/files or debian/substvars files. They should be removed by the `clean' target of debian/rules. @@ -1367,11 +1541,17 @@ or programs. For instance, you should never be calling programs in be setup in a special way. Try building your package on another machine, even if it's the same architecture. -Don't depend on the package your building already being installed (a +Don't depend on the package you're building already being installed (a sub-case of the above issue). Don't rely on egcc being available; don't rely on gcc being a certain version. + +Make sure your debian/rules contains separate ``binary-arch'' and +``binary-indep'' targets, as the Debian Packaging Manual requires. +Make sure that both targets work independently, that is, that you can +call the target without having called the other before. To test this, +try to run dpkg-buildpackage -b. @@ -1389,11 +1569,21 @@ In a binary NMU, no real changes are being made to the source. You do not need to touch any of the files in the source package. This includes debian/changelog.

-The way to invoke dpkg-buildpackage --B -m. Of course, set debian/rules. +Sometimes you need to recompile a package against other packages +which have been updated, such as libraries. You do have to bump the +version number in this case, so that the upgrade system can function +properly. Even so, these are considered binary-only NMUs -- there is +no need in this case for all architectures to recompile. You should +set the version number as in the case of NMU versioning, but add a +``.0.'' before the the NMU version. For instance, a recompile-only +NMU of the source package ``foo_1.3-1'' would be numbered +``foo_1.3-1.0.1''. +

+The way to invoke dpkg-buildpackage is as +dpkg-buildpackage -B -mporter-email. Of course, +set porter-email to your email address. This will do a +binary-only build of only the architecture-dependant portions of the +package, using the `binary-arch' target in debian/rules. @@ -1408,7 +1598,7 @@ packages. Again, the situation varies depending on the distribution they are uploading to. Crucial fixes (i.e., changes need to get a source package to compile for a released-targeted architecture) can be -uploaded with no waiting period for the `frozen' distribution.

However, if you are a porter doing an NMU for `unstable', the above guidelines for porting should be followed, with two variations. @@ -1420,7 +1610,7 @@ the porting effort, at the discretion of the porter group. (Remember, none of this is Policy, just mutually agreed upon guidelines.)

Secondly, porters doing source NMUs should make sure that the bug they -submit to the BTS should be of severity `important' or greater. This +submit to the BTS should be of severity `serious' or greater. This ensures that a single source package can be used to compile every supported Debian architecture by release time. It is very important that we have one version of the binary and source package for all @@ -1450,26 +1640,35 @@ documentation or references for full information. quinn-diff

-quinn-diff is used to locate the differences from +one architecture to another. For instance, it could tell you which +packages need to be ported for architecture Y, based on +architecture X. buildd

-buildd system is used as a distributed, +client-server build distribution system. It is usually used in +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.

-The buildd is not yet available as a package; however, +most porting efforts are either using it currently or planning to use +it in the near future. It collects a number of as yet unpackaged +components which are currently very useful and in use continually, +such as andrea, sbuild and +wanna-build. +

+Some of the data produced by buildd which is +generally useful to porters is available on the web at . This data includes nightly updated information +from andrea (source dependencies) and +quinn-diff (packages needing recompilation).

We are very excited about this system, since it potentially has so many uses. Independent development groups can use the system for @@ -1491,8 +1690,9 @@ enhanced to support cross-compiling. - Moving, Removing, Renaming, - Adopting, and Orphaning Packages + + Moving, Removing, Renaming, Adopting, and Orphaning + Packages

Some archive manipulation operation are not automated in the Debian upload process. These procedures should be manually followed by @@ -1501,83 +1701,89 @@ cases. Moving packages

-Sometimes a package will change either its section or its subsection. -For instance, a package from the `non-free' section might be GPL'd in -a later version; in this case you should consider moving it to `main' -or `contrib' (see the for guidelines). -

-In this case, it is sufficient to edit the package control information -normally and re-upload the package (see the for -details). Carefully examine the installation log sent to you when the -package is installed into the archive. If for some reason the old -location of the package remains, file a bug against -Removing packages +Sometimes a package will change its section. For instance, a +package from the `non-free' section might be GPL'd in a later version, +in which case, the package should be moved to `main' or +`contrib'. See the for guidelines on what section a package +belongs in. + +

+If you need to change the section for one of your packages, change the +package control information to place the package in the desired +section, and re-upload the package (see the for details). Carefully examine the +installation log sent to you when the package is installed into the +archive. If for some reason the old location of the package remains, +file a bug against ftp.debian.org asking that the old +location be removed. Give details on what you did, since it might be +a bug in the archive maintenance software. +

+If, on the other hand, you need to change the subsection of +one of your packages (e.g., ``devel'', ``admin''), the procedure is +slightly different. Correct the subsection as found in the control +file of the package, and reupload that. Also, you'll need to get the +override file updated, as described in . + + + Removing packages

If for some reason you want to completely remove a package (say, if it is an old compatibility library which is not longer required), you -need to file a bug against ftp.debian.org asking that the package be removed. Make sure you indicate which distribution the package should be removed from.

If in doubt concerning whether a package is disposable, email -apt-cache program from the apt package. When invoked as apt-cache showpkg -/var/cache/apt/pkgcache.bin , the program will show -details for package, the program will show details for +package, including reverse depends. - Removing packages from Removing packages from Incoming

-If you decide to remove a package from Incoming, it is nice +but not required to send a notification of that to the appropriate +announce list (either &email-debian-changes; or +&email-debian-devel-changes;). Replacing or renaming packages

Sometimes you made a mistake naming the package and you need to rename it. In this case, you need to follow a two-step process. First, set your debian/control file to replace and conflict with the -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. - - Orphaning a package

-If you can no longer maintain a package, then you should set the -package maintainer to Debian QA Group -<debian-qa@lists.debian.org> and email -Debian QA Group +<debian-qa@lists.debian.org> and submit a bug report +against the pseudo package wnpp. The bug report should be +titled O: package -- short description +indicating that the package is now orphaned. The severity of the bug +should be set to normal. If the package is especially +crucial to Debian, you should instead submit a bug against +wnpp and title it RFA: package -- short +description and set its severity to important. You +should also email &email-debian-devel; asking for a new maintainer. +

+Read instructions on the +for more information. Adopting a package

-Periodically, a listing of packages in need of new maintainers will be -sent to list. This list -is also available at in the Work-Needing and Prospective Packages -document (WNPP), -and at . -If you wish to take over maintenance of any of the packages listed in -the WNPP, or if you can no longer maintain a packages you have, or you -simply want to know if any one is working on a new package, send a -message to . If you wish to take over maintenance of any of the +packages listed in the WNPP, please take a look at the aforementioned +page for information and procedures.

It is not OK to simply take over a package that you feel is neglected -- that would be package hijacking. You can, of course, contact the @@ -1585,15 +1791,14 @@ 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 - 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. @@ -1604,15 +1809,14 @@ right away. Monitoring bugs

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. + for your +packages. The BTS contains all the open bugs against your packages.

Maintainers interact with the BTS via email addresses at -, or, if you have -installed the /usr/doc/debian/bug-*. +bugs.debian.org. Documentation on available commands can be +found at , or, if you have installed the +doc-debian package, you can look at the local files +/usr/doc/debian/bug-*.

Some find it useful to get periodic reports on open bugs. You can add a cron job such as the following if you want to get a weekly email @@ -1624,12 +1828,12 @@ outlining all the open bugs against your packages: Replace maintainer-address with you official Debian maintainer address. - Submitting Bugs + Submitting Bugs

Often as a package maintainer, you find bugs in other packages or else have bugs reported to your packages which need to be reassigned. The -BTS can tell you how to do this. + can tell you how +to do this.

We encourage you to file bugs when there are problems. Try to submit the bug from a normal user account at which you are likely to receive @@ -1640,22 +1844,21 @@ good job reporting a bug and redirecting it to the proper location. For extra credit, you can go through other packages, merging bugs which are reported more than once, or setting bug severities to `fixed' when they have already been fixed. Note that when you are -neither the bug submitter nor the package maintainer, you are should +neither the bug submitter nor the package maintainer, you should not actually close the bug (unless you secure permission from the maintainer). Responding to Bugs

Make sure that any discussions you have about bugs are sent both to -the original submitter of the bug, and the bug itself (i.e., +the original submitter of the bug, and the bug itself (e.g., 123@bugs.debian.org).

You should never close bugs via the bug server `close' -command sent to control@bugs.debian.org. If you do so, -the original submitter will not receive any feedback on why the bug -was closed. +command sent to &email-bts-control;. If you do so, the original +submitter will not receive any feedback on why the bug was closed. - When bugs are closed by new uploads + When bugs are closed by new uploads

If you fix a bug in your packages, it is your responsibility as the package maintainer to close the bug when it has been fixed. However, @@ -1664,21 +1867,43 @@ been accepted into the Debian archive. Therefore, once you get notification that your updated package has been installed into the archive, you can and should close the bug in the BTS.

-Again, see the BTS documentation for details on how to do this. -Often, it is sufficient to mail the dpkg-dev and you do +your changelog entry properly, the archive maintenance software will close +the bugs automatically. All you have to do is follow a certain syntax in +your debian/changelog file: + +acme-cannon (3.1415) unstable; urgency=low + + * Frobbed with options (closes: Bug#98339) + * Added safety to prevent operator dismemberment, closes: bug#98765, + bug#98713, #98714. + * Added manpage. Closes: #98725. + + +Technically speaking, the following Perl regular expression is what is +used: + + /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig + + +The author prefers the (closes: Bug#XXX) syntax, +since it stands out from the rest of the changelog entries. +

+If you want to close bugs the old fashioned, manual way, it is usually +sufficient to mail the .changes file to +XXX-done@bugs.debian.org, where XXX is your +bug number. Lintian reports

-You should periodically get the new . -That report, which is updated automatically, contains lintian from +`unstable' and check over all your packages. Alternatively you can +check for your maintainer email address at the . That report, which is updated +automatically, contains lintian reports against the +latest version of the distribution (usually from 'unstable') using the +latest lintian. Reporting lots of bugs at once @@ -1687,20 +1912,20 @@ Reporting a great number of bugs for the same problem on a great 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 +is emitted.

If you report more than 10 bugs on the same topic at once, it is -recommended that you send a message to - Note that when sending lots of bugs on the same subject, you should -send the bug report to maintonly@bugs.debian.org so +that the bug report is not forwarded to the bug distribution mailing +list. Overview of Debian Maintainer Tools @@ -1722,78 +1947,115 @@ the package documentation itself. - dpkg-dev

-dpkg-dev contains the tools (including +dpkg-source) required to unpack, build and upload Debian +source packages. These utilities contain the fundamental, low-level functionality required to create and manipulated packages; as such, they are required for any Debian maintainer. - lintian

-Lintian dissects Debian packages and reports bugs +and policy violations. It contains automated checks for many aspects +of Debian policy as well as some checks for common errors. The use of +lintian has already been discussed in and . + + debconf +

+debconf provides a consistent interface to +configuring packages interactively. It is user interface +intedependant, allowing end-users to configure packages with a +text-only interface, an HTML interface, or a dialog interface. New +interfaces can be added modularly. +

+Many feel that this system should be used for all packages requiring +interactive configuration. debconf is not +currently required by Debian Policy, however, that may change in the +future. + + - debhelper

-debian/rules to automate common tasks related to building -binary Debian packages. Programs are included to install various files -into your package, compress files, fix file permissions, integrate -your package with the Debian menu system. +debhelper is a collection of programs that can be +used in debian/rules to automate common tasks related to +building binary Debian packages. Programs are included to install +various files into your package, compress files, fix file permissions, +integrate your package with the Debian menu system.

-Unlike debmake, debhelper is +broken into several small, granular commands which act in a consistent +manner. As such, it allows a greater granularity of control than +debmake. - debmake

-debian/rules assistant. It includes two main -programs: deb-make, which can be used to help a -maintainer convert a regular (non-Debian) source archive into a Debian -source package; and debstd, which incorporates in one big -shot the same sort of automated functions that one finds in -debmake, a pre-cursor to +debhelper, is a less granular +debian/rules assistant. It includes two main programs: +deb-make, which can be used to help a maintainer convert +a regular (non-Debian) source archive into a Debian source package; +and debstd, which incorporates in one big shot the same +sort of automated functions that one finds in +debhelper.

The consensus is that debmake is now deprecated in favor of debhelper. However, it's not a bug to use debmake. + + yada +

+yada is a new packaging helper tool with a slightly +different philosophy. It uses a debian/packages file to +auto-generate other necessary files in the debian/ +subdirectory. +

+Note that yada is still quite new and possibly not +yet as robust as other systems. + + + + equivs +

+equivs is another package for making packages. It +is often suggested for local use if you need to make a package simply +to fulfill dependencies. It is also sometimes used when making +``meta-packages'', which are packages whose only purpose is to depend +on other packages. + - cvs-buildpackage

-cvs-buildpackage provides the capability to inject +or import Debian source packages into a CVS repository, build a Debian package from the CVS repository, and helps in integrating upstream changes into the repository.

These utilities provide an infrastructure to facilitate the use of CVS by Debian maintainers. This allows one to keep separate CVS branches -of a package for stable, unstable, and possibly +experimental distributions, along with the other benefits of +a version control system. dupload

-dupload is a package and a script to automagically +upload Debian packages to the Debian archive, to log the upload, and +to send mail about the upload of a package. You can configure it for +new upload locations or methods. @@ -1804,9 +2066,6 @@ you to build packages without being root (packages usually want to install files with root ownership). If you have fakeroot installed, you can say, i.e., dpkg-buildpackage -rfakeroot as a user. -

-Note that fakeroot is being replaced by -libtool in ``potato''. @@ -1816,10 +2075,18 @@ Note that fakeroot is being replaced by and tools which you may find helpful for maintaining your Debian packages. Example scripts include debchange, which will manipulate your debian/changelog file from the -command-line, and build, which is a wrapper around +command-line, and debuild, which is a wrapper around dpkg-buildpackage. - + + + debget +

+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. + +