X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=8d5bbf8118080faf7accad042581e6eecb8149ad;hp=1a491c6db7fb95b49488a9a6e97837e42e5df0af;hb=7f3396f535c65eaf2bb243eaf2587da737ce323e;hpb=dcba6dbc63f59b6aafcfb848df0400666540b272 diff --git a/developers-reference.sgml b/developers-reference.sgml index 1a491c6..8d5bbf8 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -4,14 +4,18 @@ %versiondata; %commondata; - - - + + + + + FIXME: "> + ]>

The procedures discussed within include how to become a maintainer (); how to upload new packages (); and how to handle bug reports ().

The resources discussed in this reference include the mailing lists -and servers (); a discussion of the structure of the -Debian archive (); explanation of the different -servers which accept package uploads (); and a -discussion of resources which can help maintainers with the quality of -their packages (). +() 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 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. @@ -89,19 +96,22 @@ generally agreed-upon best practices. Thus, it is what is called a Applying to Become a Maintainer - Getting started + 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? +So, you've read all the documentation, you've gone through the , +understand what everything in the hello example +package is for, and you're about to Debianize your favorite piece of +software. How do you actually become a Debian developer so that your +work can be incorporated into the Project?

Firstly, subscribe to &email-debian-devel; if you haven't already. Send the word subscribe in the Subject of an email to &email-debian-devel-req;. In case of problems, contact the list administrator at &email-listmaster;. More information on available mailing lists can be found in . +&email-debian-devel-announce; is another list which is mandatory +for anyone who wish to follow Debian's development.

You should subscribe and lurk (that is, read without posting) for a bit before doing any coding, and you should post about your intentions @@ -112,71 +122,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 GnuPG key which +has been signed by an existing Debian maintainer. If your GnuPG 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 GnuPG key. Having your GnuPG +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 @@ -187,9 +195,9 @@ or high-powered spy techniques. See for more 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 .

The recommended public key algorithm for use in Debian development @@ -200,58 +208,46 @@ 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 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 gnupg, are located on ftp sites -outside of the United States. You can find the current locations of -those packages at . -

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 -cryptography qua cryptography in any manner. If you live in a -country where use of cryptography even for authentication is forbidden +products for authentication, rather than encryption purposes. +&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. +To apply as a new maintainer, 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 GnuPG 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 well prepared, you can save +a lot of time later on. - Debian Mentors + Debian mentors and sponsors

The mailing list &email-debian-mentors; has been set up for novice maintainers who seek help with initial packaging and other @@ -260,11 +256,21 @@ 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. +

+In addition, if you have some packages ready for inclusion in Debian, +but are waiting for your new maintainer application to go through, you +might be able find a sponsor to upload your package for you. Sponsors +are people who are official Debian maintainers, and who are willing to +criticize and upload your packages for you. Those who are seeking a +sponsor can request one at . +

+If you wish to be a mentor and/or sponsor, more information is +available in . Debian Developer's Duties - Maintaining Your Debian Information + Maintaining your Debian information

There's a LDAP database containing many informations concerning all developers, you can access it at . You can @@ -275,98 +281,95 @@ 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. +You have to keep the information available there up-to-date. - Maintaining Your Public Key + Maintaining your public key

Be very careful with your private keys. Do not place them on any public servers or multiuser machines, such as -master.debian.org. Back your keys up; keep a copy offline. +&master-host;. Back your keys up; keep a copy offline. Read the documentation that comes with your software; read the .

If you add signatures to your public key, or add user identities, you -can update the debian keyring by sending your key to the key server at +can update the debian key ring by sending your key to the key server at &keyserver-host;. If you need to add a completely new key, or remove an old key, send mail to &email-debian-keyring;. 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. +the documentation of the debian-keyring package. + - Going On Vacation Gracefully + Voting +

+&FIXME; + + + Going on vacation gracefully

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 (see ) your package if a -big problem (release critical bugs, security update, ...) occurs while +big problem (release critical bugs, security update, etc.) 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 +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 + 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. -Rather, you have to forward these bugs to the upstream developers. -(Of course, if you are able to do so, you may certainly fix them...) -This way, the bug will hopefully -be corrected when the next upstream version comes out. +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.

-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 there, so that you won't have to +If you need to modify the upstream sources in order to build a policy +compliant 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 + Managing release-critical bugs

-Release Critical Bugs (RCB) are all bugs that have severity +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 -those bugs needs to be corrected as fast as possible. You must be +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 each time they can. But if +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 justify yourself and present your plan to fix -it by sending a mail to the bug concerned report. Otherwise people +&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 -on the BTS). +in the BTS). - Quality Assurance Effort -

-Even though there is a dedicated group of people for Quality -Assurance, QA duties are not reserved solely to 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 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;). - Retiring Gracefully + Retiring

If you choose to leave the Debian project, you should make sure you do the following steps: @@ -382,11 +385,13 @@ emailing to &email-debian-keyring;. - Mailing Lists, Servers, and Other Machines -

+ + Resources for Debian Developers +

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 main Debian servers, other Debian machines +which may be available to you as a developer, and all the other +resources that are available to help you in your maintainer work. Mailing lists

@@ -409,8 +414,8 @@ 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.

@@ -419,7 +424,10 @@ 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 &email-debian-private; unless it is really necessary. Moreover, do -not forward email from that list to anyone. +not forward email from that list to anyone. Archives of this +list are not available on the web for obvious reasons, but you can see +them using your shell account on &master-host; and looking +in the ~debian/archive/debian-private directory.

&email-debian-email; is a special mailing list used as a grab-bag for Debian related correspondence such as contacting upstream authors @@ -434,6 +442,13 @@ Online archives of mailing lists are available at . + + Documentation +

+&FIXME; + + + Debian servers

Debian servers are well known servers which serve critical functions @@ -450,27 +465,27 @@ id="submit-bug"> for information on how to submit bugs. The master server

-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 &email-debian-devel; before implementing +&master-host; 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 &email-debian-devel; before implementing anything, however, to reduce unnecessary duplication of effort or wasted processing time.

-All Debian developers have accounts on master.debian.org. +All Debian developers have accounts on &master-host;. 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 +If you find a problem with &master-host; such as disk full, suspicious activity, or whatever, send an email to &email-debian-admin;. The ftp-master server

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

Problems with the Debian FTP archive generally need to be reported as @@ -480,7 +495,7 @@ 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 +The main web server, &www-host;, is also known as klecker.debian.org. All developers are given accounts on this machine.

@@ -516,10 +531,21 @@ 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, -Debian account should own the CVS root area, and why you need it. +the Debian account that should own the CVS root area, and why you need it. - Mirrors of Debian servers + The Developers Database +

+The Developers Database, at , is an LDAP +directory for managing Debian developer attributes. You can use this +resource to search the list of Debian developers. For information on +keeping your entry the developer database up-to-date, see . Part of this information is also available through +the finger service on Debian servers, try +finger yourlogin@debian.org to see what it reports. + + + 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 @@ -541,7 +567,7 @@ interested in helping Debian. As such, developers generally do not have accounts on these machines. - Other Debian Machines + Other Debian developer 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 @@ -556,66 +582,61 @@ id="&url-devel-machines;">. - The Debian Archive - - Overview + The Debian archive

-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.). +The &debian-formal; distribution consists of a lot of packages +(.deb's, currently around &number-of-pkgs;) and a few +additional files (such documentation and installation disk images).

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

&sample-dist-dirtree;

As you can see, the top-level directory contains two directories, -dists/ and pool/. The latter is a ``pool'' in which the +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/ +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. +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). +In each of the areas, there is a directory for the source packages +(source) and a directory for each supported architecture +(binary-i386, binary-m68k, etc.).

-The main area 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 -further into subsections. +(disks-i386, disks-m68k, etc.). - Sections + Sections

The main section of the Debian archive is what makes up the -official Debian GNU/Linux distribution. -The main section is official because it fully complies with -all our guidelines. The other two sections do not, to different degrees; -as such, they are not officially part of Debian GNU/Linux. +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 with all other policy requirements as described in the . The DFSG is -our definition of ``free software.'' Check out the Debian Policy +our definition of “free software.” Check out the Debian Policy Manual for details.

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

-Packages which do not apply to the DFSG are placed in the +Packages which do not conform 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 @@ -638,7 +659,7 @@ many on the CD-ROMs as he's allowed to. (Since this varies greatly from vendor to vendor, this job can't be done by the Debian developers.) - Architectures + Architectures

In the first days, the Linux kernel was only available for the Intel i386 (or greater) platforms, and so was Debian. But when Linux became @@ -653,183 +674,183 @@ 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. +arm, ia64, hppa, s390, mips, +mipsel and sh 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 and arm architectures. +sparc architectures. Debian 2.2 added support for the +powerpc and arm architectures. Debian 3.0 adds +support of five new architectures : ia64, hppa, +s390, mips and mipsel.

Information for developers or uses about the specific ports are available at the . - Subsections + - Packages + 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. +Source packages consist of either two or three files: a .dsc +file, and either a .tar.gz file or both an +.orig.tar.gz and a .diff.gz file.

If a package is developed specially for Debian and is not distributed -outside of Debian, there is just one .tar.gz file which +outside of Debian, there is just one .tar.gz file which contains the sources of the program. If a package is distributed -elsewhere too, the .orig.tar.gz file stores the so-called +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 +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 +The .dsc file lists all the files in the source package together with checksums (md5sums) and some additional info about the package (maintainer, version, etc.). - Distribution directories + Distribution directories

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 +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). +(another is /pub/debian).

A distribution is comprised of Debian source and binary packages, and the -respective Sources and Packages index files, containing +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). +pool/ directory, while the latter are kept in the dists/ +directory of the archive (for backwards compatibility). - Stable, testing, unstable, and sometimes frozen + Stable, testing, and unstable

-There is always a distribution 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 +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.

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 +distribution changes from day-to-day. Since no special effort is done to make sure everything in this distribution is working properly, it is -sometimes ``unstable.'' +sometimes literally 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. +The testing distribution is generated automatically by taking +packages from unstable if they satisfy certain criteria. Those +criteria should ensure a good quality for packages within testing. + are launched each day after the +new packages have been installed.

After a period of development, once the release manager deems fit, the -testing distribution is renamed to frozen. Once -that has been done, no changes are allowed to that distribution except -bug fixes; that's why it's called ``frozen.'' After another month or -a little longer, depending on the progress, the frozen distribution +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 frozen distribution is -renamed to stable, overriding the old stable distribution, -which is removed at that time. +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 it 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). +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., ‘3.0’ becomes +‘3.0r1’, ‘2.2r4’ becomes ‘2.2r5’, and +so forth).

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

-In summary, there is always a stable, a testing and an -unstable distribution available, and a frozen distribution -shows up for a couple of months from time to time. - +freeze period, since the unstable distribution remains in +place in parallel with testing. - Experimental - + Experimental

-The experimental distribution is a specialty distribution. +The experimental distribution is a special distribution. It is not a full distribution in the same sense as `stable' and `unstable' are. Instead, it is meant to be a temporary staging area for highly experimental software where there's a good chance that the -software could break your system. Users who download and install +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 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 (it is done with Debian archive maintenance software). -Additionally, you'll have to remember to ask the archive -maintainers to delete the package once you have uploaded it to -unstable. Using your personal web space on -klecker.debian.org is generally a better idea, so that you put -less strain on the Debian archive maintainers. - - - Release code names +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. You should not be afraid to use +experimental since it does not cause any pain to the ftpmasters, +the experimental packages are automatically removed once you upload +the package in unstable with a higher version number. +

+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 +`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. @@ -858,14 +879,338 @@ 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 easily, indicate the currently released stable distribution. That's why the -real distribution directories use the code names, while symbolic -links for stable, testing, unstable, and -frozen point to the appropriate release directories. +real distribution directories use the code names, while +symbolic links for stable, testing, and +unstable point to the appropriate release directories. + + + The Incoming system +

+The Incoming system is responsible of collecting updated packages and +installing them in the Debian archive. It consists of a set of +directories and scripts that are installed both on &ftp-master-host; +and &non-us-host;. +

+Packages are uploaded by all the maintainers into an unchecked +directory. This directory is scanned every 15 minutes by the katie script +that verifies the integrity of the package and the cryptographic +signature. If the package is considered ready to be installed, it +is moved into an accepted directory. If it is the first upload of +the package then it is moved in a new directory waiting an +approval of the ftpmasters. If the package contains files to be installed +"by-hand" is is moved in the byhand directory waiting a manual +installation by the ftpmasters. Otherwise, if any error has been detected, +the package is refused and is moved in the reject directory. +

+Once the package is accepted the system sends a confirmation +mail to the maintainer, closes all the bugs marked as fixed by the upload +and the autobuilders may start recompiling it. The package is now publically +accessible at (there is no +such URL for packages in the non-US archive) until it is really installed +in the Debian archive. This happens only once a day, the package +is then removed from incoming and installed in the pool along with all +the other packages. Once all the other updates (generating new +Packages and Sources index files for example) have been +made, a special script is called to ask all the primary mirrors to update +themselves. +

+All debian developers have write access to the unchecked +directory in order to upload their packages, they also have that access +to the reject directory in order to remove their bad uploads +or to move some files back in the unchecked directory. But +all the other directories are only writable by the ftpmasters, that is +why you can not remove an upload once it has been accepted. + + Delayed incoming +

+The unchecked directory has a special DELAYED +subdirectory. It is itself subdivised in nine directories +called 1-day to 9-day. Packages which are uploaded in +one of those directories will be moved in the real unchecked +directory after the corresponding number of days. +This is done by a script that is run each day and which moves the +packages between the directories. Those which are in "1-day" are +installed in unchecked while the others are moved in the +adjacent directory (for example, a package in 5-day will +be moved in 4-day). This feature is particularly useful +for people who are doing non-maintainer uploads. Instead of +waiting before uploading a NMU, it is uploaded as soon as it is +ready but in one of those DELAYED/x-day directories. +That leaves the corresponding number of days to the maintainer +in order to react and upload himself another fix if he is not +completely satisfied with the NMU. Alternatively he can remove +the NMU by himself. +

+The use of that delayed feature can be simplified with a bit +of integration with your upload tool. For instance, if you use +dupload (see ), you can add this +snippet to your configuration file: + +$delay = ($ENV{DELAY} || 7); +$cfg{'delayed'} = { + fqdn => "&ftp-master-host;", + login => "yourdebianlogin", + incoming => "/org/ftp.debian.org/incoming/DELAYED/$delay-day/", + visibleuser => "yourdebianlogin", + visiblename => "debian.org", + fullname => "Your Full Name", + dinstall_runs => 1, + method => "scpb" +}; + +Once you've made that change, dupload can be used to +easily upload a package in one of the delayed directories: +DELAY=5 dupload --to delayed <changes-file> + + + The testing scripts +

+The testing scripts are run each day after the installation of the +updated packages. They generate the Packages files for +the testing distribution, but they do so in an intelligent manner +trying to avoid any inconsistency and trying to use only +non-buggy packages. +

The inclusion of a package from unstable is conditionned: + + +The package must have been available in unstable for several days; +the precise number depends on the urgency field's value of the upload. It +is 10 days for low urgency, 5 days for medium urgency and 2 days for high +urgency. Those delays may be doubled during a freeze; + +It must have less release-critical bugs than the version available +in testing; + +It must be available on all architectures on which it has been +previously built. may be of interest to +check that information; + +It must not break any dependency of a package that is already available +in testing; + +The packages on which it depends must either be available in testing +or they must be accepted into testing at the same time (and they will +if they respect themselves all the criteria); + +

+The scripts are generating some output files to explain why some packages +are kept out of testing. They are available at . Alternatively, it is possible to use +the grep-excuses program part of the +devscripts package. It can be easily put in a crontab +to keep someone informed of the progression of his packages in testing. +

+The update_excuses file does not always give the precise reason +why the package is refused, one may have to find it by himself by looking +what would break with the inclusion of the package. The gives some more information +about the usual problems which may be causing such troubles. +

+Sometimes, some packages never enter testing because the set of +inter-relationship is too complicated and can not be sorted out +by the scripts. In that case, the release manager must be +contacted, and he will force the inclusion of the packages. + + Package's information +

+ + On the web +

+Each package has several dedicated web pages that contains many +informations. http://&packages-host;/package-name +will display each version of the package +available in the various distributions. The per-version detailed +information includes the package description, +the dependencies and links to download the package. +

+The bug tracking system sorts the bugs by package, you can +watch the bugs of each package at +http://&bugs-host;/package-name. + + The madison utility +

+madison is a command-line utility that is available +on both &ftp-master-host; and &non-us-host;. It +uses a single argument corresponding to a package name. In result +it displays which version of the package is available for each +architecture and distribution combination. An example will explain +it better. +

+ +$ madison libdbd-mysql-perl +libdbd-mysql-perl | 1.2202-4 | stable | source, alpha, arm, i386, m68k, powerpc, sparc +libdbd-mysql-perl | 1.2216-2 | testing | source, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc +libdbd-mysql-perl | 1.2216-2.0.1 | testing | alpha +libdbd-mysql-perl | 1.2219-1 | unstable | source, alpha, arm, hppa, i386, ia64, m68k, mips, mipsel, powerpc, s390, sparc + +

+In this example, you can see that the version in unstable differs from +the version in testing and that there has been a binary-only NMU of the +package for the alpha architecture. Each time the package has been +recompiled on most of the architectures. + + The Package Tracking System +

+The Package Tracking System (PTS) is basically a tool to track by mail +the activity of a source package. You just have to subscribe +to a source package to start getting the mails related to it. +You get the same mails than the maintainer. Each mail +sent through the PTS is classified and associated to one of +the keyword listed below. This will let you select the mails that +you want to receive. +

+By default you will get : + + bts + +All the bug reports and following discussions. + + bts-control + +The control mails notifying a status change in one of the bugs. + + upload-source + +The confirmation mail from katie when an uploaded source +package is accepted. + + katie-other + +Other warning and error mails from katie (like the +override disparity for the section or priority field). + + default + +Any non-automatic mail sent to the PTS by people who wanted to +contact the subscribers of the package. + + summary + +In the future, you may receive regular summary mails to keep you +informed of the package's status (bug statistics, porting overview, +progression in testing, ...). + +

+You can also decide to receive some more information : + + upload-binary + +The confirmation mail from katie when an uploaded binary +package is accepted (to check that your package is recompiled for all +architectures). + + cvs + +CVS commits if the maintainer has setup a system to forward commit +notification to the PTS. + + + The PTS email interface +

+You can control your subscription(s) to the PTS by sending +various commands to pts@qa.debian.org. + + + +subscribe <srcpackage> [<email>] + + Subscribes email to communications related to the source package + srcpackage. Sender address is used if the second argument is + not present. If srcpackage is not a valid source package, + you'll get a warning. However if it's a valid binary package, the PTS + will subscribe you to the corresponding source package. + +unsubscribe <srcpackage> [<email>] + + Removes a previous subscription to the source package srcpackage + using the specified email address or the sender address if the second + argument is left out. + +which [<email>] + + Lists all subscriptions for the sender or the email address optionally + specified. + +keyword [<email>] + + Tells you the keywords that you are accepting. Each mail sent through + the Package Tracking System is associated to a keyword and you receive + only the mails associated to keywords that you are accepting. Here is + the list of available keywords : + + bts : mails coming from the Debian Bug Tracking System + bts-control : reply to mails sent to + control@bugs.debian.org + summary : automatic summary mails about the state of a package + cvs : notification of cvs commits + upload-source : announce of a new source upload that + has been accepted + upload-binary : announce of a new binary-only upload (porting) + katie-other : other mails from ftpmasters + (override disparity, etc.) + default : all the other mails (those which aren't "automatic") + + +keyword <srcpackage> [<email>] + + Same as previous item but for the given source package since + you may select a different set of keywords for each source package. + +keyword [<email>] {+|-|=} <list of keywords> + + Accept (+) or refuse (-) mails associated to the given keyword(s). + Define the list (=) of accepted keywords. + +keyword <srcpackage> [<email>] {+|-|=} <list of keywords> + + Same as previous item but overrides the keywords list for the + indicated source package. + +quit | thanks | -- + + Stops processing commands. All following lines are ignored by + the bot. + + + Filtering PTS mails +

+Once you are subscribed to a package, you will get the mails sent to +srcpackage@packages.qa.debian.org. Those mails +have special headers appended to let you filter them in a special +mailbox with procmail. The added headers are +X-Loop, X-PTS-Package, X-PTS-Keyword and +X-Unsubscribe. +

+Here is an example of added headers for a source upload notification +on the dpkg package : + +X-Loop: dpkg@&pts-host; +X-PTS-Package: dpkg +X-PTS-Keyword: upload-source +X-Unsubscribe: echo 'unsubscribe dpkg' | mail pts@qa.debian.org + + + Forwarding CVS commits in the PTS +

+If you use a publically accessible CVS repository for maintaining +your Debian package you may want to forward the commit notification +to the PTS so that the subscribers (possible co-maintainers) can +closely follow the package's evolution. +

+It's very easy to setup. Once your cvs repository generates commit +notifications, you just have to make sure it sends a copy of those mails +to srcpackage_cvs@&pts-host;. Only people who +accepts the cvs keyword will receive the notifications. - Package uploads + Managing Packages +

+This chapter contains information related to creating, uploading, +maintaining, and porting packages. + + Package uploads - Announcing new packages + New packages

If you want to create a new package for the Debian distribution, you should first check the for more information.

Assuming no one else is already working on your prospective package, -you must then submit a short bug () against the -pseudo package wnpp and send a copy to &email-debian-devel; +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 +from. +

+You should set the subject of the bug to ``ITP: foo -- short description'', substituting the name of the new -package for foo. The severity of the bug report must be -set to wishlist. Please include a Closes: -bug#nnnnn entry on the changelog of the new package in -order for the bug report to be automatically closed once the new -package is installed on the archive (). +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: @@ -910,15 +1262,75 @@ The announcements give maintainers and other interested parties a better feel of what is going on, and what is new, in the project. + + Adding an entry to debian/changelog +

+Changes that you make to the package need to be recorded in the +debian/changelog. These changes should provide a concise +description of what was changed, why (if it's in doubt), and note if +any bugs were closed. They also record when the package was +completed. This file will be installed in +/usr/share/doc/package/changelog.Debian.gz, or +/usr/share/doc/package/changelog.gz for native +packages. +

+The debian/changelog file conforms to a certain structure, +with a number of different fields. One field of note, the +distribution, is described in . More +information about the structure of this file can be found in +the Debian Policy section titled "debian/changelog". +

+Changelog entries can be used to automatically close Debian bugs when +the package is installed into the archive. See . +

+It is conventional that the changelog entry notating of a package that +contains a new upstream version of the software looks like this: + + * new upstream version + +

+There are tools to help you create entries and finalize the +changelog for release — see +and . + + 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. + - Uploading a package - 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 +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.

@@ -930,57 +1342,50 @@ 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. +id="upload-bugfix">. - 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. 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. -

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

By default, dpkg-genchanges and dpkg-buildpackage will include the original source tar file if and only if the Debian revision part of the source version -number is 0 or 1, indicating a new upstream version. This behaviour +number is 0 or 1, indicating a new upstream version. This behavior 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, 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, the new version of the -original source should be uploaded, possibly by using the -sa -flag. +.dsc file and diff to be uploaded must be +byte-for-byte identical with the one already in the archive. + + 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. At -a minimum, you should try the following activities (you'll need to -have an older version of the same 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 truly 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 ("back-porting" +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 to ftp-master + 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 +&ftp-master-host;, 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/. +&upload-queue;. Please note that you should transfer +the changes file last. Otherwise, your upload may be rejected because the +archive maintenance software will parse the changes file and see that not +all files have been uploaded. If you don't want to bother with transferring +the changes file last, you can simply copy your files to a temporary +directory on ftp-master and then move them to +&us-upload-dir;.

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

-You may also find the Debian package dupload useful -when uploading packages. This handy program is distributed with -defaults for uploading via ftp to ftp-master, -chiark, and erlangen. It can also be configured to -use ssh or rsync. See and for more information. -

-After uploading your package, you can check how the archive maintenance -software will process it by running dinstall on your changes -file: dinstall -n foo.changes - - Uploading to non-US (pandora) +Note: Do not upload to ftp-master cryptographic +packages which belong to contrib or non-free. Uploads of +such software should go to non-us (see ). Furthermore packages containing code that is +patent-restricted by the United States government can not be uploaded to +ftp-master; depending on the case they may still be uploaded to +non-US/non-free (it's in non-free because of distribution issues +and not because of the license of the software). If you can't upload it to +ftp-master, then neither can you upload it to the overseas upload +queues on chiark or erlangen. If you are not sure +whether U.S. patent controls or cryptographic controls apply to your +package, post a message to &email-debian-devel; and ask. +

+You may also find the Debian packages or + useful +when uploading packages. These handy programs help automate the +process of uploading packages into Debian. +

+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. +Note that dput can do this for you automatically. + + Uploading to non-US (pandora)

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

-The program dupload comes with support for uploading to -non-us; please refer to the documentation that comes with -the program for details. +to ftp-master. Instead, upload the package to +non-us.debian.org, placing the files in +&non-us-upload-dir; (again, both and can do this for you if invocated properly). 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 &upload-queue;.

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. +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. However, this +restriction has been waived for software which is already available +outside the U.S. Therefore, any cryptographic software which belongs +in the main section of the Debian archive and does not depend +on any package outside of main (e.g., does not depend on +anything in non-US/main) can be uploaded to ftp-master +or its queues, described above.

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 @@ -1112,21 +1539,22 @@ 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. +For packages in non-US/main, non-US/contrib, +developers should at least follow the . Maintainers of +non-US/non-free packages should further consult the 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 + Uploads via chiark

If you have a slow network connection to ftp-master, there are -alternatives. One is to upload files to Incoming via a +alternatives. One is to upload files to Incoming via a upload queue in Europe on chiark. For details connect to .

@@ -1140,18 +1568,18 @@ The program dupload comes with support for uploading to program for details. - Uploads via erlangen + Uploads via erlangen

Another upload queue is available in Germany: just upload the files via anonymous FTP to .

The upload must be a complete Debian upload, as you would put it into -ftp-master's Incoming, i.e., a .changes files -along with the other files mentioned in the .changes. The -queue daemon also checks that the .changes is correctly -PGP-signed by a Debian developer, so that no bogus files can find +ftp-master's Incoming, i.e., a .changes files +along with the other files mentioned in the .changes. The +queue daemon also checks that the .changes is correctly +signed with GnuPG or OpenPGP by a Debian developer, so that no bogus files can find their way to ftp-master via this queue. Please also make sure that -the Maintainer field in the .changes contains +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.

@@ -1171,7 +1599,7 @@ The program dupload comes with support for uploading to the program for details. - Other Upload Queues + Other upload queues

Another upload queue is available which is based in the US, and is a good backup when there are problems reaching ftp-master. You can @@ -1183,14 +1611,14 @@ anonymous FTP to . - Announcing package uploads + 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 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. +the archive maintenance software will contain the OpenPGP/GnuPG 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 @@ -1199,26 +1627,15 @@ send those announcements (check its documentation and look for 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 -where the announcement should go, and will automatically mail the -announcement to the right list. See . - + 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 archive maintenance tools `dak' -(also referred to as katie or dinstall). +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 @@ -1226,12 +1643,16 @@ distribution is handled manually. When uploads are handled manually, the change to the archive may take up to a month to occur. Please be patient.

-In any case, you will receive email notification indicating that the -package has been uploaded. Please examine this notification -carefully. You may notice that the package didn't go into the section -you thought you set it to go into. Read on for why. +In any case, you will receive an email notification indicating that the +package has been 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 + The override file

The debian/control file's Section and Priority fields do not actually specify where the file will @@ -1241,11 +1662,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 @@ -1253,29 +1683,29 @@ name="dpkg-scanpackages" section="8">, &file-bts-mailing;, and - Non-Maintainer Uploads (NMUs) + 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 (see ). Another reason why NMUs are done is when a Debian -developers needs to fix another developers' packages in order to +Debian porters, who compile packages for different architectures, +occasionally do binary-only NMUs as part of their 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. +source and binary-only NMUs, which is explained in the next section. - Terminology + 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. @@ -1283,27 +1713,29 @@ is not the official maintainer of that package. That is why it's a 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 a non-maintainer uploaded binary version of a package -(often for another architecture), with no source changes required. -There are many cases where porters must fix problems in the source in -order to get them to compile for their target architecture; that would -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. - - - Who can do an NMU +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. +

+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

Only official, registered Debian maintainers can do binary or source NMUs. An official maintainer is someone who has their key in the @@ -1314,61 +1746,59 @@ to the Bug Tracking System. Maintainers almost always appreciate quality patches and bug reports. - When to do a source NMU + 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 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. +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, -and if they don't work, it is probably OK to do an NMU: +as a last resort or with permission. The following protocol should +be respected to do an NMU :

-Make sure that the package bug is in the Debian Bug Tracking System -(BTS). If not, submit a bug. +Make sure that the package's bug is in the Debian Bug Tracking System +(BTS). If not, submit a bug. -Email the maintainer, and offer to help fix the package bug. Give it a -few days. - -Go ahead and fix the bug, submitting a patch to the right bug in the -BTS. Build the package and test it as discussed in . Use it locally. - -Wait a couple of weeks for a response. - -Email the maintainer, asking if it is OK to do an NMU. +Wait a few days the response from the maintainer. If you don't get +any response, you may want to help him by sending the patch that fixes +the bug. Don't forget to tag the bug with the "patch" keyword. +Wait a few more days. If you still haven't got an answer from the +maintainer, send him a mail announcing your intent to NMU the package. +Prepare an NMU as described in , test it +carefully on your machine (cf. ). 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. +Make sure your patch is as small and as non-disruptive as it can be. -Wait another week for a response. +Upload your package to incoming in DELAYED/7-day (cf. +), send the final patch to the maintainer via +the BTS, and explain him that he has 7 days to react if he wants to cancel +the NMU. -Go ahead and do the source NMU, as described in . +Follow what happens, you're responsible for any bug that you introduced +with your NMU. You should probably use (PTS) +to stay informed of the state of the package after your NMU. - - - How to do a source NMU + How to do a source NMU

The following applies to porters insofar as they are playing the dual role of being both package bug-fixers and package porters. If a @@ -1387,7 +1817,7 @@ However, aesthetic changes must not be made in a non-maintainer upload. - Source NMU version numbering + Source NMU version numbering

Whenever you have made a change to a package, no matter how trivial, the version number needs to change. This enables our packing system @@ -1418,93 +1848,98 @@ 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'). -

-Remember, porters who are simply recompiling a package for a different -architecture do not need to renumber. Porters should use new version -numbers if and only if they actually have to modify the source package -in some way, i.e., if they are doing a source NMU and not a binary -NMU. +'1' — it's not yet clever enough to know about `0.1'). - + 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 + 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.) +What if you are simply recompiling the package? If you just need to +recompile it for a single architecture, then you may do a binary-only +NMU as described in which doesn't require any +patch to be sent. If you want the package to be recompiled for all +architectures, then you do a source NMU as usual and you will have to +send a patch.

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. Alternatively you can send +that information to the existing bugs that are fixed by your NMU. +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. - Building source NMUs + Building source NMUs

Source NMU packages are built normally. Pick a distribution using the same rules as found in . Just as described in , a normal changes file, etc., will be built. In -fact, all the prescriptions from apply, including -the need to announce the NMU to the proper lists. +fact, all the prescriptions from apply.

Make sure you do not change the value of the maintainer in the debian/control file. Your name as given in the NMU entry of the debian/changelog file will be used for signing the changes file. + Acknowledging an NMU +

+If one of your packages has been NMUed, you have to incorporate the +changes in your copy of the sources. This is easy, you just have +to apply the patch that has been sent to you. Once this is done, you +have to close the bugs that have been tagged fixed by the NMU. You +can either close them manually by sending the required mails to the +BTS or by adding the required closes: #nnnn in the changelog +entry of your next upload. +

+In any case, you should not be upset by the NMU. An NMU is not a +personal attack against the maintainer. It is just the proof that +someone cares enough about the package and was willing to help +you in your work. You should be thankful to him and you may want to +ask him if he would be interested to help you on a more frequent +basis as co-maintainer or backup maintainer +(see ). - - Porting and Being Ported + 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 @@ -1516,23 +1951,25 @@ 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 a single i386 binary package, there must be a -recompile for each architecture, which is amounts to five more builds. +For instance, for a single i386 binary package, there must be +a recompile for each architecture, which amounts to +&number-of-arches; more builds. - Being Kind to Porters + 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. +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 @@ -1540,15 +1977,28 @@ 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 +dependencies mentioned 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. 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. +dpkg-buildpackage. Make sure you don't ship your source package with the debian/files or debian/substvars files. @@ -1564,49 +2014,68 @@ machine, even if it's the same architecture. 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. +``binary-indep'' targets, as the Debian Policy 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 + 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 -that case; it describes how to build and upload your binary NMU so +that case; it describes how to build and upload your binary package 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 +For a porter upload, no 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 package against other packages -which have been updated, such as libraries. You do have to bump the -version number in this case, so that the upgrade system can function -properly. Even so, these are considered binary-only NMUs -- there is -no need in this case for all architectures to recompile. You should -set the version number as in the case of NMU versioning, but add a -``.0.'' before the the NMU version. For instance, a recompile-only -NMU of the source package ``foo_1.3-1'' would be numbered -``foo_1.3-1.0.1''. -

The way to invoke dpkg-buildpackage is as dpkg-buildpackage -B -mporter-email. Of course, set porter-email to your email address. This will do a -binary-only build of only the architecture-dependant portions of the +binary-only build of only the architecture-dependent portions of the package, using the `binary-arch' target in debian/rules. - - + + Recompilation or binary-only NMU +

+Sometimes the initial porter upload is problematic because the environment +in which the package was built was not good enough (outdated or obsolete +library, bad compiler, ...). Then you may just need to recompile it in +an updated environment. However, you have to bump the version number in +this case, so that the old bad package can be replaced in the Debian archive +(katie refuses to install new packages if they don't have a +version number greater than the currently available one). Despite the +required modification of the changelog, these are called 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

Porters doing a source NMU generally follow the guidelines found in @@ -1614,16 +2083,21 @@ 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 — 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, @@ -1650,14 +2124,14 @@ the waiting period. Of course, such locations have no official blessing or status, so buyer, beware. - Tools for Porters + Tools for porters

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

quinn-diff is used to locate the differences from @@ -1666,7 +2140,7 @@ packages need to be ported for architecture Y, based on architecture X. - + buildd

The buildd system is used as a distributed, @@ -1698,7 +2172,7 @@ bounds checking). It will also enable Debian to recompile entire distributions quickly. - + dpkg-cross

dpkg-cross is a tool for installing libraries and @@ -1708,18 +2182,23 @@ headers for cross-compiling in a way similar to enhanced to support cross-compiling. + Collaborative maintenance +

+&FIXME; Speak about Uploaders: field, about the intelligent use +of the PTS. Insist that it's a "must have" for base and standard +packages. - + Moving, Removing, Renaming, Adopting, and Orphaning Packages

-Some archive manipulation operation are not automated in the Debian +Some archive manipulation operations are not automated in the Debian upload process. These procedures should be manually followed by maintainers. This chapter gives guidelines in what to do in these cases. - Moving packages + Moving packages

Sometimes a package will change its section. For instance, a package from the `non-free' section might be GPL'd in a later version, @@ -1732,27 +2211,37 @@ belongs in. If you need to change the section for one of your packages, change the package control information to place the package in the desired section, and re-upload the package (see the for details). Carefully examine the -installation log sent to you when the package is installed into the -archive. If for some reason the old location of the package remains, -file a bug against ftp.debian.org asking that the old -location be removed. Give details on what you did, since it might be -a bug in the archive maintenance software. +name="Debian Policy Manual"> for details). If your new section is +valid, it will be moved automatically. If it does not, then contact +the ftpmasters in order to understand what happened.

If, on the other hand, you need to change the subsection of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly different. Correct the subsection as found in the control -file of the package, and reupload that. Also, you'll need to get the +file of the package, and re-upload that. Also, you'll need to get the override file updated, as described in . - Removing packages + 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 +is an old compatibility library which is no 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. +package should be removed from. Normally, you can only have packages +removed from unstable and experimental. Packages +are not removed from testing directly. Rather, they will be +removed automatically after the package has been removed from +unstable and no package in testing depends on it. +

+You also have to detail the reasons justifying that request. This is to +avoid unwanted removals and to keep a trace of why a package has been +removed. For example, you can provide the name of the package that +supersedes the one to be removed. +

+Usually you only ask the removal of a package maintained by yourself. +If you want to remove another package, you have to get the approval +of its last maintainer.

If in doubt concerning whether a package is disposable, email &email-debian-devel; asking for opinions. Also of interest is the @@ -1760,15 +2249,25 @@ If in doubt concerning whether a package is disposable, email package. When invoked as apt-cache showpkg package, the program will show details for package, including reverse depends. +

+Once the package has been removed, the package's bugs should be handled. +They should either be reassigned to another package in the case where +the actual code has evolved into another package (e.g. libfoo12 +was removed because libfoo13 supersedes it) or closed if the +software is simply no more part of Debian. - Removing packages from Incoming + Removing packages from Incoming

-If you decide to remove a package from Incoming, it is nice -but not required to send a notification of that to the appropriate -announce list (either &email-debian-changes; or -&email-debian-devel-changes;). +In the past, it was possible to remove packages from incoming. +However, with the introduction of the new incoming system, this is no longer +possible. Instead, you have to upload a new revision of your package with +a higher version as the package you want to replace. Both versions will be +installed in the archive but only the higher version will actually be +available in unstable since the previous version will immediately +be replaced by the higher. However, if you do proper testing of your +packages, the need to replace a package should not occur too often anyway. - Replacing or renaming packages + 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 @@ -1777,27 +2276,34 @@ 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. +obsolete name. Do not forget to properly reassign the package's bugs +at the same time. - Orphaning a package + 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. -you should set the package maintainer to Debian QA Group -<debian-qa@lists.debian.org> and submit a bug report -against the pseudo package wnpp. The bug report should be +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 the package is especially -crucial to Debian, you should instead submit a bug against -wnpp and title it RFA: package -- short -description and set its severity to important. You -should also email &email-debian-devel; asking for a new maintainer. +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. RFA stands for Request For Adoption. +Definitely copy the message to debian-devel in this case, as described +above.

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

A list of packages in need of a new maintainer is available at in the 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 package. If you really feel that a maintainer has gone AWOL (absent -without leave), post a query to &email-debian-private;. +without leave), post a query to &email-debian-private;. You may also +inform the QA group (cf. ).

If you take over an old package, you probably want to be listed as the package's official maintainer in the bug system. This will happen automatically once you upload a new version with an updated Maintainer: field, although it can take a few hours after the upload is done. If you do not expect to upload a new version for a while, -send an email to &email-override; so that bug reports will go to you -right away. - - +you can use to get the bug reports. However, +make sure that the old maintainer is not embarassed by the fact that +he will continue to receive the bugs during that time. - Handling Bugs + Handling package 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 + can tell you how +to do this. Some information on filing bugs can be found in . - Monitoring 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 your packages. +You can check them by browsing this page: +http://&bugs-host;/yourlogin@debian.org.

Maintainers interact with the BTS via email addresses at -bugs.debian.org. Documentation on available commands can be +&bugs-host;. Documentation on available commands can be found at , or, if you have installed the doc-debian package, you can look at the local files -/usr/doc/debian/bug-*. +&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 +Replace address with your official Debian maintainer address. - Submitting Bugs + Responding to 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 - 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 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 +Make sure that any discussion you have about bugs are sent both to the original submitter of the bug, and the bug itself (e.g., +123@bugs.debian.org). If you're writing a new +mail and you don't remember the submitter email address, you can +use the 123-submitter@bugs.debian.org email to +contact the submitter and to record your mail within the +bug log (that means you don't need to send a copy of the mail to 123@bugs.debian.org).

-You should never close bugs via the bug server `close' +You should never close bugs via the bug server close command sent to &email-bts-control;. If you do so, the original -submitter will not receive any feedback on why the bug was closed. +submitter will not receive any information about why the bug was +closed. + + Bug housekeeping +

+As a package maintainer, you will often find bugs in other packages or +have bugs reported against your packages which are actually bugs in +other packages. The document the technical operations of the BTS, such as +how to file, reassign, merge, and tag bugs. This section contains +some guidelines for managing your own bugs, based on the collective +Debian developer experience. +

+Filing bugs for problems that you find in other packages is one of +the "civic obligations" of maintainership, see +for details. +

+&FIXME;Talk about tags, forwarding bugs, or else break it into +different sections... - When bugs are closed by new uploads + + When bugs are closed by new uploads

If you fix a bug in your packages, it is your responsibility as the package maintainer to close the bug when it has been fixed. However, @@ -1897,7 +2415,7 @@ acme-cannon (3.1415) unstable; urgency=low * Frobbed with options (closes: Bug#98339) * Added safety to prevent operator dismemberment, closes: bug#98765, bug#98713, #98714. - * Added manpage. Closes: #98725. + * Added man page. Closes: #98725. Technically speaking, the following Perl regular expression is what is @@ -1906,16 +2424,17 @@ used: /closes:\s*(?:bug)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig -The author prefers the (closes: Bug#XXX) syntax, -since it stands out from the rest of the changelog entries. +The author prefers the closes: #XXX syntax, as +one of the most concise and easiest to integrate with the text of the +changelog.

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

You should periodically get the new lintian from `unstable' and check over all your packages. Alternatively you can @@ -1926,10 +2445,87 @@ latest version of the distribution (usually from 'unstable') using the latest lintian. - Reporting lots of bugs at once + + Best Packaging Practices +

+Debian's quality is largely due to its Policy that all packages +follow. But it's also because we accumulated years of experience +in packaging; very talented people created great tools to make +good packages without much troubles. +

+This chapter provides the best known solutions to common problems +faced during packaging. It also lists various advice collected on +several mailing lists. By following them, you will make Debian's quality +even better. + + + Miscellaenous advice + + + Writing useful descriptions +

+The description of the package (as defined by the corresponding field +in the control file) is usually the first information +available to the user before he installs it. As such, it should +provide all the required information to let him decide whether +to install the package. +

+For example, apart from the usual description that you adapt from the +upstream README, you should include the URL of the +website if there's any. If the package is not yet considered stable +by the author, you may also want to warn the user that the +package is not ready for production use. +

+Last but not least, since the first user impression is based on +that description, you should be careful to avoid english +mistakes. Ensure that you spell check it. +ispell has a special option (-g) for that : +ispell -d american -g debian/control + + + + + Beyond Packaging +

+Debian is about a lot more than just packaging software and +maintaining those packages. This chapter contains information about +ways, often really critical ways, to contribute to Debian beyond +simply creating and maintaining packages. +

+As a volunteer organization, Debian relies on the discretion of its +members in choosing what they want to work on, and choosing what is +the most critical thing to spend their time on. + + + Bug Reporting +

+We encourage you to file bugs as you find them in Debian packages. In +fact, Debian developers are often the first line testers. Finding and +reporting bugs in other developer's packages improves the quality of +Debian. +

+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 should +not actually close the bug (unless you secure permission from the +maintainer). +

+From time to time you may want to check what has been going on +with the bug reports that you submitted. Take this opportunity to +close those that you can't reproduce anymore. To find +out all the bugs you submitted, you just have to visit +http://&bugs-host;/from:<your-email-addr>. + + 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 @@ -1948,11 +2544,146 @@ that the bug report is not forwarded to the bug distribution mailing list. - Overview of Debian Maintainer Tools + Quality Assurance effort +

+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 +his packages. Try contacting him yourself. +

+If you do not get a reply after a few weeks you should collect all +useful information about this maintainer. Start by logging into +the +and doing a full search to check whether the maintainer is on vacation +and when he was last seen. Collect any important package names +he maintains 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. + + Contacting other maintainers +

+During your lifetime within Debian, you will have to contact other +maintainers for various reasons. You may want to discuss a new +way of cooperating between a set of related packages, or you may +simply remind someone that a new upstream version is available +and that you need it. +

+Looking up the email address of the maintainer for the package can be +distracting. Fortunately, there is a simple email alias, +<package>@&packages-host;, which provides a way to +email the maintainer, whatever their individual email address (or +addresses) may be. Replace <package> with the name of +a source or a binary package. +

+You may also be interested by contacting the persons who are +subscribed to a given source package via . +You can do so by using the <package-name>@&pts-host; +email address. + + + + Interacting with prospective Debian developers +

+Debian's success depends on its ability to attract and retain new and +talented volunteers. If you are an experienced developer, we +recommend that you get involved with the process of bringing in new +developers. This section describes how to help new prospective +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. +

+If you wish to volunteer as a sponsor, you can sign up at . +

+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 how the applicant is +handling the 'Tasks and Skills' part of their application. + + Managing sponsored packages +

+By uploading a sponsored package to Debian, you are certifying that +the package meets minimum Debian standards. That implies that you +must build and test the package on your own system before uploading. +

+You can not simply upload a binary .deb from the sponsoree. In +theory, you should only ask only for the diff file, and the location of the +original source tarball, and then you should download the source and apply +the diff yourself. In practice, you may want to use the source package +built by your sponsoree. In that case you have to check that he hasn't +altered the upstream files in the .orig.tar.gz file that he's +providing. +

+Do not be afraid to write the sponsoree back and point out changes +that need to be made. It often takes several rounds of back-and-forth +email before the package is in acceptable shape. Being a sponsor +means being a mentor. +

+Once the package meets Debian standards, build the package with +dpkg-buildpackage -us -uc and sign it +with debsign -m <your-email-addr> <changes-file> +before uploading it to the incoming directory. +

+The Maintainer field of the control file and the +changelog should list the person who did the packaging, i.e. the +sponsoree. The sponsoree will therefore get all the BTS mail about the +package. +

+If you prefer to leave a more evident trace of your sponsorship job, you +can add a line stating it in the most recent changelog entry. +

+You are encouraged to keep tabs on the package you sponsor using +. + + 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 -maintainers. These tools are meant to help convenience developers and -free their time for critical tasks. +maintainers. The following is by no means complete or definitive, but +just a guide to some of the more popular tools. +

+Debian maintainer tools are meant to help convenience developers and +free their time for critical tasks. As Larry Wall says, there's more +than one way to do it.

Some people prefer to use high-level package maintenance tools and some do not. Debian is officially agnostic on this issue; any tool @@ -1963,7 +2694,8 @@ endorse any particular tool to the exclusion of a competing tool.

Most of the descriptions of these packages come from the actual package descriptions themselves. Further information can be found in -the package documentation itself. +the package documentation itself. You can also see more info with the +command apt-cache show <package-name>. @@ -1991,14 +2723,18 @@ id="upload-checking"> and .

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

+You can find documentation for this package in the +debconf-doc package. +

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

@@ -2010,10 +2746,14 @@ building binary Debian packages. Programs are included to install various files into your package, compress files, fix file permissions, integrate your package with the Debian menu system.

-Unlike debmake, debhelper is -broken into several small, granular commands which act in a consistent -manner. As such, it allows a greater granularity of control than -debmake. +Unlike some approaches, debhelper is broken into +several small, granular commands which act in a consistent manner. As +such, it allows a greater granularity of control than some of the +other "debian/rules tools". +

+There are a number of little debhelper add-on +packages, too transient to document. You can see the list of most of +them by doing apt-cache search ^dh-. @@ -2032,16 +2772,18 @@ The consensus is that debmake is now deprecated in favor of debhelper. However, it's not a bug to use debmake. + yada

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

-Note that yada is still quite new and possibly not -yet as robust as other systems. +Note that yada is called "essentially unmaintained" +by it's own maintainer, Charles Briscoe-Smith. As such, it can be +considered deprecated. @@ -2072,20 +2814,45 @@ a version control system. dupload

-dupload is a package and a script to automagically +dupload is a package and a script to automatically 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. + + dput +

+The dput package and script does much the same +thing as dupload, but in a different way. It has +some features over dupload, such as the ability to +check the GnuPG signature and checksums before uploading, and the +possibility of running dinstall in dry-run mode after the +upload. + + 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. +fakeroot installed, you can build packages as a +user: dpkg-buildpackage -rfakeroot. + + + + debootstrap +

+The debootstrap package and script allows you to +"bootstrap" a Debian base system into any part of your file-system. +By "base system", we mean the bare minimum of packages required to +operate and install the rest of the system. +

+Having a system like this can be useful in many ways. For instance, +you can chroot into it if you want to test your build +depends. Or, you can test how your package behaves when installed +into a bare base system. @@ -2093,10 +2860,21 @@ install files with root ownership). If you have

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. +packages. Example scripts include debchange and +dch, which manipulate your debian/changelog +file from the command-line, and debuild, which is a +wrapper around dpkg-buildpackage. + + + + + dpkg-dev-el +

+dpkg-dev-el is an Emacs lisp package which provides +assistance when editing some of the files in the debian +directory of your package. For instance, when editing +debian/changelog, there are handy functions for +finalizing a version and listing the package's current bugs. @@ -2104,8 +2882,17 @@ command-line, and debuild, which is a wrapper around

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. +You can use it to download source packages, for instance (although +apt-get source <package-name> does pretty much the same +thing). + +