X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=da075a0665fd913370b4ea5bb02ece71995bff83;hb=986a7b2f49859e3006c18e383970eb8c35c4ebd7;hp=bc8d66b123b8da0c1f7f8adc698e05c36336a10d;hpb=8e0675e353aa931b01fa42667d5e005c23d75b03;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index bc8d66b..da075a0 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -7,8 +7,9 @@ @@ -18,9 +19,11 @@ Adam P. Harris, current maintainer Christian Schwarz Ian Jackson version &version;, &date; + ver. &version;, &date; + +

Copyright ©1998 Adam P. Harris. Copyright ©1997,1998 Christian Schwarz.

@@ -46,9 +49,10 @@ Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Scope of This Document

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

-The processes discussed within include how to become a maintainer +The procedures 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 @@ -62,15 +66,14 @@ 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 . +name="Debian Packaging Manual">. Nor does this reference detail the +standards to which Debian software must comply; that information can +be found in the . Applying to Become a Maintainer @@ -78,14 +81,14 @@ Manual">. Getting started

So, you've read all the documentation, you understand what everything -in the Firstly, subscribe to . @@ -127,13 +130,17 @@ application: 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 +lessIt is not clear to the author why logins on +master cannot be eight characters or greater. If anyone can +clarify why, I would appreciate it.), 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 phone number where we can call you. Remember that the new +maintainer team usually calls during evening hours to save on long +distance tolls. Please do not give a work number, unless you are +generally there in the evening. 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 @@ -149,9 +156,9 @@ 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. @@ -163,22 +170,28 @@ 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.

+Our standard is to use pgp version 2.x. You can use + 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 -'. +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. +instructions on how to put your key on the public key servers.

Due to export restrictions by the United States government some Debian packages, including PGP, have been moved to an ftp site outside of the @@ -189,7 +202,7 @@ United States. You can find the current locations of those packages on Some countries restrict the use of cryptographic software by their citizens. This need not impede one's activities as a Debian package maintainer however, as it may be perfectly legal to use cryptographic -products for authenication, rather than encryption purposes (as is +products for authentication, rather than encryption purposes (as is the case in France). The Debian Project does not require the use of cryptography pgp --kxa in the case of PGP; note that pgp +-kxa in the case of PGP) for the database of keys which is +distributed from /pub/debian/doc/debian-keyring.tar.gz, or the -debian-keyring package). Please be sure to sign your + 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-14 days, please re-send your -original message--the new-maintainer volunteers are typically -overworked, and mistakes do occasionally happen. +If you don't hear anything within 7-14 days, please send a followup +message asking if your original application was received. Do not +re-send your original application, that will just confuse the +new-maintainer team. Please be patient, especially near release +points; mistakes do occasionally happen, and people do sometimes run +out of volunteer time. Debian Mentors

-There is a mailing list called for details). +A mailing list called for +details).

-Those who prefer one-on-one help (e.g., via private emails) should +Those who prefer one-on-one help (e.g., via private email) should also post to that list and an experienced developer will volunteer to help. @@ -235,19 +250,18 @@ help. The mailing list server is at , or locally in /usr/doc/debian/mailing-lists.txt if you have the -doc-debian package installed. +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: . - The master server -

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

- - The WWW servers -

- + The master server +

+The master server, . +

+ +All Debian developers have accounts on +If you find a problem with debian-admin@debian.org. + + The FTP servers +

+ + The WWW servers +

+The main web server, +If you have some Debian-specific information which you want to serve +up on the web, you can do do this by putting material in the +public_html directory under your home directory. You can do +this on either http://www.debian.org/~user-id/ and +http://master.debian.org/~user-id/, respectively. +Generally, you'll want to use +If you find a problem with the Debian web server, you should generally +submit a bug against the pseudo-package, +www.debian.org. First check whether or not someone +else has already reported the problem on the . + + The CVS server +

+ssh. +

+To request a CVS area, send a request via email to +debian-admin@debian.org. + + + Mirrors of Debian servers +

+The web and FTP servers have several mirrors available. Please do not +put heavy load on the canonical FTP or web servers. Ideally, the +canonical servers only mirror out to a first tier of mirrors, and all +user access is to the mirrors. This allows Debian to better spread +its bandwidth requirements over several servers and networks. Note +that newer push mirroring techniques ensure that mirrors are as +up-to-date as they can be. +

+The main web page listing the available public FTP (and, usually, +HTTP) servers can be found at . More information +concerning Debian mirrors can be found at . This useful page includes +information and tools which can be helpful if you are interested in +setting up your own mirror, either for internal or public access. +

+Note that mirrors are generally run by third-parties who are +interested in helping Debian. As such, developers generally do not +have accounts on these machines. +

+Please do not mirror off of The Debian Archive @@ -298,6 +389,7 @@ The Debian GNU/Linux distribution consists of a lot of Debian packages (documentation, installation disk images, etc.).

Here is an example directory tree of a complete Debian distribution: +

main/ main/binary-all/ @@ -310,9 +402,9 @@ main/binary-i386/ main/binary-i386/admin/ main/binary-i386/base/ ... -main/binary-m86k -main/binary-m86k/admin/ -main/binary-m86k/base/ +main/binary-m68k +main/binary-m68k/admin/ +main/binary-m68k/base/ ... main/source/ main/source/admin/ @@ -325,14 +417,14 @@ main/disks-m68k/ contrib/ contrib/binary-all/ contrib/binary-i386/ -contrib/binary-m86k/ +contrib/binary-m68k/ ... contrib/source/ non-free/ non-free/binary-all/ non-free/binary-i386/ -non-free/binary-m86k/ +non-free/binary-m68k/ ... non-free/source/ @@ -342,14 +434,14 @@ three directories, namely main, contrib, and non-free. These directories are called sections.

In each section, there is a directory with the source packages -(source), a directory for each supported architecture (binary-i386, -binary-m86k, etc.), and a directory for architecture independent -packages (binary-all). +(source), a directory for each supported architecture +( The The Sections

The main section is what makes up the official Debian -GNU/Linux distribution. This is because the packages in the other -two 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 section must fully comply -with the (DFSG) and with all other -policy requirements as described in the . The +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.) +Manual">. 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 -(The contains a more exact definition of the three -sections. The above discussion is just an introduction.) +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 @@ -404,23 +497,29 @@ i386 (or greater) platforms, and so was Debian. But when Linux became more and more popular, the kernel was ported to other architectures, too.

-The Linux 2.0 kernel supports Intel, DEC Alphas, SUN Sparcs, M68000 -(a.k.a. m68k) machines (like Atari and Amiga), MIPS, and PowerPC -(a.k.a. ppc). +The Linux 2.0 kernel supports Intel x86, DEC Alpha, Sparc, M68000 +machines (like Atari and Amiga), 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. Aside from i386 +(our name for Intel x86), there is m68k, alpha, +ppc, sparc, hurd-i386, and arm as +of this writing. +

-Debian GNU/Linux 1.3 is only available for Intel platforms. Debian -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. +Debian GNU/Linux 1.3 is only available as i386. Debian 2.0 +supports i386 and m68k architectures. The next +version of Debian is likely to also support all these, in addition to +alpha, ppc, and sparc architectures. Subsections

The sections Source packages consist of either two or three files: a If a package is developed specially for Debian and is not distributed outside of Debian, there is just one -If a package is distributed elsewhere too, the The Distribution directories

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

+Within that archive root, the actual distributions are contained in +the + +archive root/dists/distribution/section/architecture/subsection/packages + + +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

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

-The ``development'' is done in the After a period of development, the This development cycle is based on the assumption that the -Note that development is continued during the ``freeze'' period, since -a new In summary, there is always a Experimental

The -For instance, an experimental encrypted filesystem should probably go +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 @@ -532,37 +649,37 @@ your system can go into Release code names

Every released Debian distribution has a 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 -systems. Thus, if we'd call the directory which contains the -development version simply `unstable', then we would have to rename it +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 to `stable' when the version is released, which would cause all FTP -mirrors to re-get the whole distribution (which is already very +mirrors to re-retrieve the whole distribution (which is already very large!).

-On the other hand, if we would call the distribution directories +On the other hand, if we called the distribution directories Debian-x.y from the beginning, people would think that Debian release x.y is available. (This happened in the past, where a CD-ROM vendor built a Debian 1.0 CD-ROM based on a pre-1.0 development 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 should -stay the same during the development period and after the release but -there may be symbolic links, which can be changed. -

-That's why the distribution directories use the Package uploads @@ -572,50 +689,38 @@ etc., which point to the appriopriate release directories. If you want to create a new package for the Debian distribution, you should first check the page. Checking +name="Work-Needing and Prospective Packages (WNPP)"> 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. +steps: 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 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" +the one line description and the changelog entry ``Initial version'' that generally gets posted to It is helpful to the people who live off unstable (and form our first 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. - - - -We should not dismiss anybody who installs from unstable and helps us -debug our packages as "fools, fools, you installed from unstable; you -deserve what you get"--we derive a certain benefit from the alpha -testers. - @@ -624,10 +729,12 @@ testers. Generating the changes file

When a package is uploaded to the Debian FTP archive, it must be -accompanied by a +The changes file is a control file with the following fields:

-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. +Only the Picking a distribution

Notably, the debian/changelog file, should indicate which distribution the +debian/changelog file, indicates 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 changelog's for more information on when to upload to +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 @@ -686,6 +796,45 @@ identical with the one already in the archive. If there is some reason why this is not the case then the new version of the original source should be uploaded, possibly by using the Uploading to +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 +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 +code. This is a difficult thing to quantify, so here are +some guidelines: +

+ + +Fixes for bugs of severity + +normal 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) + +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. + + Checking the package prior to upload

@@ -693,49 +842,53 @@ 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, or upgrade the package from an older version to - your new version if a Debian package for it already - exists - - downgrade the package to the previous version - (if one exists) -- 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 +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-NN.changes. This will +check the source package as well as the binary package. If you don't +understand the output that +Normally, a package should +For more information on . + +Downgrade the package to the previous version (if one exists) -- this +tests the +Remove the package, then reinstall it. - Transferring the files to master + Uploading to To upload a package, you need a personal account on master.debian.org. All maintainers should already -have this account. You can use either . You can use either +/home/Debian/ftp/private/project/Incoming. (You -cannot upload to Incoming on master using anonymous FTP -- you must use -your username and password.) +cannot upload to Incoming on master using anonymous FTP -- you must +use your user-name and password.)

-You may also find the Debian package for more information. - Uploads via Chiark + Uploads via -If you have a slow network connection to ftp.chiark.greenend.org.uk using anonymous FTP and -read +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 applies here as well. +

+The program Uploads via Erlangen + Uploads via 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 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 -from the queue daemon what happened to your upload. Hopefully it -should have been moved to master, but in case of errors you're +upload as on -The program applies here as well. +

+The program . Note, that the .changes file must have a valid PGP signature from one of -the keys of the developers keyring. +the keys of the developers key-ring. 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) +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 -If a package is released with -On occassion, it is necessary to upload a package to both the +On occasion, it is necessary to upload a package to both the + 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 @@ -830,11 +991,30 @@ archive may take up to a week to occur (please be patient).

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 The override file +

+The debian/control file's debian/control file are +actually just hints. +

+The archive maintainers keep track of the cannonical sections and +priorities for packages in the control file is not going to work. Instead, you should email + +For more information about , +/usr/doc/debian/bug-log-mailserver.txt, and +/usr/doc/debian/bug-maint-info.txt. + Interim releases

@@ -857,16 +1037,19 @@ fixed package. When someone other than the usual maintainer releases a package they should add a new component to the 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 dpkg-buildpackage with the Maintainers other than the usual package maintainer should make as few changes to the package as possible, and they should always send a @@ -874,17 +1057,17 @@ unified context diff ( -If the non-maintainer upload (as known as an "NMU") fixes some +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: @@ -925,6 +1108,7 @@ for a while, send an email to Moving, Removing, Renaming, and Orphaning Packages

Some archive manipulation operation are not automated in the Debian @@ -947,15 +1131,15 @@ name="Debian Packaging Manual"> 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 @@ -972,7 +1156,7 @@ 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 , or, if you have -installed the /usr/doc/debian/bug-*.

Often as a package maintainer, you find bugs in other packages or else @@ -1008,7 +1192,7 @@ 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 +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). @@ -1024,19 +1208,19 @@ 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 report, which is updated automatically, contains Reporting lots of bugs at once @@ -1054,70 +1238,69 @@ send the bug report to Whirlwind Tour of Debian Maintainer Tools + Overview 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. +some do not. Debian is officially agnostic on this issue; any tool +which gets the job done is fine. 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 +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 +Unlike debmake. + - debmake + -debmake, a pre-cursor to debhelper, is a +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 + - dupload + -dupload is a package and a script to automagically upload +