X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=13f2368ce266b9117e079a85b9742f60af4b0170;hp=7a6bf65ec14096de1a6856392b8ea84fecf9265c;hb=51521555be3ad4f8da4c287ce6afd155a588315c;hpb=7bada93452b9d90ecdb93696251b8e976cfb7fd5 diff --git a/developers-reference.sgml b/developers-reference.sgml index 7a6bf65..13f2368 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -1,7 +1,17 @@ - - %versiondata; + + %versiondata; + + %commondata; + + + + + ]> -copyright ©1998 Adam Di Carlo, ©1997,1998 -Christian Schwarz + +copyright ©1998, 1999 Adam Di Carlo + +copyright ©1997, 1998 Christian Schwarz

This manual is free software; you may redistribute it and/or modify it under the terms of the GNU General Public License as published by the @@ -38,11 +49,10 @@ merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

A copy of the GNU General Public License is available as -/usr/doc/copyright/GPL in the Debian GNU/Linux distribution -or on the World Wide Web at /usr/doc/copyright/GPL in the Debian GNU/Linux +distribution or on the World Wide Web at . -You can also obtain it by writing to the Free Software Foundation, -Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +You can also obtain it by writing to the &fsf-addr;. @@ -63,17 +73,20 @@ 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 +discussion of resources which can help maintainers with the quality of their packages ().

It should be clear that this reference does not discuss the technical details of the Debian package nor how to generate Debian packages; -that information is discussed in the . Nor does this reference detail the standards to which Debian software must comply; that information can -be found in the . +be found in the . +

+Furthermore, this document is not an expression of formal +policy. It contains documentation for the Debian system, and +generally agreed-upon best practices. Applying to Become a Maintainer @@ -81,61 +94,60 @@ name="Debian Policy Manual">. Getting started

So, you've read all the documentation, you understand what everything -in the hello example package is for, and you're about to Debianize your favourite piece of software. How do you actually become a Debian developer so that your work can be incorporated into the Project?

-Firstly, subscribe to debian-devel@lists.debian.org if +you haven't already. Send the word subscribe in the +Subject of an email to +debian-devel-REQUEST@lists.debian.org. In case of problems, contact the list administrator at -. +listmaster@lists.debian.org. More information on +available mailing lists can be found in .

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.

Another good list to subscribe to is - for -details. The IRC channel debian-mentors@lists.debian.org. See for details. The IRC channel #debian on the +Linux People IRC network (i.e., irc.debian.org) can also be +helpful. - Registering as a Debian developer + Registering as a Debian developer

Before you decide to register with the Debian Project, you will need -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. +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. +Debian GNU/Linux has grown to over &number-of-maintainers; 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 -new-maintainer@debian.org as part of the registration application: Your name. -Your preferred login name on It 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). +Your preferred login name on master (eight characters or +less), as well as the email address at which you'd prefer to be +subscribed to debian-private@lists.debian.org +(typically this will be either your primary mail address or your new +debian.org address). A phone number where we can call you. Remember that the new maintainer team usually calls during evening hours to save on long @@ -157,7 +169,7 @@ 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 in real life. Any formal certification service (such as Verisign, etc.) that verifies your identity. A certification that verifies your email @@ -178,25 +190,29 @@ 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 -pgp version 5, if and only if you make an RSA key. Note +that we are also working with the gpg team so that we can +have a free alternative to PGP; however, this may take a little bit of +time.

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

-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 key servers. +If your PGP key isn't on public key servers such as +&pgp-keyserv;, please read the documentation available +locally /usr/doc/pgp/keyserv.doc. That document contains +instructions on how to put your key on the public key servers. The +New Maintainer Group will put your public key on the servers if it +isn't already there.

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 -ftp.debian.org or +ftp.us.debian.org in the /pub/debian/README.non-US file.

Some countries restrict the use of cryptographic software by their @@ -204,157 +220,214 @@ 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 authentication, rather than encryption purposes (as is the case in France). The Debian Project does not require the use of -cryptography qua cryptography in any manner. 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.

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) for the database of keys which is -distributed from new-maintainer@debian.org to register as an offical +Debian developer so that you will be able to upload your packages. +This message must contain all the information discussed above. The +message must also contain your PGP or RSA public key (extracted using +pgp -kxa in the case of PGP) for the database of keys which +is distributed from ftp.debian.org in /pub/debian/doc/debian-keyring.tar.gz, or the -debian-keyring package. Please be sure to sign +your request message with your chosen public 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-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

-A mailing list called for -details). +A mailing list called debian-mentors@lists.debian.org +which has been set up for novice maintainers who seek help with +initial packaging and other developer-related issues. Every new +developer is invited to subscribe to that list (see for details). +

+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. + + + Maintaining Your Debian Information + + Maintaining Your Public Key +

+Be very careful with your private keys. Do not place them on any +public servers. Back them up. Read the documentation that comes with +your software (either PGP or GNUPG); read the FAQs too, for good +measure. +

+If you add or remove signatures from your public key, or add or remove +user identities, you need to update the key servers and mail your +public key to keyring-maint@debian.org. The same key +extraction routines discussed in apply. +

+You can find a more in-depth discussion of Debian key maintenance in +the documentation for the debian-keyring package. + + Retiring Gracefully

-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. +If you choose to leave the Debian project, you should make sure you do +the following steps: + + +Orphan all your packages, as described in . + +Send an email about how you are leaving the project to +debian-private@lists.debian.org. + +Notify the Debian key ring maintainers that you are leaving by emailing +to keyring-maint@debian.org. + - Mailing Lists and Servers + Mailing Lists, Servers, and Other Machines +

+In this chapter you will find a very brief road map of the Debian +mailing lists, the main Debian servers, and other Debian machines +which may be available to you as a developer. 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. +The mailing list server is at lists.debian.org. Mail +debian-foo-REQUEST@lists.debian.org, where +debian-foo is the name of the list, with the word +subscribe in the Subject to subscribe to the list or +unsubscribe to unsubscribe. More detailed instructions on +how to subscribe and unsubscribe to the mailing lists can be found 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 (CC) to the original poster unless they explicitly request to be copied. Anyone who posts to a mailing list should read it to see the responses.

In addition, all messages should usually only be sent to one of the -following mailing lists: . Cross-posting +following mailing lists: debian-devel@lists.debian.org, +debian-policy@lists.debian.org, +debian-user@lists.debian.org, +debian-announce@lists.debian.org, or +debian-devel-announce@lists.debian.org. Additional +mailing lists are available for special purposes; see . Cross-posting (sending the same message to multiple lists) is discouraged.

-debian-private@lists.debian.org is a special mailing +lists for private discussions amongst Debian developers. It is meant +to be used for posts which for whatever reason should not be published publically. As such, it is a low volume list, and users are urged not -to use debian-private@lists.debian.org unless it is +really necessary. Moreover, do not forward email from that +list to anyone.

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 . +id="&url-debian-list-archives;">. + Debian servers +

+Debian servers are well known servers which serve critical functions +in the Debian project. Every developer should know what these servers +are and what they do. +

+If you have a problem with the operation of Debian server, and you +think that the system operators need to be notified of this problem, +please find the contact address for the particular role at . If you have a non-operating problems +(such as packages to be remove, suggestions for the web site, etc.), +generally you'll report a bug against a ``pseudo-package''. See for information on how to submit bugs. - The master server + The master server

-The master server, master.debian.org, holds the canonical copy of the Debian archive (excluding the non-U.S. packages). Generally, package uploads go to this server; see .

-master.debian.org is the canonical location for the Bug +Tracking System (BTS). If you plan on doing some statistical analysis +or processing of Debian bugs, this would be the place to do it. +Please describe your plans on +debian-devel@lists.debian.org before implementing +anything, however, to reduce unnecessary duplication of effort or +wasted processing time.

-All Debian developers have accounts on master.debian.org. Please take care to protect your password to this machine. Try to avoid login or upload methods which send passwords over the Internet in the clear.

-If you find a problem with master.debian.org such as disk full, suspicious activity, or whatever, send an email to -debian-admin@debian.org. - - The FTP servers -

+debian-admin@debian.org. Problems with the Debian FTP +archive generally need to be reported as bugs against the +ftp.debian.org pseudo-package or an email to +ftpmaster@debian.org, but also see the procedures in +. - The WWW servers + The WWW servers

-The main web server, www.debian.org, is also known as +va.debian.org. All developers are given accounts on this machine.

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 public_html directory under your home directory. You can +do this on either va.debian.org or +master.debian.org. Any material you put in those areas are +accessible via the URLs http://www.debian.org/~user-id/ and http://master.debian.org/~user-id/, respectively. -Generally, you'll want to use va, for the +www.debian.org address, although in some cases you may need +to put it on master. Please do not put any material on +Debian servers not relating to Debian, unless you have prior +permission. Send mail to debian-devel@lists.debian.org +if you have any questions.

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 . +id="&url-bts;db/pa/lwww.debian.org.html" name="Bug Tracking System">. - The CVS server + + The CVS server

-ssh. +cvs.debian.org is also known as va.debian.org, +discussed above. If you need the use of a publically accessible CVS +server, for instance, to help coordinate work on a package between +many different developers, you can request a CVS area on the server. +

+Generally, cvs.debian.org offers a combination of local CVS +access, anonymous client-server read-only access, and full +client-server access through ssh. Also, the CVS area can +be accessed read-only via the Web at .

To request a CVS area, send a request via email to -debian-admin@debian.org. +debian-admin@debian.org. Include the name of the +requested CVS area, what va.debian.org user account should +own the CVSROOT, and why you need it. - Mirrors of Debian servers + 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 @@ -366,9 +439,9 @@ 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 +id="&url-debian-mirrors">. More information concerning Debian mirrors can be found at . This useful page includes +id="&url-debian-mirroring">. 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.

@@ -376,120 +449,144 @@ 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 master.debian.org. This host +already has too much load. Check the sites above for information, or +email debian-devel@lists.debian.org. + + + Other Debian Machines +

+There are other Debian machines which may be made available to you. +You can use these for Debian-related purposes as you see fit. Please +be kind to system administrators, and do not use up tons and tons of +disk space, network bandwidth, or CPU without first getting the +approval of the local maintainers. Usually these machines are run by +volunteers. Generally, these machines are for porting activities. +

+Aside from the servers mentioned in , the +following machines are, or may be made, available to you. If an email +address is listed, generally that person is the party to contact about +issues on the machine. Otherwise, the machine is probably managed by +debian-admin@debian.org. + + + faure.debian.org + +An Alpha; if you have an account on master, you probably +already have an account here. + + kubrick.debian.org + +A SPARC; if you have an account on master, you probably +already have an account here. + + pandora.debian.org + +An i386; if you have an account on master, you probably +already have an account here. + + albert.debian.org + +An Alpha; you probably want to use faure instead, but you may +request an account from debian-admin@debian.org. + + powerpc.debian.org + +A PowerPC; also known as tervola.infodrom.north.de. You may +request an account from joey@debian.org or +koptein@debian.org. + + m68k.debian.org + +A Motorola 6800x0 machine; you may request an account from +joey@debian.org or james@nocrew.org. +Runs an autobuilder. + + alpha.debian.nl + +An Alpha; you may request an account from +debian@cistron.nl. + + xia0[123].kachinatech.com + +SPARC and UltraSPARC machines. xia0[12] are used for +automatic compilation; you can request an account on xia03 (an +UltraSPARC) from wdeng@kachinatech.com. + + + + The Debian Archive Overview

The Debian GNU/Linux distribution consists of a lot of Debian packages -(.deb's, currently around &number-of-pkgs;) and a few +additional files (documentation, installation disk images, etc.).

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

- -main/ -main/binary-all/ -main/binary-all/admin/ -main/binary-all/base/ -main/binary-all/comm/ -main/binary-all/devel/ - ... -main/binary-i386/ -main/binary-i386/admin/ -main/binary-i386/base/ - ... -main/binary-m68k -main/binary-m68k/admin/ -main/binary-m68k/base/ - ... -main/source/ -main/source/admin/ -main/source/base/ - ... -main/disks-i386/ -main/disks-m68k/ - ... - -contrib/ -contrib/binary-all/ -contrib/binary-i386/ -contrib/binary-m68k/ - ... -contrib/source/ - -non-free/ -non-free/binary-all/ -non-free/binary-i386/ -non-free/binary-m68k/ - ... -non-free/source/ - +&sample-dist-dirtree;

As you can see, the top-level directory of the distribution contains -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-m68k, etc.), and a directory +for architecture independent packages (binary-all).

-The main section contains additional directories which holds +the disk images and some essential pieces of documentation required +for installing the Debian distribution on a specific architecture +(disks-i386, disks-m68k, etc.).

-The binary and source directories are divided +further into subsections. Sections

The main section is what makes up the official Debian -GNU/Linux distribution. 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. +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. +

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

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

-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. +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. (Since this varies greatly from +vendor to vendor, this job can't be done by the Debian developers.) Architectures @@ -499,66 +596,65 @@ 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 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. +The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola +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.

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 support i386, m68k, -alpha, and possibly ppc and sparc -architectures. +shipped for i386 and m68k architectures. Debian 2.1 +ships for the i386, m68k, alpha, and +sparc architectures. 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, excepting perhaps the `base' subsection. +Subsections exist simply to simplify the organization and browsing of +available packages. Please check the current Debian distribution to +see which sections are available. 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 -The .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. Every +distribution is contained in the dists directory in the +top-level of the Debian archive itself (the symlinks from the +top-level directory to the distributions themselves are for backwards +compatability and are deprecated).

To summarize, the Debian archive has a root directory within an FTP server. For instance, at the mirror site, @@ -567,104 +663,117 @@ contained in /debian, which is a common location (another is /pub/debian).

Within that archive root, the actual distributions are contained in -the dists directory. Here is an overview of the layout:

archive root/dists/distribution/section/architecture/subsection/packages Extrapolating from this layout, you know that to find the i386 base -packages for the distribution slink, you would look in /debian/dists/slink/main/binary-i386/base/. Stable, unstable, and sometimes frozen

-There is always a distribution called dists/stable) and one called stable (residing in +dists/stable) 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 unstable distribution is +copied in a new distribution directory, called frozen. When +that occurs, no changes are allowed to the frozen distribution except +bug fixes; that's why it's called ``frozen.'' After another month or +a little longer, 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 is continued during the +``freeze'' period, since a new unstable distribution is be +created when the older unstable 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 and an unstable +distribution available, and the frozen distribution shows up +for a month or so from time to time. Experimental

-The experimental distribution is a specialty distribution. +It is not a full distribution in the same sense that `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 well 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 (dinstall and the Debian archive maintainers +do that). Additionally, you'll have to remember to ask the archive +maintainers to delete the package one you have uploaded it to +unstable. Using your personal web space on +va.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 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 -to `stable' when the version is released, which would cause all FTP +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-retrieve the whole distribution (which is already very large!).

@@ -677,12 +786,12 @@ version. That's the reason why the first official Debian release was

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 and symbolic +links for stable, unstable, and frozen +point to the appropriate release directories. Package uploads @@ -696,10 +805,10 @@ 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 debian-devel@lists.debian.org describing +your plan to create a new package. You should set the subject of the +email to ``intent to package foobar'', substituting the +name of the new package for foobar.

There are a number of reasons why we ask maintainers to follow these steps: @@ -711,13 +820,14 @@ 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 debian-devel@lists.debian.org +will be picked up the the WNPP maintainer, and your intention will be published in subsequent versions of the WNPP document. 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. It is helpful to the people who live off unstable (and form our first line of testers); we should encourage these people. @@ -732,95 +842,98 @@ better feel of what is going on, and what is new, in the project. 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:

- Format + Date + Source + Binary + Architecture + Version + Distribution + Urgency + Maintainer + Description + Changes + Files

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 Distribution field is discussed here, since it +relates to the archive maintenance policies. Picking a distribution

-Notably, the debian/changelog file, indicates which distribution the +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 -proposed-updates -directory of the Debian archive for further testing before it is -actually included in stable and unstable distributions, then you might +put `stable unstable' in the changelog's +Distribution field. Or, if Debian has been frozen, and you +want to get a bug-fix release into frozen, you would set the +distribution to `frozen unstable'. (See for +more information on when to upload to frozen.) 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. Also note that it never makes sense to combine the +experimental distribution with anything else.

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; subsequent times the very same +tar file should be used to build the new diffs and .dsc +files, and it need not then be 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 then 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 +important severity are always allowed for those packages that must exist in the final release -critical, grave, and important bug fixes +are only allowed for non-necessary packages 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 @@ -850,106 +963,109 @@ 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 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 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 -ssh or ftp to transfer the files. In either +case, the files need to be placed into /home/Debian/ftp/private/project/Incoming. (You cannot upload to Incoming on master using anonymous FTP -- you must use your user-name and password.)

-Note: Do not upload packages containing software that is +export-controlled by the United States government to master, +or 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 below). If you are not sure whether +U.S. export controls apply to your package, post a message to +debian-devel@lists.debian.org 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 master, +chiark, and erlangen. It can also be configured to +use ssh. See and + for more information. - Uploads via Uploads via chiark

-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 master, there are +alternatives. One is to upload files to Incoming via a +upload queue in Europe on chiark. For details connect to +ftp.chiark.greenend.org.uk using anonymous FTP and +read /pub/debian/private/project/README.how-to-upload.

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

-The program dupload supports uploads 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 .

The upload must be a complete Debian upload, as you would put it into -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 master via the 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 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 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 notified, too.

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

-The program dupload supports uploads to +erlangen; please refer to the documentation that comes with +the program for details. Uploading to the non-us server

-To upload a package to the non-us server you just have to transfer the files via anonymous ftp to . Note, that the .changes file must have a valid PGP signature from one of @@ -959,38 +1075,42 @@ 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) -package name and version number, and a very short summary of the -changes, in the Subject field, and should contain the +PGP-signed .changes file. Some additional explanatory text +may be added before the start of the .changes file.

-If a package is released with the Distribution: set to `stable', the announcement is sent to -debian-changes@lists.debian.org. If a package is +released with Distribution: set to `unstable', +`experimental', or `frozen' (when present), the announcement should be +posted to debian-devel-changes@lists.debian.org +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 should go to both of the above +mailing lists.

-The dupload program is clever enough to determine for itself 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 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 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 @@ -999,40 +1119,41 @@ 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 cannonical 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 override-change@debian.org 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 , +/usr/doc/debian/bug-log-mailserver.txt, and +/usr/doc/debian/bug-maint-info.txt. - Non-Maintainer Uploads (NMUs) and Porters -

+ Non-Maintainer Uploads (NMUs) +

Under certain circumstances it is necessary for someone other than the official package maintainer to make a release of a package. This is called a non-maintainer upload, or NMU.

Debian porters, who compile packages for different architectures, do -NMUs as part of their normal porting activity. Another reason why -NMUs are done is when a Debian developers needs to fix another -developers' packages in order to address serious security problems or -crippling bugs, especially during the freeze, or when the package -maintainer is unable to release a fix in a timely fashion. -

+NMUs as part of their normal porting activity (see ). Another reason why NMUs are done is when a Debian +developers needs to fix another developers' packages in order to +address serious security problems or crippling bugs, especially during +the freeze, or when the package maintainer is unable to release a fix +in a timely fashion. +

This chapter contains information providing guidelines for when and how NMUs should be done. A fundamental distinction is made between source and binary NMUs, which is explained in the next section. @@ -1043,25 +1164,24 @@ There are two new terms used throughout this section: ``binary NMU'' 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 regular maintainer. 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 -official maintainer for the purposes of fixing a bug in the package. +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 +a change to debian/changelog). This can be either a change 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 part of ``porting''. There are -ports of a package where no source changes are needed and ports where -the source has to be changed. A binary NMU is non-maintainer uploaded -binary version of a package 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 be considered a source NMU rather than -a binary NMU. As you can see, we don't distinguish in terminology -between porters' source NMUs and normal NMUs. +new architecture. As such, it is usually part of a porting effort. A +binary NMU is 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 +be considered a source NMU rather than a binary NMU. As you can see, +we don't distinguish in terminology between porter NMUs and non-porter +NMUs.

Both classes of NMUs, source and binary, can be lumped by the term ``NMU''. However, this often leads to confusion, since most people @@ -1072,13 +1192,13 @@ mean both source and binary NMUs. Who can do an NMU

-Only official Debian maintainers can do binary or source NMUs. This -is because we need to ensure that trojans or other problems are not -inserted into the archive. Non-developers, however, are encouraged to -download the source package and start hacking on it to fix problems -- -just submit worthwhile patches to the Bug Tracking System. -Maintainers almost always appreciate quality patches and bug reports -(at least, we hope). +Only official, registered Debian maintainers can do binary or source +NMUs. An official maintainer is someone who has their key in the +Debian key ring. Non-developers, however, are encouraged to download +the source package and start hacking on it to fix problems; however, +rather than doing an NMU, they should just submit worthwhile patches +to the Bug Tracking System. Maintainers almost always appreciate +quality patches and bug reports. When to do a source NMU @@ -1088,7 +1208,7 @@ distribution, i.e., stable, unstable, or frozen. Porters have slightly different rules than non-porters, due to their unique circumstances (see ).

-Only critical changes or security bugfixes make it into stable. When +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 as possible. In this case, the Debian Security Managers should get in contact with the package maintainer to make sure a fixed package is @@ -1106,7 +1226,7 @@ in need to be followed.

Bug fixes to unstable by non-maintainers are also acceptable, but only as a last resort or with permission. Try the following steps first, -and if they don't work, it is probably ok to do an NMU: +and if they don't work, it is probably OK to do an NMU:

@@ -1122,7 +1242,7 @@ id="upload-checking">. Use it locally. Wait a couple of weeks for a response. -Email the maintainer, asking if it is ok to do an NMU. +Email the maintainer, asking if it is OK to do an NMU. Double check that your patch doesn't have any unexpected side effects. Make sure your patch is as small and as non-disruptive as it can be. @@ -1134,44 +1254,6 @@ id="nmu-guidelines">. - When to do a source NMU if you are a porter -

-Porters doing a source NMU generally follow the above guidelines, just -like non-porters. However, it is expected that the wait cycle for a -porter's source NMU is smaller than for a non-porter, since porters -have to cope with a large quantity of 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-targetted architecture) can be -uploaded with -However, if you are a porter doing an NMU for `unstable', the above -guidelines for porting should be followed, with two variations. -Firstly, the acceptable waiting period -- the time between when the -bug is submitted to the BTS and when it is ok to do an NMU -- is seven -days for porters working on the unstable distribution. -

-Secondly, porters doing source NMUs should make sure that the bug they -submit to the BTS should be of severity `important' 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 -architecture in order to comply with many licenses. -

-Porters should try to avoid patches which simply kluge around bugs in -the current version of the compile environment, kernel, or libc. -Sometimes such kluges can't be helped. If you have to kluge around -compilers bugs and the like, make sure you #ifdef your work -properly; also, document your kluge so that people know to remove it -once the external problems have been fixed. -

-Porters may also have an unofficial location where they can put the -results of their work during the waiting period. This helps others -running the port have the benefit of the porter's work, even during -the waiting period. Of course, such locations have no official -blessing or status, so buyer, beware. - How to do a source NMU

@@ -1183,12 +1265,13 @@ simply uploading a recompiled binary package, the rules are different; see .

First and foremost, it is critical that NMU patches to source should -be as non-disruptive as possible. Do not do housekeeping task, change -the name of modules, move directories, or fix things which are not -broken. Keep the patch as small as possible. If thing 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. Source NMU version numbering @@ -1198,31 +1281,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 @@ -1231,61 +1314,65 @@ 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 sounce NMU (non-maintainer upload) fixes some existing bugs, +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 -independantly upstream, which is another good reason to back out an +independently upstream, which is another good reason to back out an NMU's patch. If the maintainer decides not to apply the NMU's patch 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 @@ -1296,13 +1383,88 @@ 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 from the NMU entry of +the debian/changelog file will be used for signing the +changes file. + + + + + Porting and Being Ported +

+Debian supports an ever-increasing number of architectures. Even if +you are not a porter, and you don't use any architecture but one, it +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 +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 i386 binary package, there has to be a +recompile for each architecture, which is around five more builds. - Guidelines for porters (binary NMUs) + 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 +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. +

+The first and most important watchword is to respond quickly to bug or +issues raised by porters. Please treat porters with courtesy, as if +they were in fact co-maintainers of your package (which in a way, they +are). +

+By far, most of the problems encountered by porters are caused by +packaging bugs in the source packages. Here is a checklist +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 ``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 source package with the +debian/files or debian/substvars files. +They should be removed by the `clean' target of +debian/rules. + +Make sure you don't rely on locally installed or hacked configurations +or programs. For instance, you should never be calling programs in +/usr/local/bin or the like. Try not to rely on programs +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 +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. + + + + Guidelines for Porter Uploads

If the package builds out of the box for the architecture to be ported to, you are in luck and your job is easy. This section applies to @@ -1314,17 +1476,115 @@ id="nmu-guidelines"> instead.

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. +includes debian/changelog. +

+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. + + + + When to do a source NMU if you are a porter +

+Porters doing a source NMU generally follow the guidelines found in +, just like non-porters. However, it is expected that +the wait cycle for a porter's source NMU is smaller than for a +non-porter, since porters have to cope with a large quantity of +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. +Firstly, the acceptable waiting period -- the time between when the +bug is submitted to the BTS and when it is OK to do an NMU -- is seven +days for porters working on the unstable distribution. This period +can be shortened if the problem is critical and imposes hardship on +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 +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 +architecture in order to comply with many licenses. +

+Porters should try to avoid patches which simply kludge around bugs in +the current version of the compile environment, kernel, or libc. +Sometimes such kludges can't be helped. If you have to kludge around +compilers bugs and the like, make sure you #ifdef your work +properly; also, document your kludge so that people know to remove it +once the external problems have been fixed. +

+Porters may also have an unofficial location where they can put the +results of their work during the waiting period. This helps others +running the port have the benefit of the porter's work, even during +the waiting period. Of course, such locations have no official +blessing or status, so buyer, beware. + + + Tools for Porters

-The way to invoke dpkg-buildpackage --B -m. Of course, set binary-arch target in debian/rules. +There are several tools available for the porting effort. This section +contains a brief introduction to these tools; see the package +documentation or references for full information. - Moving, Removing, Renaming, - Adopting, and Orphaning Packages + + 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 +

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

+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 sbuild and wanna-build. +

+We are very excited about this system, since it potentially has so +many uses. Independent development groups can use the system for +different sub-flavors of Debian, which may or may not really be of +general interest (for instance, a flavor of Debian built with gcc +bounds checking). It will also enable Debian to recompile entire +distributions quickly. + + + + dpkg-cross +

+dpkg-cross is a tool for installing libraries and +headers for cross-compiling in a way similar to +dpkg. Furthermore, the functionality of +dpkg-buildpackage and dpkg-shlibdeps is +enhanced to support cross-compiling. + + + + + + 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 @@ -1343,65 +1603,65 @@ Manual"> 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 - 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 dinstall bug. 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 showpkg -/var/cache/apt/pkgcache.bin , the program will show -details for debian-devel@lists.debian.org asking for opinions. +Also of interest is the apt-cache program from the +apt package. When invoked as apt-cache showpkg +/var/cache/apt/pkgcache.bin 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 debian-changes@lists.debian.org +or debian-devel-changes@lists.debian.org). 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 +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 + Orphaning a package

If you can no longer maintain a package, then you should set the -package maintainer to Debian QA +package maintainer to Debian QA Group <debian-qa@lists.debian.org> and email -wnpp@debian.org indicating that the package is now +orphaned. If the package is especially crucial to Debian, you should +instead email debian-devel@lists.debian.org asking for +a new maintainer. - Adopting a package + Adopting a package

Periodically, a listing of packages in need of new maintainers will be -sent to list. This list +sent to debian-devel@lists.debian.org list. This list is also available at in the Work-Needing and Prospective Packages document (WNPP), @@ -1409,54 +1669,83 @@ 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 wnpp@debian.org.

-It is not ok to simply take over a package that you feel is neglected +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 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 -debian-private@lists.debian.org.

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 couple of weeks. If +you do not expect to upload a new version for a while, send an email +to override-change@debian.org so that bug reports will +go to you right away. - Handling Bug Reports + Handling Bugs 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 +(BTS)"> for your packages. The BTS contains all the open bugs against your packages.

Maintainers interact with the BTS via email addresses at -bugs.debian.org. Documentation on available commands can be found at , or, if you have -installed the /usr/doc/debian/bug-*. +installed the debian-doc 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 +outlining all the open bugs against your packages: + +# ask for weekly reports of bugs in my packages +0 17 * * fri echo "index maint maintainer-address" | mail request@bugs.debian.org + +Replace maintainer-address with you official Debian +maintainer address. + + 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 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). +BTS 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 +mail. Do not submit bugs as root. +

+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 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., +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. When bugs are closed by new uploads

@@ -1468,19 +1757,21 @@ 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 .changes file to +XXX-done@bugs.debian.org, where XXX is your +bug number. + Lintian reports

-You should periodically get the new 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 @@ -1489,20 +1780,21 @@ 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 then 10 bugs on the same topic at once, it is +If you report more than 10 bugs on the same topic at once, it is recommended that you send a message to -debian-devel@lists.debian.org 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 help +prevent a situation in which several maintainers start filing the same +bug report simultaneously.

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 @@ -1522,117 +1814,120 @@ Most of the descriptions of these packages come from the actual package descriptions themselves. Further information can be found in 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. -

-This package is maintained by Ian Jackson and the - - 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 . -

-This package is maintained by Richard Braakman. + - -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

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

-This package is maintained by Joey Hess. +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.

-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 is now deprecated in +favor of debhelper. However, it's not a bug to use +debmake. + + + yada

-This package is maintained by Santiago Vila. +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. + - 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 -This package is maintained by Manoj Srivastava. +of a package for stable, unstable, and possibly +experimental distributions, along with the other benefits of +a version control system. + - dupload

- -This package is maintained by Heiko Schlittermann. +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. - - - - -This package is maintained by James Troup. - - + fakeroot

- fakeroot simulates root privileges. This enables +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. + + + + devscripts

-The devscripts is a package containing a few wrappers +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 debuild, which is a wrapper around +dpkg-buildpackage. + + + + debget

-We are very excited about this system, since it potentially has so -many uses. Independant development groups can use the system for -different sub-flavors of Debian, which may or may not really be of -general interest (for instance, a flavor of Debian built with gcc -bounds checking). It will also enable Debian to recompile entire -distributions quickly. +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. + + @@ -1647,6 +1942,7 @@ sgml-indent-step:2 sgml-indent-data:nil sgml-parent-document:nil sgml-exposed-tags:nil +sgml-declaration:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: