X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=eeb6a26fe64791e71ed43bbd038dc2c8fb1165a8;hb=5d8e1f03f84c3398bd6a0d3116292df347e3ffed;hp=4921045618f60dd3b51e642530e25d15306b453b;hpb=773091507a161b580f7065006938a2f167ea23cc;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index 4921045..eeb6a26 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -6,9 +6,10 @@ @@ -42,112 +43,180 @@ writing to the Free Software Foundation, Inc., 59 Temple Place - Suite - Applying to Become a Maintainer + Scope of This Document +

+The purpose of this document is to provide an overview of the +processes and resources used by Debian developers. +

+The processes discussed within include how to become a maintainer +(); how to upload new packages (); how and when to do interim releases of other +maintainer's packages (); how to move, remove, or orphan +packages (); and how to handle bug reports +(). +

+The resources discussed in this reference include the mailing lists +and servers (); a discussion of the structure of the +Debian archive (); explanation of the different +servers which accept package uploads (); and a +discussion of resources which an help maintainers with the quality of +their packages (). +

+It should be clear that this reference does not discuss the details of +the Debian package or how to generate Debian packages; that is +discussed in the . Nor is this reference intended to +give details on standards for how Debian software must behave, which +is documented in the . + + + Applying to Become a Maintainer Getting started

So, you've read all the documentation, you understand what everything in the -Firstly, subscribe to .

You should subscribe and lurk for a bit before doing any coding, and you should post about your intentions to work on something to avoid duplicated effort.

-If you do not have a PGP key yet generate one. You should probably -read the PGP manual, as it has much important information which is +Another good list to subscribe to is + for +details. The IRC channel Registering as a Debian developer +

+Before you decide to work in the Debian Project you have to read the +. Registering as a developer means that you agree with and +pledge to uphold the Debian Social Contract; it is very important that +maintainers are in accord with the essential ideas behind Debian +GNU/Linux. Reading the would +also be a good idea. +

+The process of registering as a developer is a process of verifying +your identity and intentions. As the number of people working on +Debian GNU/Linux has grown to over 400 people and our systems are used +in several very important places we have to be careful about being +compromised. Therefore, we need to verify new maintainers before we +can give them accounts on our servers and letting them upload +packages. +

+Registration requires that the following information be sent to + + +Your name. + +Your preferred login name on Can anyone clarify for me why logins on master +cannot be eight characters? ), as well as the email address +at which you'd prefer to be subscribed to +debian.org address). + +A phone number where we can call you. + +A statement of intention, that is, what package(s) you intend to work +on, which Debian port you will be assisting, or how you intend to +contribute to Debian. + +A statement that you have read and agree to uphold the . + +Some mechanism by which we can verify your real-life identity. For +example, any of the following mechanisms would suffice: + + +A PGP key signed by any well-known signature, such as: + + +Any current Debian developer you have met +Any formal certification service (such as Verisign, etc.) that +verifies your identity. A certification that verifies your email +address, and not you identity, is not sufficient. + + +Alternatively, you may identify yourself with a scanned (or physically +mailed) copy of any formal documents certifying your identity (such as +a birth certificate, national ID card, U.S. Driver's License, etc.). +If emailed, please sign the mail with your PGP key. + + +If you do not have a PGP key yet, generate one. Every developer needs +a PGP key in order to sign and verify package uploads. You should read +the PGP manual, since it has much important information which is critical to its security. Many more security failures are due to human error than to software failure or high-powered spy techniques.

+Your PGP key must be at least 1024 bits long. There is no reason to +use a smaller key, and doing so would be much less secure. Your key +must be signed with at least your own user ID. This prevents user ID +tampering. You can do it by executing `pgp -ks +'. +

+If your PGP key isn't on public PGP key servers such as +pgp.net, please read the documentation available locally +/usr/doc/pgp/keyserv.doc. That document contains +instructions on how to put your key on the public keyservers. +

Due to export restrictions by the United States government some Debian packages, including PGP, have been moved to an ftp site outside of the United States. You can find the current locations of those packages on -/pub/debian/README.non-US -file. +/pub/debian/README.non-US file.

If you live in a country where use of cryptography even for authentication is forbidden then please contact us so we can make special arrangements. This does not apply in France, where I believe only encryption and not authentication is forbidden.

- - Registering as a Debian developer -

-Before you decide to work in the Debian Project you have to read the -. -

-After that, you should send a message to - -The message should say what you've done and who you are, and should -ask for an account on master and to be subscribed to debian-private -(the developers-only mailing list). It should contain your PGP or RSA -public key (extracted using `pgp -kxa', in the case of PGP) for the -database of keys which is distributed on the FTP server -(doc/debian-keyring.tar.gz). Please be sure to sign your -request message with your chosen PGP or RSA key. In addition, you have -to mention that you've read the ``Debian Social Contract'' (see above) -and you are expected to know where to find the ``Debian Policy -Manual'' and the ``Debian Packaging Manual.'' -

-Please be sure to include your preferred login name on master (seven -characters or less), as well as the E-mail address at which you'd -prefer to be subscribed to debian-private (typically this will be -either your primary mail address or your new debian.org address). -

-You should also include some mechanism by which we can verify your -real-life identity. For example, any of the following mechanisms -would suffice: - - -A PGP or RSA key signed by any well-known signature, such as any -current Debian developer. - -A scanned (or physically mailed) copy of any formal documents -certifying your identity (such as a birth certificate, national ID -card, U.S. Driver's License, etc.). Please sign the image with your -PGP or RSA key. - - -The following mechanisms are discouraged, but are acceptable if -neither of the first two mechanisms is practical: - - -A pointer to a phone listing at which you could be reached (at our -expense). This phone listing should be verifiable independently -through external means such as a national directory-listing service or -other authoritative source. - -Any other mechanism by which you can establish your real-life identity -with reasonable certainty. - - -We're sorry about the inconvenience of requiring proof of identity, -but for the moment, such measures are unfortunately the only way we -can ensure the security and reliability of our distribution. +Once you have all your information ready, and your public key is +available on public key servers, send a message to +pgp +-kxa in the case of PGP; note that /pub/debian/doc/debian-keyring.tar.gz, or the +debian-keyring package). Please be sure to sign your +request message with your chosen PGP or RSA key.

Once this information is received and processed, you should be contacted with information about your new Debian maintainer account. -If you don't hear anything within 7-10 days, please re-send your +If you don't hear anything within 7-14 days, please re-send your original message--the new-maintainer volunteers are typically overworked, and mistakes do occasionally happen. - Debian Mentors + Debian Mentors

-There is a mailing list called -Every new developer is invited to subscribe to that list (see for details).

Those who prefer one-on-one help (e.g., via private emails) should @@ -155,15 +224,20 @@ also post to that list and an experienced developer will volunteer to help. - Internet Servers + Mailing Lists and Servers Mailing lists

The mailing list server is at , or locally in +/usr/doc/debian/mailing-lists.txt if you have the +doc-debian package installed.

When replying to messages on the mailing list, please do not send a carbon copy ( In addition, all messages should usually only be sent to one of the -following mailing lists: . Cross-posting is +discouraged. +

+ As ever on the net, please trim down the quoting of articles you're replying to. In general, please adhere to the usual conventions for posting messages. +

+Online archives of mailing lists are available at . The master server

+The master server, . All Debian +developers have accounts on this machine. The FTP servers

@@ -189,12 +284,12 @@ posting messages.

- The Debian Archive + The Debian Archive Overview

The Debian GNU/Linux distribution consists of a lot of Debian packages -( Here is an example directory tree of a complete Debian distribution: @@ -244,39 +339,44 @@ installing the Debian distribution on a specific architecture (disks-i386, disks-m68k, etc.).

The Sections

-The main section is what makes up the Debian GNU/Linux +The main section is what makes up the Debian GNU/Linux distribution. This is because the packages in the other two -sections do not fully comply with all our guidelines. +sections do not fully comply with all our guidelines. As such, they +are not officially part of Debian.

For example, every package in the main distribution must fully comply -with the Debian Free Software Guidelines (DFSG) and with all -other policy requirements as described in the Debian Policy -Manual. (The DFSG is our definition of ``free software.'' Check -out the Debian Policy Manual for details.) +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.)

The packages which do not apply to the DFSG are placed in the -non-free section. These packages are not considered as part of + -Packages in the contrib section have to apply to the DFSG, but -fail other requirements. +Packages in the -(The Debian Policy Manual contains a more exact definition of the -three sections. This is just meant to be an introduction.) +(The contains a more exact definition of the three +sections. This is just meant to be 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 - On the other hand, a CD-ROM vendor could easily check the individual package licenses of the packages in Debian GNU/Linux 1.3 is only available for Intel platforms. Debian -2.0 supports Intel and m68k architectures. +2.0 supports Intel and m68k architectures. The next version of Debian +is likely to also support Alpha, PPC, and Sparc architectures, if not +more. - Sub sections + Subsections

The sections Packages @@ -334,49 +441,88 @@ checksums (md5sums) and some additional info about the package If you have a look at the Debian FTP server or one of its mirrors, you'll discover that there is one additional directory level on top of the directory tree, as described in the previous chapter. These -directories are the Stable, unstable, and sometimes frozen

-There is always a distribution called dists/stable) and one called dists/unstable. This reflects the development process of the +Debian project.

The ``development'' is done in the -After about two months of development, the -After another month or a little longer, the -This development cycle is based on the assumption, that the once -`unstable' distribution finally becomes `stable' after passing one -month of testing. Unfortunately, a few bugs still remain--that's why -the stable distribution is updated every few weeks. However, these +fixes. (That's why it's called ``frozen.'') After another month or a +little longer, the +This development cycle is based on the assumption that the + Note, that development is continued during the ``freeze'' period, -since a new ``unstable'' distribution will be created at that time. +since a new In summary, there is always a Experimental +

+The +Developers should be very selective in the use of the + +For instance, an experimental encrypted filesystem 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 Release code names + + Release code names

Every released Debian distribution has a -Since the Debian has an open development (i.e., everyone can +Since the Debian has an open development model (i.e., everyone can participate and follow the development) even the ``development versions'' (unstable) are distributed via the Internet on the Debian FTP server. This FTP server is mirrored by lots of other @@ -399,19 +545,27 @@ there may be symbolic links, which can be changed.

That's why the distribution directories use the Package uploads + Package uploads Announcing new packages

If you want to create a new package for the Debian distribution, you -have to send a short email to -This has the following advantages: - +should first check the page. 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. It helps the (potentially new) maintainer to tap into the experience @@ -420,12 +574,15 @@ 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. +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 by default. +that generally gets posted to It is helpful to the people who live off unstable (and form our first @@ -444,10 +601,11 @@ testers. If we appreciate alpha testers, than any name changes have to be backwards compatible with the people who already installed the old -package (conflict and replace old package name at a minimum) +package (conflict and replace old package name at a minimum). - - Uploading a package + + + Uploading a package Generating the changes file

@@ -456,7 +614,7 @@ accompanied by a This file is a control file with the following fields: - +

All of them are mandatory for a Debian upload. See the list of -control fields in the for the contents of these fields. +

+Notably, the debian/changelog file, should indicate which distribution the +package is intended for. There are four possible values for this +field: debian/changelog's +distribution field. Or, if Debian has been frozen, and you want to +get a bug-fix release into proposed-updates directory of the Debian archive for further +testing, before it is actually included in The first time a version is uploaded which corresponds to a particular upstream version the original source tar file should be uploaded and @@ -496,45 +673,80 @@ reason why this is not the case then the new version of the original source should be uploaded, possibly by using the Transferring the files to master + 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). + + install the package and make sure the software + works + + upgrade the package from an older version to your + new version + + downgrade the package to the previous version + (this tests the remove the package + + run lintian -v + package-NN.changes. This will check the + source package as well as the binary package. If you + don't understand the output that + + + Transferring the files to master

-To upload a package, you need a personal account on the master -server. Just log in via ftp and transfer the files to -/home/Debian/ftp/private/project/Incoming. (You cannot -upload to Incoming on master using anonymous FTP--you must use your -user-name and password.) +To upload a package, you need a personal account on +master.debian.org. All maintainers should already +have this account. 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.)

-You may also find the Debian package 'dupload' useful in -uploading new packages to master. See the 'dupload' -documentation for more information. +You may also find the Debian package and for more information. Uploads via Chiark

-If you have a slow network connection to the master system, there are -two alternatives: You can upload files to Incoming via a cron-driven -upload queue in Europe on ftp.chiark.greenend.org.uk. For details -connect to chiark using anonymous FTP and read -/pub/debian/private/project/README.how-to-upload. +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 Uploads via Erlangen

-Another cron-driven upload queue is available in Germany: Just upload -the files via anonymous FTP to -ftp://ftp.uni-erlangen.de/pub/Linux/debian/UploadQueue. +Another cron-driven 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 -master's incoming, i.e. a 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 some mail reply @@ -542,9 +754,9 @@ from the queue daemon what happened to your upload. Hopefully it should have been moved to master, but in case of errors you're notified, too.

-The program +The program Uploading to the non-us server

@@ -560,7 +772,7 @@ the keys of the developers keyring. 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 @@ -572,17 +784,39 @@ If a package is released with +If you use dupload, it is clever enough to determine for itself where +the announcement should go, and will automatically mail the +announcement. + 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 +carefully. Sometimes the "override" file which the archive +maintainers use to indicate where packages go, is incorrect or +out-of-sync with your control file. In these cases, you should either +correct your control file or file a bug against Interim releases + Interim releases

Under certain circumstances it is necessary for someone other than the usual package maintainer to make a release of a package. For example, a porter for another architecture may have to make some small changes to the source package and does not wish to wait with uploading their release until the main maintainer has incorporated the patch, or a -serious security problem may have come to light requiring immediate -attention. +serious security problem or bug may have come to light requiring +immediate attention.

When a security bug is detected a fixed package should be uploaded as soon as possible. In this case, the Debian Security Managers should @@ -610,14 +844,21 @@ Maintainers other than the usual package maintainer should make as few changes to the package as possible, and they should always send a unified context diff ( -The normal maintainer should do at least one of +usual maintainer is kept aware of the situation. +

+If the non-maintainer upload (as known as an "NMU") fixes some +existing bugs, the bug reports should not be closed. Technically, +only the official package maintainer or the original bug submitter are +allowed to close bugs. However, the person making the non-maintainer +release should send a short message to the bug tracking system to all +the fixed bugs explaining that they have been fixed. Using + +The normal maintainer should do at least one of the following: apply the diff, @@ -637,13 +878,16 @@ in the changelog file documenting the non-maintainer upload. Maintainer changes

Periodically, a listing of packages in need of new maintainers will be -sent to the debian-devel list. This list is also available at -ftp.debian.org in -/debian/doc/package-developer/prospective-packages.html If -you wish to take over maintenance of any of those packages, or if you -can no longer maintain the packages you have, or you simply want to -know if any one is working on a new package, send a message 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 take over an old package, you probably want to be listed as the package's official maintainer in the bug system. This will happen @@ -653,22 +897,216 @@ for a while, send an email to Handling bug reports + Moving, Removing, Renaming, and Orphaning Packages +

+Some archive manipulation operation are not automated in the Debian +upload process. This chapter gives guidelines in what to do in these +cases. + + Moving packages +

+Sometimes a package will change either it's section or it's +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 +

+If for some reason you want to completely remove a package (say, if it +is an old compatability library which is not longer required), you +need to file a bug against +If in doubt concerning whether a package is disposable, email +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 Orphaning a package +

+If you can no longer maintain a package, then you should set the +package maintainer to Debian QA +<debian-qa@lists.debian.org> and email +Handling Bug Reports + + 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. +

+Maintainers interact with the BTS via email addresses at +, or, if you have +installed the /usr/doc/debian/bug-*. +

+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 instructions can tell you how to do this. Make sure the bug is +not already filed against a package. Try to do a 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 not empowered to actually close the bug +(unless you secure permission from the maintainer). + + + 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, +you should not close the bug until the package which fixes the bug has +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's sufficient to mail the Lintian reports +

+You should periodically get the new . +That page, which is updated automatically, contains Reporting lots of bugs at once

If you report more then 10 bugs on the same topic at once, it is -recommended that you send a message to debian-devel describing your -intention before submitting the report. This will allow other -developers to verify that the bug is a real problem. In addition, it -will prevent the situation where several maintainers start filing the -same bug report simultaneously. +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 Whirlwind Tour of Debian Maintainer Tools +

+This section contains a rough overview of the tools available to +maintainers. These tools are meant to help convenience developers and +free their time for critical tasks. +

+Some people prefer to use high-level package maintenance tools and +some do not. Debian is officially agnostic on this issue, other than +making the attempt to accomodate the reasonable wishes of developers. +Therefore, this section is not meant to stipulate to anyone which +tools they should use or how they should go about with their duties of +maintainership. Nor is it meant to 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. + + + dpkg-dev +

+dpkg-dev contains the tools (including + + 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 . + + + debhelper +

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

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