X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=7ffd5c16c05f8d8e0e29f6ff3e74aed266afbacf;hp=b08860ffa4ef06abfd31bec874ef0f92508f5514;hb=02df06e8fae995ed8a27b50ff716cb5da1c1c95f;hpb=bd99118696fe5af028d49b13ec7cafeb45de6195 diff --git a/developers-reference.sgml b/developers-reference.sgml index b08860f..7ffd5c1 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -5,7 +5,7 @@ %commondata; - + @@ -30,11 +30,11 @@ Adam Di Carlo, current maintainer aph@debian.org Christian Schwarz schwarz@debian.org Ian Jackson ijackson@gnu.ai.mit.edu - ver. &version;, &date; + ver. &version;, &date-en; -copyright ©1998, 1999 Adam Di Carlo +copyright ©1998 &ndash 2001 Adam Di Carlo copyright ©1997, 1998 Christian Schwarz

@@ -49,7 +49,7 @@ 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 &file-GPL; in -the Debian GNU/Linux distribution or on the World Wide Web at . You can also obtain it by writing to the &fsf-addr;. @@ -76,16 +76,15 @@ 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 . +details of the Debian package nor how to generate Debian packages. +Nor does this reference detail the standards to which Debian software +must comply. All of such information can 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. +policy. It contains documentation for the Debian system and +generally agreed-upon best practices. Thus, it is what is called a +``normative'' document. Applying to Become a Maintainer @@ -113,71 +112,69 @@ id="mentors"> for details. The IRC channel #debian on the Linux People IRC network (e.g., irc.debian.org) can also be helpful. +

+When you know how you want to contribute to &debian-formal;, you +should get in contact with existing Debian maintainers who are working +on similar tasks. That way, you can learn from experienced developers. +For example, if you are interested in packaging existing software for +Debian you should try to get a sponsor. A sponsor will work together +with you on your package and upload it to the Debian archive once he +is happy with the packaging work you have done. You can find a sponsor +by mailing the &email-debian-mentors; mailing list, describing your +package and yourself and asking for a sponsor (see +for more information on sponsoring). On the other hand, if you are +interested in porting Debian to alternative architectures or kernels +you can subscribe to port specific mailing lists and ask there how to +get started. Finally, if you are interested in documentation or +Quality Assurance (QA) work you can join maintainers already working on +these tasks and submit patches and improvements. + 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 . It describes exactly the +preparations you have to do before you can register to become a Debian +developer. + +For example, before you apply, you have to 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-formal;. 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 &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 in -appropriate steps described at -after the initial contact to &email-new-maintainer: +your identity and intentions, and checking your technical skills. As +the number of people working on &debian-formal; 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 let them upload packages. +

+Before you actually register you should have shown that you can do +competent work and will be a good contributor. You can show this by +submitting patches through the Bug Tracking System or having a package +sponsored by an existing maintainer for a while. Also, we expect that +contributors are interested in the whole project and not just in +maintaining their own packages. If you can help other maintainers by +providing further information on a bug or even a patch, then do so! +

+Registration requires that you are familiar with Debian's philosophy +and technical documentation. Furthermore, you need a GPG key which +has been signed by an existing Debian maintainer. If your GPG key +is not signed yet, you should try to meet a Debian maintainer in +person to get your key signed. There's a which should help you find +a maintainer close to you (If you cannot find a Debian maintainer +close to you, there's an alternative way to pass the ID check. You +can send in a photo ID signed with your GPG key. Having your GPG +key signed is the preferred way, however. See the + for more +information about these two options.) - - -Your name. - -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 &email-debian-private; (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 -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 -contribute to Debian. - -A statement that you have read and agree to uphold the . - -Some mechanism by which we can verify your real-life identity. For -example, any of the following mechanisms would suffice: - - -An OpenPGP 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 -address, and not you identity, is not sufficient. - - -Alternatively, you may identify yourself with a scanned (or physically -mailed) copy of any formal documents certifying your identity (such as -a birth certificate, national ID card, U.S. Driver's License, etc.). -If emailed, please sign the mail with your OpenPGP key. - -

If you do not have an OpenPGP key yet, generate one. Every developer needs a OpenPGP key in order to sign and verify package uploads. You @@ -185,10 +182,10 @@ should read the manual for the software you are using, 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. See for more -information on maintianing your public key. +information on maintaining your public key.

Debian uses the GNU Privacy Guard (package -gnupg version 1 or better as its baseline standard. +gnupg version 1 or better) as its baseline standard. You can use some other implementation of OpenPGP as well. Note that OpenPGP is a open standard based on . @@ -201,13 +198,6 @@ much less secure. Your key must be signed with at least your own user ID; this prevents user ID tampering. gpg does this automatically.

-Also remember that one of the names on your key must match the email -address you list as the official maintainer for your packages. For -instance, I set the maintainer of the -developers-reference package to ``Adam Di Carlo -<aph@debian.org>''; therefore, one of the user IDs on my key is -that same value, ``Adam Di Carlo <aph@debian.org>''. -

If your public key isn't on public key servers such as &pgp-keyserv;, please read the documentation available locally in &file-keyservs;. That document contains instructions on how to put your key on the @@ -223,33 +213,33 @@ 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 authentication, rather than encryption purposes (as is -the case in France). The Debian Project does not require the use of +the case in France). &debian-formal; 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 -&email-new-maintainer; to register as an offical Debian developer so -that you will be able to upload your packages. This message must -contain your name and your valid e-mail address. All the information -discussed above is required after your Application Manager is -assigned. Application Manager is your agent in the registration -process, and you can always ask him about the status of your -application. You can check the as well. +When you are ready to apply, you need an existing Debian maintainer +to verify your application (an advocate). After you have +contributed to Debian for a while, and you want to apply to become a +registered developer, an existing developer with whom you +have worked over the past months has to express his belief that you +can contribute to Debian successfully. +

+When you have found an advocate, have your GPG key signed and have +already contributed to Debian for a while, you're ready to apply. +You can simply register on our . After you have signed up, your advocate +has to confirm your application. When your advocate has completed +this step you will be assigned an Application Manager who will +go with you through the necessary steps of the New Maintainer process. +You can always check your status on the .

For more details, please consult at the Debian web site. -

-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 a month, 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 Group. Please be patient, especially near release -points; mistakes do occasionally happen, and people do sometimes run -out of volunteer time. +Maintainer's Corner"> at the Debian web site. Make sure that you +are familiar with the necessary steps of the New Maintainer process +before actually applying. If you are prepared well, you can save +a lot of timer later on. Debian Mentors @@ -270,13 +260,13 @@ post to that list and an experienced developer will volunteer to help. There's a LDAP database containing many informations concerning all developers, you can access it at . You can update your password (this password is propagated to most of the machines -that are accessible to you), your adress, your country, the latitude and -longitude from the point where you live, phone and fax numbers, your +that are accessible to you), your address, your country, the latitude and +longitude of the point where you live, phone and fax numbers, your preferred shell, your IRC nickname, your web page and the email that you're using as alias for your debian.org email. Most of the information is not accessible to the public, for more details about this database, please read its online documentation that you can find -here : . +at .

You have to keep the information available there up to date. @@ -299,65 +289,91 @@ the documentation for the debian-keyring package. Going On Vacation Gracefully

-Most of the developers take vacation, usually this means that they can't +Most developers take vacations, and usually this means that they can't work for Debian and they can't be reached by email if any problem occurs. The other developers need to know that you're on vacation so that they'll do whatever is needed when such a problem occurs. Usually this means that -other developers are allowed to NMU your package if a big problem (release -critical bugs, security update, ...) occurs while you're on vacation. +other developers are allowed to NMU (see ) your package if a +big problem (release critical bugs, security update, ...) occurs while +you're on vacation.

In order to inform the other developers, there's two things that you should do. First send a mail to &email-debian-private; giving the period of time when -you will be on vacation, you can also give some special instructions on what to -do if any problem occurs. Next you should update your information -available in the Debian LDAP database and mark yourself as « on vacation » +you will be on vacation. You can also give some special instructions on what to +do if any problem occurs. Be aware that some people don't care for vacation +notices and don't want to read them; you should prepend "[VAC] " to the +subject of your message so that it can be easily filtered. +

+Next you should update your information +available in the Debian LDAP database and mark yourself as ``on vacation'' (this information is only accessible to debian developers). Don't forget -to remove the « on vacation » flag when you come back. +to remove the ``on vacation'' flag when you come back! Coordination With Upstream Developers

A big part of your job as Debian maintainer will be to stay in contact -with the upstream developers since you'll have to share information that -you get from the Bug Tracking System. It's not your job to fix non-Debian -specific bugs so you have to forward the bugs to the upstream developers -(of course, if you are able to fix them, you can ...). This way the bug -may be corrected when the next upstream version comes out. From time to -time, you may get a patch attached to a bug report, you have to send the -patch upstream and make sure that it gets included (if the authors accept -the proposed fix). If you need to modify the upstream sources in order to -build a policy conformant package, then you should propose a nice fix -to the upstream developers which can be included so that you won't have to +with the upstream developers. Debian users will sometimes report bugs +to the Bug Tracking System that are not specific to Debian. You +must forward these bug reports to the upstream developers so that +they can be fixed in a future release. It's not your job to fix +non-Debian specific bugs. However, if you are able to do so, you are +encouraged to contribute to upstream development of the package by +providing a fix for the bug. Debian users and developers will often +submit patches to fix upstream bugs, and you should evaluate and +forward these patches upstream. +

+If you need to modify the upstream sources in order to build a policy +conformant package, then you should propose a nice fix to the upstream +developers which can be included there, so that you won't have to modify the sources of the next upstream version. Whatever changes you need, always try not to fork from the upstream sources. Managing Release Critical Bugs

-Release Critical Bugs (RCB) are the bugs of severity « critical », -« grave » and « important ». Those bugs can delay -the Debian release and/or can justify the removal of a package at freeze -time. That's why those bugs needs to be corrected as fast as possible. -You must be aware that some developers who are part of the effort are following -those bugs and try to help you each time they can. But if you can't -fix such bugs within 2 weeks, you should either ask for help by sending a -mail to the Quality Assurance (QA) group (&email-debian-qa;) or -justify yourself and gives your plan to fix it by sending a mail to the -concerned bug report. Otherwise people from the QA group may want to do a -Non Maintainer Upload (NMU) after trying to contact you (they might wait -not as long as usually before they do their NMU if they have seen no -recent activity from you on the BTS). +Release Critical Bugs (RCB) are all bugs that have severity +critical, grave or serious. +Those bugs can delay the Debian release +and/or can justify the removal of a package at freeze time. That's why +these bugs need to be corrected as quickly as possible. You must be +aware that some developers who are part of the effort are +following those bugs and try to help you whenever they are able. But if +you can't fix such bugs within 2 weeks, you should either ask for help +by sending a mail to the Quality Assurance (QA) group +&email-debian-qa;, or explain your difficulties and present a plan to fix +them by sending a mail to the proper bug report. Otherwise, people +from the QA group may want to do a Non-Maintainer Upload (see +) after trying to contact you (they might not wait as long as +usual before they do their NMU if they have seen no recent activity from you +in the BTS). Quality Assurance Effort

-Even if there is a dedicated group of people for Quality Assurance, QA is -not reserved to them. You can participate to this effort by keeping your -packages as bug free as possible, as lintian-clean (see ) as possible. If you think that it's quite impossible, -then you should consider orphaning (see ) some of your -packages so that you can do a good job with the other packages that you -maintain. Alternatively you may ask the help of other people in order to -catch up the backlog of bugs that you have (you can ask for help on -&email-debian-qa; or &email-debian-devel;). +Even though there is a dedicated group of people for Quality +Assurance, QA duties are not reserved solely for them. You can +participate in this effort by keeping your packages as bug-free as +possible, and as lintian-clean (see ) as +possible. If you do not find that possible, then you should consider +orphaning some of your packages (see ). Alternatively, you may ask the help of other people +in order to catch up the backlog of bugs that you have (you can ask +for help on &email-debian-qa; or &email-debian-devel;). + + Dealing with unreachable maintainers +

+If you notice that a package is lacking maintenance, you should +make sure the maintainer is active and will continue to work on +their packages. Try contacting them yourself. +

+If you do not get a reply after a few weeks you should collect all +useful information about this maintainer. Start by logging in to +the +and doing a full search to check whether the maintainer is on vacation +and when they were last seen. Collect any important package names +they maintain and any Release Critical bugs filled against them. +

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

@@ -402,12 +418,12 @@ The following are the core Debian mailing lists: &email-debian-devel;, &email-debian-policy;, &email-debian-user;, &email-debian-private;, &email-debian-announce;, and &email-debian-devel-announce;. All developers are expected to be subscribed to at least -&email-debian-private; and &email-debian-devel-announce;. There are -other mailing lists are available for a variety of special topics; see +&email-debian-devel-announce;. There are +other mailing lists available for a variety of special topics; see for a list. Cross-posting (sending the same message to multiple lists) is discouraged.

-&email-debian-private; is a special mailing lists for private +&email-debian-private; is a special mailing list 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 @@ -433,7 +449,7 @@ 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 +If you have a problem with the operation of a Debian server, and you think that the system operators need to be notified of this problem, please find the contact address for the particular machine at . If you have a non-operating problems @@ -474,17 +490,17 @@ an email to &email-ftpmaster;, but also see the procedures in The WWW server

The main web server, www.debian.org, is also known as -va.debian.org. All developers are given accounts on this +klecker.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 va.debian.org. Any material you put in those areas +up on the web, you can do this by putting material in the +public_html directory under your home directory. You should +do this on klecker.debian.org. Any material you put in those areas are accessible via the URL -http://www.debian.org/~user-id/. -If necessary, you can use other Debian machines for this; the procedure -is analogous to the above. Please do not put any material on Debian +http://people.debian.org/~user-id/. +You should only use this particular location because it will be backed up, +whereas on other hosts it won't. Please do not put any material on Debian servers not relating to Debian, unless you have prior permission. Send mail to &email-debian-devel; if you have any questions.

@@ -497,8 +513,8 @@ else has already reported the problem on the The CVS server

-cvs.debian.org is also known as va.debian.org, -discussed above. If you need the use of a publically accessible CVS +cvs.debian.org is also known as klecker.debian.org, +discussed above. If you need to use 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.

@@ -509,8 +525,7 @@ be accessed read-only via the Web at .

To request a CVS area, send a request via email to &email-debian-admin;. Include the name of the requested CVS area, -what va.debian.org user account should own the CVS root area, -and why you need it. +Debian account should own the CVS root area, and why you need it. Mirrors of Debian servers @@ -554,39 +569,50 @@ id="&url-devel-machines;">. Overview

-The Debian GNU/Linux distribution consists of a lot of Debian packages +The &debian-formal; 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: +Here is an example directory tree of a complete Debian archive:

&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 +As you can see, the top-level directory contains two directories, +dists/ and pool/. The latter is a ``pool'' in which the +packages actually are, and which is handled by the archive maintenance +database and the accompanying programs. The former contains the +distributions, stable, testing and unstable. +Each of those distribution directories is divided in equivalent +subdirectories purpose of which is equal, so we will only explain how it +looks in stable. The Packages and Sources files in the +distribution subdirectories can reference files in the pool/ +directory. +

+dists/stable contains three directories, namely main, +contrib, and non-free. +

+In each of the areas, 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 main area 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 +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 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. +The main section of the Debian archive is what makes up the +official &debian-formal; 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-formal;.

Every package in the main section must fully comply with the (DFSG) and @@ -595,16 +621,16 @@ id="&url-debian-policy;" name="Debian Policy 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 contrib section have to comply with the DFSG, +but may fail other requirements. For instance, they may depend on +non-free packages. +

+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. @@ -618,7 +644,7 @@ 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 +many on the CD-ROMs as he's allowed to. (Since this varies greatly from vendor to vendor, this job can't be done by the Debian developers.) @@ -639,11 +665,11 @@ also have ports underway to non-Linux kernel. Aside from alpha, powerpc, sparc, hurd-i386, and arm, as of this writing.

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

Information for developers or uses about the specific ports are available at the . 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 +formally defined, except perhaps the `base' subsection. +Subsections simply exist to simplify the organization and browsing of available packages. Please check the current Debian distribution to see which sections are available. - +

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

@@ -686,34 +716,29 @@ 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). +The directory system described in the previous chapter is itself +contained within distribution directories. Each +distribution is actually contained in the pool directory in the +top-level of the Debian archive itself.

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

-Within that archive root, the actual distributions are contained in -the dists directory. Here is an overview of the layout: +(another is /pub/debian).

- -archive root/dists/distribution/section/architecture/subsection/packages - +A distribution is comprised of Debian source and binary packages, and the +respective Sources and Packages index files, containing +the header information from all those packages. The former are kept in the +pool/ directory, while the latter are kept in the dists/ +directory of the archive (because of backwards compatibility). -Extrapolating from this layout, you know that to find the i386 base -packages for the distribution slink, you would look in -/debian/dists/slink/main/binary-i386/base/. - Stable, unstable, and sometimes frozen + Stable, testing, and unstable

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

@@ -722,97 +747,111 @@ Active development is done in the unstable distribution 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. +to make sure everything in this distribution is working properly, it is +sometimes ``unstable.'' +

+Packages get copied from unstable to testing if they +satisfy certain criteria. To get into testing distribution, a +package needs to be in the archive for two weeks and not have any +release critical bugs. After that period, it will propagate into +testing as soon as anything it depends on is also added. This +process is automatic. You can see some notes on this system as well +as update_excuses (describing which packages are valid +candidates, which are not, and why not) at . +

+After a period of development, once the release manager deems fit, the +testing distribution is frozen, meaning that the policies +which control how packages move from unstable to testing are +tightened. Packages which are too buggy are removed. No changes are +allowed into testing except for bug fixes. After some time +has elapsed, depending on progress, the testing distribution +goes into a `deep freeze', when no changes are made to it except those +needed for the installation system. This is called a ``test cycle'', +and it can last up to two weeks. There can be several test cycles, +until the distribution is prepared for release, as decided by the +release manager. At the end of the last test cycle, the +testing distribution is renamed to stable, +overriding the old stable distribution, which is removed at +that time (although they can be found at archive-host;).

This development cycle is based on the assumption that the unstable distribution becomes stable after passing a -period of 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. - +period of being in testing. Even once a distribution is +considered stable, a few bugs inevitably remain &mdash that's why the +stable distribution is updated every now and then. However, these +updates are tested very carefully and have to be introduced into the +archive individually to reduce the risk of introducing new bugs. You +can find proposed additions to stable in the +proposed-updates directory. Those packages in +proposed-updates that pass muster are periodically moved as a +batch into the stable distribution and the revision level of the +stable distribution is incremented (e.g., `1.3' becomes `1.3r1', +`2.0r2' becomes `2.0r3', and so forth). +

+Note that development under unstable continues during the +``freeze'' period, since the unstable distribution remains in +place in parallel with testing. Experimental

The experimental distribution is a specialty distribution. -It is not a full distribution in the same sense that `stable' and +It is not a full distribution in the same sense as `stable' and `unstable' are. Instead, it is meant to be a temporary staging area for highly experimental software where there's a good chance that the -software could break your system. Users who download and install +software could break your system, or software that's just too unstable +even for the unstable distribution (but there is a reason to +package it nevertheless). 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 -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. +If there is a chance that the software could do grave damage to a system, +it is likely to be better to put it into experimental. +For instance, an experimental compressed file system should probably go +into experimental. +

+Whenever there is a new upstream version of a package that introduces new +features but breaks a lot of old ones, it should either not be uploaded, or +be uploaded to experimental. A new, beta, version of some software +which uses completely different configuration can go into +experimental, at the maintainer's discretion. 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. +

+Some experimental software can still go into unstable, with a few +warnings in the description, but that isn't recommended because packages +from unstable are expected to propagate to testing and +thus to stable. +

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

+An alternative to experimental is to use your personal web space +on people.debian.org (klecker.debian.org). 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 -mirrors to re-retrieve the whole distribution (which is already very -large!). +`hamm'; Debian 2.1, `slink'; Debian 2.2, `potato'; and Debian 3.0, `woody'. There is also +a ``pseudo-distribution'', called `sid', which is the current +`unstable' distribution; since packages are moved from `unstable' to +`testing' as they approach stability, `sid' itself is never released. +As well as the usual contents of a Debian distribution, `sid' contains +packages for architectures which are not yet officially supported or +released by Debian. These architectures are planned to be integrated +into the mainstream distribution at some future date. +

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

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

Thus, the names of the distribution directories in the archive are -determined by their code names and not their release status (i.e., +determined by their code names and not their release status (e.g., `slink'). These names stay the same during the development period and -after the release; symbolic links, which can be changed, are made to +after the release; symbolic links, which can be changed easily, 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. +real distribution directories use the code names, while +symbolic links for stable, testing, and +unstable point to the appropriate release directories. Package uploads @@ -841,33 +880,83 @@ Prospective Packages (WNPP)"> list. Checking the WNPP list ensures that no one is already working on packaging that software, and that effort is not duplicated. Read the for more information. +

+Assuming no one else is already working on your prospective package, +you must then submit a bug report () against the +pseudo package wnpp +describing your plan to create a new package, including, but not +limiting yourself to, a description of the package, the license of the +prospective package and the current URL where it can be downloaded +from. +

+You should set the subject of the bug to ``ITP: foo +-- short description'', substituting the name of the new +package for foo. The severity of the bug report must be set +to wishlist. If you feel it's necessary, send a copy to +&email-debian-devel; by putting the address in the X-Debbugs-CC: header +of the message (no, don't use CC:, because that way the message's subject +won't indicate the bug number). +

+Please include a Closes: bug#nnnnn entry on the +changelog of the new package in order for the bug report to be +automatically closed once the new package is installed on the archive +().

There are a number of reasons why we ask maintainers to announce their intentions: It helps the (potentially new) maintainer to tap into the experience -of people on the list, and lets them know if any one else is working +of people on the list, and lets them know if anyone else is working on it already. It lets other people thinking about working on the package know that -there already is a volunteer, and efforts may be shared. +there already is a volunteer, so efforts may be shared. It lets the rest of the maintainers know more about the package than the one line description and the usual changelog entry ``Initial release'' that gets posted to debian-devel-changes. It is helpful to the people who live off unstable (and form our first -line of testers); we should encourage these people. +line of testers). We should encourage these people. The announcements give maintainers and other interested parties a better feel of what is going on, and what is new, in the project. - Uploading a package + Checking the package prior to upload +

+Before you upload your package, you should do basic testing on it. At +a minimum, you should try the following activities (you'll need to +have an older version of the same Debian package around): + + +Install the package and make sure the software works, or upgrade the +package from an older version to your new version if a Debian package +for it already exists. + +Run lintian 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 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. + + - Generating the changes file + 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 @@ -879,59 +968,56 @@ The changes file is a control file with the following fields: &control-file-fields;

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

-Notably, the Distribution field, which originates from the -debian/changelog file, indicates which distribution the -package is intended for. There are four possible values for this -field: `stable', `unstable', `frozen', or `experimental'; these values -can also be combined. For instance, if you have a crucial security -fix release of a package, and the package has not diverged between the -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 it -never makes sense to combine the experimental distribution with -anything else. Also note that setting the distribution to `stable' means -that the package will be placed into the proposed-updates -directory of the Debian archive for further testing before it is actually -included in stable. The Release Team (which can be reached at -&email-debian-release;) will decide if your package can be included in -stable, therefore if your changelog entry is not clear enough, you may -want to explain them why you uploaded your package to stable by sending -them a short explication. + The original source tarball

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 +upstream version, the original source tar file should be uploaded and +included in the .changes file. Subsequently, this very same tar file should be used to build the new diffs and .dsc -files, and it need not then be uploaded. +files, and will not need to be re-uploaded.

-By default dpkg-genchanges and +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 +If no original source is included in the upload, the original source tar-file used by dpkg-source when constructing the .dsc file and diff to be uploaded must be 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 +is some reason why this is not the case, the new version of the original source should be uploaded, possibly by using the -sa flag. + + Picking a distribution +

+The Distribution field, which originates from the first line of +the debian/changelog file, indicates which distribution the +package is intended for. +

+There are three possible values for this field: `stable', `unstable', +and `experimental'. Normally, packages are uploaded into +unstable. +

+You should avoid combining `stable' with others because of potential +problems with library dependencies (for your package and for the package +built by the build daemons for other architecture). +See for more information on when and how to +upload to stable. +

+It never makes sense to combine the experimental distribution +with anything else. + + - Checking the package prior to upload -

-Before you upload your package, you should do basic testing on it. -Make sure you try the following activities (you'll need to have an -older version of the Debian package around). + Uploading to stable +

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

+Extra care should be taken when uploading to stable. Basically, a +package should only be uploaded to stable if one of the following happens: - -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 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 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. - + a security problem (e.g. a Debian security advisory) + a truely critical functionality problem + the package becomes uninstallable + a released architecture lacks the package + +

+It is discouraged to change anything else in the package that isn't +important, because even trivial fixes can cause bugs later on. Uploading +new upstream versions to fix security problems is deprecated; applying the +specific patch from the new upstream version to the old one ("backporting" +the patch) is the right thing to do in most cases. +

+Packages uploaded to stable need to be compiled on systems running +stable, so that their dependencies are limited to the libraries +(and other packages) available in stable; for example, a package +uploaded to stable that depends on a library package that only +exists in unstable will be rejected. Making changes to dependencies of other +packages (by messing with Provides or shlibs files), possibly making +those other packages uninstallable, is strongly discouraged. +

+The Release Team (which can be reached at &email-debian-release;) will +regularly evaluate the uploads in proposed-updates and decide if +your package can be included in stable. Please be clear (and +verbose, if necessary) in your changelog entries for uploads to +stable, because otherwise the package won't be considered for +inclusion. + + Uploading a package + Uploading to ftp-master

To upload a package, you need a personal account on ftp-master.debian.org, which you should have as an official maintainer. If you use scp or rsync -to transfer the files, place them into &us-upload-dir;; +to transfer the files, place them into &us-upload-dir;; if you use anonymous FTP to upload, place them into /pub/UploadQueue/.

-Note: Do not upload packages containing software that is -export-controlled by the United States government to ftp-master, -nor to the overseas upload queues on chiark or +Note: Do not upload to ftp-master packages +containing software that is export-controlled by the United States +government, nor to the overseas upload queues on chiark or erlangen. This prohibition covers almost all cryptographic software, and even sometimes software that contains ``hooks'' to cryptographic software, such as electronic mail readers that support @@ -1031,28 +1128,50 @@ defaults for uploading via ftp to ftp-master, use ssh or rsync. See and for more information.

-After uploading your package, you can check how dinstall will -process it by running dinstall on your changes file: -/org/ftp.debian.org/scripts/dinstall/dinstall -n foo.changes +After uploading your package, you can check how the archive maintenance +software will process it by running dinstall on your changes +file: dinstall -n foo.changes - Uploading to non-us (pandora) + Uploading to non-US (pandora)

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

The program dupload comes with support for uploading to non-us; please refer to the documentation that comes with the program for details.

-Similar to the way it's done on ftp-master, you can check your -upload with: - -/org/non-us.debian.org/scripts/dinstall/dinstall -n foo.changes - - +You can check your upload the same way it's done on ftp-master, +with: +dinstall -n foo.changes +

+Note that U.S. residents or citizens are subject to restrictions on +export of cryptographic software. As of this writing, U.S. citizens are +allowed to export some cryptographic software, subject to notification +rules by the U.S. Department of Commerce. +

+Debian policy does not prevent upload to non-US by U.S. residents or +citizens, but care should be taken in doing so. It is recommended that +developers take all necessary steps to ensure that they are not +breaking current US law by doing an upload to non-US, including +consulting a lawyer. +

+For packages in non-US main or contrib, developers should at least +follow the . Maintainers of non-US/non-free packages should +further consult these of non-free software. +

+This section is for information only and does not constitute legal +advice. Again, it is strongly recommended that U.S. citizens and +residents consult a lawyer before doing uploads to non-US. + + Uploads via chiark

If you have a slow network connection to ftp-master, there are @@ -1080,14 +1199,14 @@ The upload must be a complete Debian upload, as you would put it into along with the other files mentioned in the .changes. The queue daemon also checks that the .changes is correctly PGP-signed by a Debian developer, so that no bogus files can find -their way to ftp-master via the queue. Please also make sure that +their way to ftp-master via this queue. Please also make sure that the Maintainer field in the .changes contains your e-mail address. The address found there is used for all replies, just as on ftp-master.

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

@@ -1115,29 +1234,24 @@ anonymous FTP to . Announcing package uploads

-When a package is uploaded an announcement should be posted to one of -the ``debian-changes'' lists. This is now done automatically by dinstall -when it runs (usually once a day), you just need to use a recent -dpkg-dev (>= 1.4.1.2). Before that, -dupload was used to send those announcements, please make -sure that you configured your dupload to no more send those -announcements (check its documentation and look for dinstall_runs). The -mail generated by dinstall will contain the PGP/GPG signed .changes files -that you uploaded with your package. +When a package is uploaded, an announcement should be posted to one of +the ``debian-changes'' lists. This is now done automatically by the archive +maintenance software when it runs (usually once a day). You just need to use +a recent dpkg-dev (>= 1.4.1.2). The mail generated by +the archive maintenance software will contain the PGP/GPG signed +.changes files that you uploaded with your package. +Previously, dupload used to send those announcements, so +please make sure that you configured your dupload not to +send those announcements (check its documentation and look for +``dinstall_runs'').

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

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

-The dupload program is clever enough to determine for itself +The dupload program is clever enough to determine where the announcement should go, and will automatically mail the announcement to the right list. See . @@ -1146,18 +1260,22 @@ announcement to the right list. See .

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 +daily basis by the archive maintenance tools, katie. +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). +the change to the archive may take up to a month 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. You may notice that the package didn't go into the section -you thought you set it to go into. Read on for why. +In any case, you will receive email notification indicating that the +package has added to the archive, which also indicates which bugs will +be closed by the upload. Please examine this notification carefully, +checking if any bugs you meant to close didn't get triggered. +

+The installation notification also includes information on what +section the package was inserted into. If there is a disparity, you +will receive a separate email notifying you of that. Read on below. The override file

@@ -1169,11 +1287,20 @@ have control over these fields. The values in the debian/control file are actually just hints.

The archive maintainers keep track of the canonical sections and -priorities for packages in the override file. Sometimes the -override file needs correcting. Simply changing the -package's control file is not going to work. Instead, -you should email &email-override; or submit a bug against -ftp.debian.org. +priorities for packages in the override file. If there is a +disparity between the override file and the package's fields +as indicated in debian/control, then you will receive an +email noting the divergence when the package is installed into the +archive. You can either correct your debian/control file +for your next upload, or else you may wish to make a change in the +override file. +

+To alter the actual section that a package is put in, you need to +first make sure that the debian/control in your package +is accurate. Next, send an email &email-override; or submit a bug +against ftp.debian.org requesting that the section +or priority for your package be changed from the old section or +priority to the new one. Be sure to explain your reasoning.

For more information about override files, see , &file-bts-mailing;, and @@ -1197,38 +1324,41 @@ 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. +source and binary-only NMUs, which is explained in the next section. Terminology

-There are two new terms used throughout this section: ``binary NMU'' +There are two new terms used throughout this section: ``binary-only NMU'' and ``source NMU''. These terms are used with specific technical -meaning throughout this document. Both binary and source NMUs are +meaning throughout this document. Both binary-only and source NMUs are similar, since they involve an upload of a package by a developer who is not the official maintainer of that package. That is why it's a non-maintainer upload.

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

-A binary NMU is a recompilation and upload of a binary package for a -new architecture. As such, it is usually part of a porting effort. A -binary NMU is non-maintainer uploaded binary version of a package -(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 -think ``source NMU'' when they think ``NMU''. So it's best to be -careful. In this chapter, if I use the unqualified term ``NMU'', I -mean both source and binary NMUs. +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. Note, however, that source NMUs may also include +architecture-dependent packages, as well as an updated Debian diff +(or, more rarely, new upstream source as well). +

+A binary-only NMU is a recompilation and upload of a binary package +for a given architecture. As such, it is usually part of a porting +effort. A binary-only NMU is a non-maintainer uploaded binary version +of a package, 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-only 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-only, can be lumped by the +term ``NMU''. However, this often leads to confusion, since most +people think ``source NMU'' when they think ``NMU''. So it's best to +be careful. In this chapter, if we use the unqualified term ``NMU'', +we refer to any type of non-maintainer upload NMUs, whether source and +binary, or binary-only. Who can do an NMU @@ -1245,25 +1375,24 @@ quality patches and bug reports. When to do a source NMU

Guidelines for when to do a source NMU depend on the target -distribution, i.e., stable, unstable, or frozen. Porters have +distribution, i.e., stable, unstable, or experimental. Porters have slightly different rules than non-porters, due to their unique circumstances (see ).

-Only critical changes or security bug fixes make it into stable. When -a security bug is detected a fixed package should be uploaded as soon -as possible. In this case, the Debian Security Managers should get in +When a security bug is detected, a fixed package should be uploaded +as soon as possible. In this case, the Debian security officers get in contact with the package maintainer to make sure a fixed package is uploaded within a reasonable time (less than 48 hours). If the package maintainer cannot provide a fixed package fast enough or if he/she -cannot be reached in time, the Security Manager may upload a fixed +cannot be reached in time, a security officer may upload a fixed package (i.e., do a source NMU).

-During the release freeze (see ), NMUs which -fix important or higher severity bugs are encouraged and accepted. -Even during this window, however, you should endeavor to reach the -current maintainer of the package; they might be just about to upload -a fix for the problem. As with any source NMU, the guidelines found -in need to be followed. +During the release cycle (see ), NMUs which fix +serious or higher severity bugs are encouraged and accepted. Even +during this window, however, you should endeavor to reach the current +maintainer of the package; they might be just about to upload a fix +for the problem. As with any source NMU, the guidelines found 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, @@ -1346,7 +1475,7 @@ the release should start with the debian-revision value 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'). +'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 @@ -1384,33 +1513,32 @@ 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 +probably just doing a binary-only NMU. (Note: this leaves out in the cold +porters who have to do recompiles — chalk it up as a weakness in how we maintain our archive.)

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

-The normal maintainer will either apply the patch or employ an -alternate method of fixing the problem. Sometimes bugs are fixed -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. +these bugs should be tagged fixed in the Bug Tracking +System rather than closed. By convention, only the official package +maintainer or the original bug submitter are allowed to close bugs. +Fortunately, Debian's archive system recognizes NMUs and thus marks +the bugs fixed in the NMU appropriately if the person doing the NMU +has listed all bugs in the changelog with the Closes: +bug#nnnnn syntax (see for +more information describing how to close bugs via the changelog). +Tagging the bugs fixed 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, after doing an NMU, you have to open a new bug and include a +patch showing all the changes you have made. The normal maintainer +will either apply the patch or employ an alternate method of fixing +the problem. Sometimes bugs are fixed 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. @@ -1425,7 +1553,7 @@ fact, all the prescriptions from apply, including the need to announce the NMU to the proper lists.

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/control file. Your name as given in the NMU entry of the debian/changelog file will be used for signing the changes file. @@ -1440,27 +1568,29 @@ is part of your duty as a maintainer to be aware of issues of portability. Therefore, even if you are not a porter, you should read most of this chapter.

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

Porters have a difficult and unique task, since they are required to deal with a large volume of packages. Ideally, every source package -should build right out of the box; unfortunately, this is often not +should build right out of the box. Unfortunately, this is often not the case. This section contains a checklist of ``gotchas'' often -committed by Debian maintainers -- common problems which often stymie -porters, and make their jobs unnecessarily more difficult. +committed by Debian maintainers — common problems which often stymie +porters, and make their jobs unnecessarily 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). +are). Please be tolerant of succinct or even unclear bug reports, +doing your best to hunt down whatever the problem is.

By far, most of the problems encountered by porters are caused by packaging bugs in the source packages. Here is a checklist @@ -1468,12 +1598,23 @@ of things you should check or be aware of. +Make sure that your Build-Depends and +Build-Depends-Indep settings in debian/control +are set properly. The best way to validate this is to use the +debootstrap package to create an unstable chroot +environment. Within that chrooted environment, install the +build-essential package and any package +dependancies mention in Build-Depends and/or +Build-Depends-Indep. Finally, try building your package +within that chrooted environment. +

+See the for instructions on setting build dependencies. + 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. +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 @@ -1491,11 +1632,13 @@ or programs. For instance, you should never be calling programs in be setup in a special way. Try building your package on another machine, even if it's the same architecture. -Don't depend on the package your building already being installed (a +Don't depend on the package you're building already being installed (a sub-case of the above issue). -Don't rely on egcc being available; don't rely on -gcc being a certain version. +Don't rely on the compiler being a certain version, if possible. If +not, then make sure your build dependencies reflect the restrictions, +although you are probably asking for trouble, since different +architectures sometimes standardize on different compilers. Make sure your debian/rules contains separate ``binary-arch'' and ``binary-indep'' targets, as the Debian Packaging Manual requires. @@ -1509,32 +1652,46 @@ try to run dpkg-buildpackage -b.

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 -that case; it describes how to build and upload your binary NMU so +that case; it describes how to build and upload your binary-only NMU so that it is properly installed into the archive. If you do have to patch the package in order to get it to compile for the other architecture, you are actually doing a source NMU, so consult instead.

-In a binary NMU, no real changes are being made to the source. You do +In a binary-only 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.

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

The way to invoke dpkg-buildpackage is as -dpkg-buildpackage -B -mporter-email. Of course, +dpkg-buildpackage -B -eporter-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. + + Recompilation Binary-Only NMU Versioning +

+Sometimes you need to recompile a package against other packages which +have been updated, such as libraries. You do have to bump the version +number in this case, so that the version comparison system can +function properly. Even so, these are considered binary-only NMUs +— there is no need in this case to trigger all other +architectures to consider themselves out of date or requiring +recompilation. +

+Such recompilations require special ``magic'' version numbering, so that +the archive maintenance tools recognize that, even though there is a +new Debian version, there is no corresponding source update. If you +get this wrong, the archive maintainers will reject your upload (due +to lack of corresponding source code). +

+The ``magic'' for a recompilation-only NMU is triggered by using the +third-level number on the Debian part of the version. For instance, +if the latest version you are recompiling against was version +``2.9-3'', your NMU should carry a version of ``2.9-3.0.1''. If the +latest version was ``3.4-2.1'', your NMU should have a version number +of ``3.4-2.1.1''. + When to do a source NMU if you are a porter @@ -1544,23 +1701,28 @@ Porters doing a source NMU generally follow the guidelines found in 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 +uploading to. + +

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 +Firstly, the acceptable waiting period &mdash 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 +submit to the BTS should be of severity `serious' or greater. This ensures that a single source package can be used to compile every supported Debian architecture by release time. It is very important that we have one version of the binary and source package for all @@ -1651,7 +1813,7 @@ cases. Moving packages

-Sometimes a package will change either its section. For instance, a +Sometimes a package will change its section. For instance, a package from the `non-free' section might be GPL'd in a later version, in which case, the package should be moved to `main' or `contrib'. See the If you need to change the section for one of your packages, change the package control information to place the package in the desired -section, and re-upload the package (see the for details). Carefully examine the +section, and re-upload the package (see the for details). Carefully examine the installation log sent to you when the package is installed into the archive. If for some reason the old location of the package remains, file a bug against ftp.debian.org asking that the old location be removed. Give details on what you did, since it might be -a dinstall bug. +a bug in the archive maintenance software.

If, on the other hand, you need to change the subsection of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly different. Correct the subsection as found in the control -file of the package, and reupload that. Also, you'll need to update -the override file, as described in . +file of the package, and reupload that. Also, you'll need to get the +override file updated, as described in . Removing packages @@ -1703,8 +1865,8 @@ announce list (either &email-debian-changes; or Sometimes you made a mistake naming the package and you need to rename it. In this case, you need to follow a two-step process. First, set your debian/control file to replace and conflict with the -obsolete name of the package (see the for details). Once you've uploaded +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. @@ -1712,9 +1874,25 @@ obsolete name. Orphaning a package

If you can no longer maintain a package, you need to inform the others -about that, and see that the package is marked as orphaned. Read -instructions on the for more -information. +about that, and see that the package is marked as orphaned. +you should set the package maintainer to Debian QA Group +&orphan-address; and submit a bug report +against the pseudo package wnpp. The bug report should be +titled O: package -- short description +indicating that the package is now orphaned. The severity of the bug +should be set to normal. If you feel it's necessary, send a copy +to &email-debian-devel; by putting the address in the X-Debbugs-CC: header +of the message (no, don't use CC:, because that way the message's subject +won't indicate the bug number). +

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

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

@@ -1722,10 +1900,10 @@ A list of packages in need of a new maintainer is available at in the . If you wish to take over maintenance of any of the packages listed in the WNPP, please take a look at the aforementioned -page for more information. +page for information and procedures.

It is not OK to simply take over a package that you feel is neglected --- that would be package hijacking. You can, of course, contact the +— 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 @@ -1735,10 +1913,10 @@ without leave), post a query to &email-debian-private;. 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 &email-override; so that bug reports will go to you right away. - +Maintainer: field, although it can take a few hours after the +upload is done. If you do not expect to upload a new version for a while, +send an email to &email-override; so that bug reports will go to you +right away. @@ -1752,16 +1930,16 @@ 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 debian-doc package, you can look at -the local files /usr/doc/debian/bug-*. +found at , or, if you have installed the +doc-debian package, you can look at the local files +&file-bts-docs;.

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 +&cron-bug-report; Replace maintainer-address with you official Debian maintainer address. @@ -1782,7 +1960,7 @@ good job reporting a bug and redirecting it to the proper location. For extra credit, you can go through other packages, merging bugs which are reported more than once, or setting bug severities to `fixed' when they have already been fixed. Note that when you are -neither the bug submitter nor the package maintainer, you are should +neither the bug submitter nor the package maintainer, you should not actually close the bug (unless you secure permission from the maintainer). @@ -1805,10 +1983,10 @@ been accepted into the Debian archive. Therefore, once you get notification that your updated package has been installed into the archive, you can and should close the bug in the BTS.

-If you are using a new version of dpkg-dev and you -do your changelog entry properly, dinstall will close the -bugs automatically. All you have to do is follow a certain syntax -in your debian/changelog file: +If you are using a new version of dpkg-dev and you do +your changelog entry properly, the archive maintenance software will close +the bugs automatically. All you have to do is follow a certain syntax in +your debian/changelog file: acme-cannon (3.1415) unstable; urgency=low @@ -1847,7 +2025,7 @@ latest lintian. Reporting lots of bugs at once

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 +number of different packages &mdash i.e., more than 10 &mdash 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 @@ -1866,6 +2044,47 @@ that the bug report is not forwarded to the bug distribution mailing list. + + Interaction with Prospective Developers + +

+This chapter describes procedures that existing Debian developers should +follow when it comes to dealing with wannabe developers. + + Sponsoring packages +

+Sponsoring a package means uploading a package for a maintainer who is not +able to do it on their own, a new maintainer applicant. Sponsoring a package +also means accepting responsibility for it. +

+New maintainers usually have certain difficulties creating Debian packages +— this is quite understandable. That is why the sponsor is there, to check +the package and verify that it is good enough for inclusion in Debian. +(Note that if the sponsored package is new, the FTP admins will also have to +inspect it before letting it in.) +

+Sponsoring merely by signing the upload or just recompiling is +definitely not recommended. You need to build the source +package just like you would build a package of your own. Remember that it +doesn't matter that you left the prospective developer's name both in the +changelog and the control file, the upload can still be traced to you. +

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

+See the page about at the Debian web site. + + Handling new maintainer applications +

+Please see at the Debian web site. + + + Overview of Debian Maintainer Tools

This section contains a rough overview of the tools available to @@ -1904,6 +2123,21 @@ of Debian policy as well as some checks for common errors. The use of id="upload-checking"> and . + + debconf +

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

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

@@ -1952,7 +2186,7 @@ yet as robust as other systems.

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