X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=0b0de53fac9614ff1b7301e56bd6819a400ff0e0;hp=8ff600ef5c98ea6f78e519dcd78c03b1e2c83771;hb=625c7428632213375a778bda2d5b17902b3eed26;hpb=23de232dbf5665c44339e6ec154ed8a6299a2951 diff --git a/developers-reference.sgml b/developers-reference.sgml index 8ff600e..0b0de53 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -5,7 +5,7 @@ %commondata; - + @@ -49,7 +49,7 @@ merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

A copy of the GNU General Public License is available as &file-GPL; in -the Debian GNU/Linux distribution or on the World Wide Web at . You can also obtain it by writing to the &fsf-addr;. @@ -112,71 +112,69 @@ id="mentors"> for details. The IRC channel #debian on the Linux People IRC network (e.g., irc.debian.org) can also be helpful. +

+When you know how you want to contribute to &debian-formal;, you +should get in contact with existing Debian maintainers who are working +on similar tasks. That way, you can learn from experienced developers. +For example, if you are interested in packaging existing software for +Debian you should try to get a sponsor. A sponsor will work together +with you on your package and upload it to the Debian archive once he +is happy with the packaging work you have done. You can find a sponsor +by mailing the &email-debian-mentors; mailing list, describing your +package and yourself and asking for a sponsor (see +for more information on sponsoring). On the other hand, if you are +interested in porting Debian to alternative architectures or kernels +you can subscribe to port specific mailing lists and ask there how to +get started. Finally, if you are interested in documentation or +Quality Assurance (QA) work you can join maintainers already working on +these tasks and submit patches and improvements. + Registering as a Debian developer

-Before you decide to register with the Debian Project, you will need -to read the . Registering as a developer means that you agree with and -pledge to uphold the Debian Social Contract; it is very important that -maintainers are in accord with the essential ideas behind Debian -GNU/Linux. Reading the . It describes exactly the +preparations you have to do before you can register to become a Debian +developer. + +For example, before you apply, you have to to read the . +Registering as a developer means that you agree with and pledge to +uphold the Debian Social Contract; it is very important that +maintainers are in accord with the essential ideas behind +&debian-formal;. Reading the would also be a good idea.

The process of registering as a developer is a process of verifying -your identity and intentions. As the number of people working on -Debian GNU/Linux has grown to over &number-of-maintainers; people and -our systems are used in several very important places we have to be -careful about being compromised. Therefore, we need to verify new -maintainers before we can give them accounts on our servers and -let them upload packages. -

-Registration requires that the following information be sent in -appropriate steps described at -after the initial contact to &email-new-maintainer: +your identity and intentions, and checking your technical skills. As +the number of people working on &debian-formal; has grown to over +&number-of-maintainers; people and our systems are used in several +very important places we have to be careful about being compromised. +Therefore, we need to verify new maintainers before we can give them +accounts on our servers and let them upload packages. +

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

+Registration requires that you are familiar with Debian's philosophy +and technical documentation. Furthermore, you need a GPG key which +has been signed by an existing Debian maintainer. If your GPG key +is not signed yet, you should try to meet a Debian maintainer in +person to get your key signed. There's a which should help you find +a maintainer close to you (If you cannot find a Debian maintainer +close to you, there's an alternative way to pass the ID check. You +can send in a photo ID signed with your GPG key. Having your GPG +key signed is the preferred way, however. See the + for more +information about these two options.) - - -Your name. - -Your preferred login name on master (eight characters or -less), as well as the email address at which you'd prefer to be -subscribed to &email-debian-private; (typically this will be either -your primary mail address or your new debian.org address). - -A phone number where we can call you. Remember that the new -maintainer team usually calls during evening hours to save on long -distance tolls. Please do not give a work number, unless you are -generally there in the evening. - -A statement of intention, that is, what package(s) you intend to work -on, which Debian port you will be assisting, or how you intend to -contribute to Debian. - -A statement that you have read and agree to uphold the . - -Some mechanism by which we can verify your real-life identity. For -example, any of the following mechanisms would suffice: - - -An OpenPGP key signed by any well-known signature, such as: - - -Any current Debian developer you have met in real life. - -Any formal certification service (such as Verisign, etc.) that -verifies your identity. A certification that verifies your email -address, and not your 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,7 +185,7 @@ 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 . @@ -200,55 +198,43 @@ 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 +the case in France). &debian-formal; does not require the use of cryptography qua cryptography in any manner. If you live in a country where use of cryptography even for authentication is forbidden then please contact us so we can make special arrangements.

-Once you have all your information ready, and your public key is -available on public key servers, send a message to -&email-new-maintainer; to register as an offical Debian developer so -that you will be able to upload your packages. This message must -contain your name and your valid e-mail address. All the information -discussed above is required after your Application Manager is -assigned. Application Manager is your agent in the registration -process, and you can always ask him about the status of your -application. You can check the as well. +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 GPG key signed and have +already contributed to Debian for a while, you're ready to apply. +You can simply register on our . After you have signed up, your advocate +has to confirm your application. When your advocate has completed +this step you will be assigned an Application Manager who will +go with you through the necessary steps of the New Maintainer process. +You can always check your status on the .

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

-Once this information is received and processed, you should be -contacted with information about your new Debian maintainer account. -If you don't hear anything within a month, please send a followup -message asking if your original application was received. Do -not re-send your original application, that will just confuse -the New Maintainer Group. Please be patient, especially near release -points; mistakes do occasionally happen, and people do sometimes run -out of volunteer time. +Maintainer's Corner"> at the Debian web site. Make sure that you +are familiar with the necessary steps of the New Maintainer process +before actually applying. If you are well prepared, you can save +a lot of timer later on. Debian Mentors @@ -275,7 +261,7 @@ 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. @@ -368,6 +354,22 @@ id="orphaning">). 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

If you choose to leave the Debian project, you should make sure you do @@ -411,8 +413,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.

@@ -421,7 +423,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 master.debian.org 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 @@ -472,7 +477,7 @@ full, suspicious activity, or whatever, send an email to

The ftp-master server, ftp-master.debian.org (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 @@ -562,7 +567,7 @@ id="&url-devel-machines;">. Overview

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

@@ -601,10 +606,11 @@ further into subsections. 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 @@ -657,7 +663,7 @@ also have ports underway to non-Linux kernel. Aside from alpha, powerpc, sparc, hurd-i386, and arm, as of this writing.

-Debian GNU/Linux 1.3 is only available as i386. Debian 2.0 +&debian-formal; 1.3 is only available as i386. Debian 2.0 shipped for i386 and m68k architectures. Debian 2.1 ships for the i386, m68k, alpha, and sparc architectures. Debian 2.2 adds support for the @@ -726,9 +732,9 @@ the header information from all those packages. The former are kept in the directory of the archive (because of backwards compatibility). - Stable, testing, unstable, and sometimes frozen + Stable, testing, and unstable

-There is always a distribution called stable (residing in +There are always distributions called stable (residing in dists/stable), one called testing (residing in dists/testing), and one called unstable (residing in dists/unstable). This reflects the development process of the @@ -744,48 +750,46 @@ sometimes ``unstable.''

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

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

Note that development under unstable continues during the ``freeze'' period, since the unstable distribution remains in -place 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. - +place in parallel with testing. Experimental

@@ -859,14 +863,14 @@ 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. Package uploads - Announcing 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 +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 conform 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

@@ -998,16 +1035,10 @@ The Distribution field, which originates from the first line of the debian/changelog file, indicates which distribution the package is intended for.

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

-These values can be combined, but only a few combinations make sense. -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 uploading to -frozen. -

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). @@ -1017,6 +1048,7 @@ upload to stable. It never makes sense to combine the experimental distribution with anything else. + + Uploading to stable

@@ -1105,25 +1139,33 @@ To upload a package, you need a personal account on official maintainer. If you use scp or rsync to transfer the files, place them into &us-upload-dir;; if you use anonymous FTP to upload, place them into -/pub/UploadQueue/. +/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 +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 +containing software that is patent-restricted by the United States +government, nor any cryptographic packages which belong to +contrib or non-free. If you can't upload it to +ftp-master, then neither can you upload it to the overseas +upload queues on chiark or erlangen. Uploads of +such software should go to non-us (see ). 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 package dupload useful -when uploading packages. This handy program is distributed with +You may also find the Debian packages dupload or +dput useful +when uploading packages. These handy program are distributed with defaults for uploading via ftp to ftp-master, -chiark, and erlangen. It can also be configured to +chiark, and erlangen. They can also be configured to use ssh or rsync. See and for more information. +section="1">, 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 @@ -1132,25 +1174,28 @@ file: dinstall -n foo.changes Uploading to non-US (pandora)

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

-The program dupload comes with support for uploading to -non-us; please refer to the documentation that comes with -the program for details. +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, +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/.

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 @@ -1158,11 +1203,12 @@ 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 @@ -1245,7 +1291,7 @@ 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.

The dupload program is clever enough to determine @@ -1372,7 +1418,7 @@ quality patches and bug reports. When to do a source NMU

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

@@ -1384,12 +1430,12 @@ maintainer cannot provide a fixed package fast enough or if he/she 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, @@ -1515,28 +1561,27 @@ porters who have to do recompiles — chalk it up as a weakness in how we maintain our archive.)

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

-The normal maintainer will either apply the patch or employ an -alternate method of fixing the problem. Sometimes bugs are fixed -independently upstream, which is another good reason to back out an -NMU's patch. If the maintainer decides not to apply the NMU's patch -but to release a new version, the maintainer needs to ensure that the -new upstream version really fixes each problem that was fixed in the -non-maintainer release. +these bugs should be tagged fixed in the Bug Tracking +System rather than closed. By convention, only the official package +maintainer or the original bug submitter are allowed to close bugs. +Fortunately, Debian's archive system recognizes NMUs and thus marks +the bugs fixed in the NMU appropriately if the person doing the NMU +has listed all bugs in the changelog with the Closes: +bug#nnnnn syntax (see for +more information describing how to close bugs via the changelog). +Tagging the bugs fixed ensures that everyone knows that the +bug was fixed in an NMU; however the bug is left open until the +changes in the NMU are incorporated officially into the package by +the official package maintainer. +

+Also, after doing an NMU, you have to open a new bug and include a +patch showing all the changes you have made. The normal maintainer +will either apply the patch or employ an alternate method of fixing +the problem. Sometimes bugs are fixed independently upstream, which +is another good reason to back out an NMU's patch. If the maintainer +decides not to apply the NMU's patch but to release a new version, +the maintainer needs to ensure that the new upstream version really +fixes each problem that was fixed in the non-maintainer release.

In addition, the normal maintainer should always retain the entry in the changelog file documenting the non-maintainer upload. @@ -1699,11 +1744,16 @@ 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. @@ -1848,10 +1898,14 @@ package. When invoked as apt-cache showpkg 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. +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

@@ -1925,16 +1979,16 @@ Maintainers interact with the BTS via email addresses at bugs.debian.org. Documentation on available commands can be found at , or, if you have installed the 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 you official Debian maintainer address. Submitting Bugs @@ -2044,7 +2098,7 @@ list. This chapter describes procedures that existing Debian developers should follow when it comes to dealing with wannabe 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 @@ -2081,8 +2135,12 @@ Application Managers"> 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 @@ -2093,7 +2151,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. @@ -2121,14 +2180,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 +independant, 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. +

@@ -2140,10 +2203,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-. @@ -2162,16 +2229,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. @@ -2208,14 +2277,39 @@ 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 filesystem. +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. @@ -2223,10 +2317,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. @@ -2234,8 +2339,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 does pretty much the same +thing). + +