X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=6a8ecb20c728a22a1bff094cd8190cf12ecf0098;hb=a36d3601c61d548db8a5b9c110dbf85405ba3443;hp=8a32ae87557077b71aca12e31f1079e80c429497;hpb=ab6f9532917a10d325e25779f132ae6fc7a33d83;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index 8a32ae8..6a8ecb2 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. @@ -94,7 +101,7 @@ generally agreed-upon best practices. Thus, it is what is called a 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 favourite piece of +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?

@@ -238,7 +245,7 @@ before actually applying. If you are well prepared, you can save a lot of timer later on. - Debian Mentors and Sponsors + 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 @@ -252,13 +259,16 @@ 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 -critique and upload your packages for you. Sponsorees can request a -sponsors at . +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 @@ -271,9 +281,9 @@ is not accessible to the public, for more details about this database, please read its online documentation that you can find 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 @@ -282,7 +292,7 @@ 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. @@ -290,14 +300,20 @@ 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. - 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. @@ -312,7 +328,7 @@ 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! - 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. Debian users will sometimes report bugs @@ -326,14 +342,14 @@ submit patches to fix upstream bugs, and you should evaluate and forward these patches upstream.

If you need to modify the upstream sources in order to build a policy -conformant package, then you should propose a nice fix to the upstream +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 @@ -350,35 +366,8 @@ from the QA group may want to do a Non-Maintainer Upload (see usual before they do their NMU if they have seen no recent activity from you in the BTS). - 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. - - Retiring Gracefully + Retiring

If you choose to leave the Debian project, you should make sure you do the following steps: @@ -394,8 +383,9 @@ 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. @@ -449,6 +439,13 @@ Online archives of mailing lists are available at . + + Documentation +

+&FIXME; + + + Debian servers

Debian servers are well known servers which serve critical functions @@ -534,7 +531,16 @@ To request a CVS area, send a request via email to Debian account 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 . + + + 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 @@ -556,7 +562,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 @@ -571,20 +577,18 @@ id="&url-devel-machines;">. - The Debian Archive - - Overview + The Debian archive

-The &debian-formal; distribution consists of a lot of Debian packages +The &debian-formal; distribution consists of a lot of packages (.deb's, currently around &number-of-pkgs;) and a few -additional files (documentation, installation disk images, etc.). +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. @@ -611,7 +615,7 @@ The binary-* and source directories are divided further into subsections. - Sections + Sections

The main section of the Debian archive is what makes up the official &debian-formal; distribution. The @@ -624,7 +628,7 @@ 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, @@ -654,7 +658,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 @@ -682,11 +686,11 @@ available at the . - Subsections + Subsections

The sections main, contrib, and non-free are split into subsections to simplify the installation -process and the maintainance of the archive. Subsections are not +process and the maintenance of the archive. Subsections are not formally defined, except perhaps the `base' subsection. Subsections simply exist to simplify the organization and browsing of available packages. Please check the current Debian distribution to @@ -697,7 +701,7 @@ Note however that with the introduction of package pools (see the top-level will eventually cease to exist. They will be kept in the packages' `Section' header fields, though. - Packages + Packages

There are two types of Debian packages, namely source and binary packages. @@ -720,7 +724,7 @@ 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 @@ -740,7 +744,7 @@ the header information from all those packages. The former are kept in the directory of the archive (because of backwards compatibility). - Stable, testing, and unstable + Stable, testing, and unstable

There are always distributions called stable (residing in dists/stable), one called testing (residing in @@ -754,7 +758,7 @@ distribution). Every Debian developer can update his or her packages in this distribution at any time. Thus, the contents of this distribution change from day-to-day. Since no special effort is done to 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 @@ -773,7 +777,7 @@ 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'', +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 @@ -792,14 +796,14 @@ 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). +stable distribution is incremented (e.g., ‘3.0’ becomes ‘3.0r1’, +‘2.2r4’ becomes ‘2.0r5’, and so forth).

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

The experimental distribution is a specialty distribution. It is not a full distribution in the same sense as `stable' and @@ -838,7 +842,7 @@ An alternative to experimental is to use your personal web space on people.debian.org (klecker.debian.org). - Release code names + 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, @@ -876,9 +880,14 @@ symbolic links for stable, testing, and unstable point to the appropriate release directories. - Package Uploads + Managing Packages +

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

If you want to create a new package for the Debian distribution, you should first check the + Adding an entry to debian/changelog

Changes that you make to the package need to be recorded in the @@ -964,7 +973,7 @@ and . - Checking the package prior to upload + 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 @@ -995,7 +1004,7 @@ Remove the package, then reinstall it. - Generating the changes file + Generating the changes file

When a package is uploaded to the Debian FTP archive, it must be accompanied by a .changes file, which gives directions to the @@ -1013,7 +1022,7 @@ automatically using the Description field, see . - The original source tarball + 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 @@ -1024,20 +1033,17 @@ 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. +byte-for-byte identical with the one already in the archive. - Picking a distribution + Picking a distribution

The Distribution field, which originates from the first line of the debian/changelog file, indicates which distribution the @@ -1100,7 +1106,7 @@ fix. --> - Uploading to stable + Uploading to stable

Uploading to stable means that the package will be placed into the proposed-updates directory of the Debian archive for further @@ -1110,7 +1116,7 @@ Extra care should be taken when uploading to stable. Basically, a package should only be uploaded to stable if one of the following happens: a security problem (e.g. a Debian security advisory) - a truely critical functionality problem + a truly critical functionality problem the package becomes uninstallable a released architecture lacks the package @@ -1118,7 +1124,7 @@ package should only be uploaded to stable if one of the following happens: It is discouraged to change anything else in the package that isn't important, because even trivial fixes can cause bugs later on. Uploading new upstream versions to fix security problems is deprecated; applying the -specific patch from the new upstream version to the old one ("backporting" +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 @@ -1138,9 +1144,9 @@ inclusion. - Uploading a package + Uploading a package - Uploading to ftp-master + Uploading to ftp-master

To upload a package, you need a personal account on ftp-master.debian.org, which you should have as an @@ -1150,7 +1156,7 @@ if you use anonymous FTP to upload, place them into /pub/UploadQueue/. 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 transfering +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;. @@ -1179,13 +1185,13 @@ After uploading your package, you can check how the archive maintenance software will process it by running dinstall on your changes file: dinstall -n foo.changes - Uploading to non-US (pandora) + Uploading to non-US (pandora)

As discussed above, export controlled software should not be uploaded to ftp-master. Instead, upload the package to non-us.debian.org, placing the files in &non-us-upload-dir; (both and can be used also, with the right invokation). By default, +id="dput"> can be used also, with the right invocation). By default, you can use the same account/password that works on ftp-master. If you use anonymous FTP to upload, place the files into /pub/UploadQueue/. @@ -1223,7 +1229,7 @@ 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 @@ -1240,7 +1246,7 @@ 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 . @@ -1271,7 +1277,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 @@ -1283,7 +1289,7 @@ 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 @@ -1306,7 +1312,7 @@ 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 @@ -1328,7 +1334,7 @@ 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 @@ -1359,16 +1365,16 @@ 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. @@ -1377,7 +1383,7 @@ This chapter contains information providing guidelines for when and how NMUs should be done. A fundamental distinction is made between source and binary-only NMUs, which is explained in the next section. - Terminology + Terminology

There are two new terms used throughout this section: ``binary-only NMU'' and ``source NMU''. These terms are used with specific technical @@ -1392,8 +1398,7 @@ 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. Note, however, that source NMUs may also include -architecture-dependent packages, as well as an updated Debian diff -(or, more rarely, new upstream source as well). +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 @@ -1412,7 +1417,7 @@ we refer to any type of non-maintainer upload NMUs, whether source and binary, or binary-only. - Who can do an NMU + 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 @@ -1423,7 +1428,7 @@ 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 experimental. Porters have @@ -1476,7 +1481,7 @@ id="nmu-guidelines">. - 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 @@ -1495,7 +1500,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 @@ -1527,46 +1532,36 @@ 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. - + 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-only NMU. (Note: this leaves out in the cold -porters who have to do recompiles — chalk it up as a weakness in how -we maintain our archive.) +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, these bugs should be tagged fixed in the Bug Tracking @@ -1583,25 +1578,25 @@ changes in the NMU are incorporated officially into the package by the official package maintainer.

Also, after doing an NMU, you have to open a new bug and include a -patch showing all the changes you have made. The normal maintainer -will either apply the patch or employ an alternate method of fixing -the problem. Sometimes bugs are fixed independently upstream, which -is another good reason to back out an NMU's patch. If the maintainer -decides not to apply the NMU's patch but to release a new version, -the maintainer needs to ensure that the new upstream version really -fixes each problem that was fixed in the non-maintainer release. +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 @@ -1611,7 +1606,7 @@ changes file. - 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 @@ -1624,11 +1619,11 @@ 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 +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 @@ -1655,7 +1650,7 @@ are set properly. The best way to validate this is to use the debootstrap package to create an unstable chroot environment. Within that chrooted environment, install the build-essential package and any package -dependancies mention in Build-Depends and/or +dependencies mention in Build-Depends and/or Build-Depends-Indep. Finally, try building your package within that chrooted environment.

@@ -1692,43 +1687,46 @@ 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-only 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-only 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.

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

-Sometimes you need to recompile a package against other packages which -have been updated, such as libraries. You do have to bump the version -number in this case, so that the version comparison system can -function properly. Even so, these are considered binary-only NMUs -— there is no need in this case to trigger all other -architectures to consider themselves out of date or requiring -recompilation. +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 do 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 @@ -1744,7 +1742,7 @@ 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 @@ -1765,7 +1763,7 @@ uploaded with no waiting period for the `frozen' distribution.

However, if you are a porter doing an NMU for `unstable', the above guidelines for porting should be followed, with two variations. -Firstly, the acceptable waiting period &mdash the time between when the +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 @@ -1793,14 +1791,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 @@ -1809,7 +1807,7 @@ packages need to be ported for architecture Y, based on architecture X. - + buildd

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

dpkg-cross is a tool for installing libraries and @@ -1853,7 +1851,7 @@ enhanced to support cross-compiling. - + Moving, Removing, Renaming, Adopting, and Orphaning Packages

@@ -1862,7 +1860,7 @@ 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, @@ -1875,27 +1873,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 @@ -1904,7 +1912,7 @@ package. When invoked as apt-cache showpkg package, the program will show details for package, including reverse depends. - Removing packages from Incoming + Removing packages from Incoming

In the past, it was possible to remove packages from incoming. With the introduction of the New Incoming system this is no longer @@ -1915,7 +1923,7 @@ 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 @@ -1926,7 +1934,7 @@ that package, and the package has moved into the archive, file a bug against ftp.debian.org asking to remove the package with the obsolete name. - Orphaning a package + Orphaning a package

If you can no longer maintain a package, you need to inform the others about that, and see that the package is marked as orphaned. @@ -1949,7 +1957,7 @@ 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 Handling Bugs + Handling package bugs - Monitoring bugs + Monitoring bugs

If you want to be a good maintainer, you should periodically check the for your @@ -1999,7 +2007,7 @@ outlining all the open bugs against your packages: Replace address with you official Debian maintainer address. - Submitting Bugs + Submitting bugs

Often as a package maintainer, you find bugs in other packages or else have bugs reported to your packages which need to be reassigned. The @@ -2019,7 +2027,7 @@ 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 + Responding to bugs

Make sure that any discussions you have about bugs are sent both to the original submitter of the bug, and the bug itself (e.g., @@ -2029,7 +2037,25 @@ 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. - When bugs are closed by new uploads + 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 operation 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

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, @@ -2048,7 +2074,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 @@ -2066,7 +2092,7 @@ sufficient to mail the .changes file to bug number. - Lintian reports + Lintian reports

You should periodically get the new lintian from `unstable' and check over all your packages. Alternatively you can @@ -2077,7 +2103,37 @@ latest version of the distribution (usually from 'unstable') using the latest lintian. - Reporting lots of bugs at once + + 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. +

+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). + + Reporting lots of bugs at once

Reporting a great number of bugs for the same problem on a great number of different packages &mdash i.e., more than 10 &mdash is a deprecated @@ -2099,19 +2155,56 @@ that the bug report is not forwarded to the bug distribution mailing list. - - Interaction with Prospective Developers + 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. + + + + + Interacting with prospective Debian developers

-This chapter describes procedures that existing Debian developers should -follow when it comes to dealing with wannabe developers. +Debian's success depends on it's 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 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. @@ -2126,21 +2219,22 @@ changelog and the control file, the upload can still be traced to you.

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

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

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

This section contains a rough overview of the tools available to maintainers. The following is by no means complete or definitive, but @@ -2188,7 +2282,7 @@ id="upload-checking"> and .

debconf provides a consistent interface to configuring packages interactively. It is user interface -independant, 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.

@@ -2279,7 +2373,7 @@ 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. @@ -2310,7 +2404,7 @@ user: dpkg-buildpackage -rfakeroot. debootstrap

The debootstrap package and script allows you to -"bootstrap" a Debian base system into any part of your filesystem. +"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.