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

@@ -76,16 +76,15 @@ discussion of resources which can help maintainers with the quality of their packages ().

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

Furthermore, this document is not an expression of formal -policy. It contains documentation for the Debian system, and -generally agreed-upon best practices. +policy. It contains documentation for the Debian system and +generally agreed-upon best practices. Thus, it is what is called a +``normative'' document. Applying to Become a Maintainer @@ -270,7 +269,7 @@ post to that list and an experienced developer will volunteer to help. There's a LDAP database containing many informations concerning all developers, you can access it at . You can update your password (this password is propagated to most of the machines -that are accessible to you), your adress, your country, the latitude and +that are accessible to you), your address, your country, the latitude and longitude of the point where you live, phone and fax numbers, your preferred shell, your IRC nickname, your web page and the email that you're using as alias for your debian.org email. Most of the information @@ -303,42 +302,42 @@ Most developers take vacations, and usually this means that they can't work for Debian and they can't be reached by email if any problem occurs. The other developers need to know that you're on vacation so that they'll do whatever is needed when such a problem occurs. Usually this means that -other developers are allowed to NMU your package if a big problem (release -critical bugs, security update, ...) occurs while you're on vacation. +other developers are allowed to NMU (see ) your package if a +big problem (release critical bugs, security update, ...) occurs while +you're on vacation.

In order to inform the other developers, there's two things that you should do. First send a mail to &email-debian-private; giving the period of time when you will be on vacation. You can also give some special instructions on what to do if any problem occurs. Next you should update your information -available in the Debian LDAP database and mark yourself as « on vacation » +available in the Debian LDAP database and mark yourself as ``on vacation'' (this information is only accessible to debian developers). Don't forget -to remove the « on vacation » flag when you come back. +to remove the ``on vacation'' flag when you come back. Coordination With Upstream Developers

A big part of your job as Debian maintainer will be to stay in contact -with the upstream developers since you'll have to share information that -you get from the Bug Tracking System. It's not your job to fix non-Debian -specific bugs. -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 +conformant package, then you should propose a nice fix to the upstream +developers which can be included there, so that you won't have to modify the sources of the next upstream version. Whatever changes you need, always try not to fork from the upstream sources. Managing Release Critical Bugs

-Release Critical Bugs (RCB) are the bugs of severity -« critical », « grave » and -« important ». Those bugs can delay the Debian release +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 aware that some developers who are part of the effort are following those bugs and try to help you each time they can. But if you can't fix such bugs within 2 weeks, you should either ask for help by sending a mail to the Quality Assurance (QA) group -(&email-debian-qa;) or justify yourself and present your plan to fix +&email-debian-qa;, or justify yourself and present your plan to fix it by sending a mail to the bug concerned report. Otherwise people -from the QA group may want to do a Non Maintainer Upload (NMU) 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). +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). Quality Assurance Effort

@@ -406,12 +405,7 @@ request to be copied. Anyone who posts to a mailing list should read it to see the responses.

The following are the core Debian mailing lists: &email-debian-devel;, -&email-debian-policy;, &email-debian-user; - - - - -, &email-debian-private;, +&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 @@ -419,7 +413,7 @@ other mailing lists are available for a variety of special topics; see for a list. Cross-posting (sending the same message to multiple lists) is discouraged.

-&email-debian-private; is a special mailing lists for private +&email-debian-private; is a special mailing list for private discussions amongst Debian developers. It is meant to be used for posts which for whatever reason should not be published publically. As such, it is a low volume list, and users are urged not to use @@ -486,17 +480,17 @@ an email to &email-ftpmaster;, but also see the procedures in The WWW server

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

If you have some Debian-specific information which you want to serve up on the web, you can do this by putting material in the -public_html directory under your home directory. You can -do this on va.debian.org. Any material you put in those areas +public_html directory under your home directory. You should +do this on klecker.debian.org. Any material you put in those areas are accessible via the URL -http://www.debian.org/~user-id/. -If necessary, you can use other Debian machines for this; the procedure -is analogous to the above. Please do not put any material on Debian +http://people.debian.org/~user-id/. +You should only use this particular location because it will be backed up, +whereas on other hosts it won't. Please do not put any material on Debian servers not relating to Debian, unless you have prior permission. Send mail to &email-debian-devel; if you have any questions.

@@ -509,7 +503,7 @@ else has already reported the problem on the The CVS server

-cvs.debian.org is also known as va.debian.org, +cvs.debian.org is also known as klecker.debian.org, discussed above. If you need to use a publically accessible CVS server, for instance, to help coordinate work on a package between many different developers, you can request a CVS area on the server. @@ -521,8 +515,7 @@ be accessed read-only via the Web at .

To request a CVS area, send a request via email to &email-debian-admin;. Include the name of the requested CVS area, -what va.debian.org user account should own the CVS root area, -and why you need it. +Debian account should own the CVS root area, and why you need it. Mirrors of Debian servers @@ -570,35 +563,45 @@ The Debian GNU/Linux distribution consists of a lot of Debian packages (.deb's, currently around &number-of-pkgs;) and a few additional files (documentation, installation disk images, etc.).

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

&sample-dist-dirtree;

-As you can see, the top-level directory of the distribution contains -three directories, namely main, contrib, and -non-free. These directories are called sections. -

-In each section, there is a directory with the source packages -(source), a directory for each supported architecture +As you can see, the top-level directory contains two directories, +dists/ and pool/. The latter is a ``pool'' in which the +packages actually are, and which is handled by the archive maintenance +database and the accompanying programs. The former contains the +distributions, stable, testing and unstable. +Each of those distribution directories is divided in equivalent +subdirectories purpose of which is equal, so we will only explain how it +looks in stable. The Packages and Sources files in the +distribution subdirectories can reference files in the pool/ +directory. +

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

+In each of the areas, there is a directory with the source packages +(source), a directory for each supported architecture (binary-i386, binary-m68k, etc.), and a directory for architecture independent packages (binary-all).

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

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

-The main section is what makes up the official Debian -GNU/Linux distribution. The main section is official -because it fully complies with all our guidelines. The other two -sections do not, to different degrees; as such, they are not -officially part of Debian. +The main section of the Debian archive is what makes up the +official Debian 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.

Every package in the main section must fully comply with the (DFSG) and @@ -607,16 +610,16 @@ id="&url-debian-policy;" name="Debian Policy Manual">. The DFSG is our definition of ``free software.'' Check out the Debian Policy Manual for details.

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

Packages which do not apply to the DFSG are placed in the non-free section. These packages are not considered as part of the Debian distribution, though we support their use, and we provide infrastructure (such as our bug-tracking system and mailing lists) for non-free software packages.

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

The contains a more exact definition of the three sections. The above discussion is just an introduction. @@ -655,7 +658,7 @@ Debian GNU/Linux 1.3 is only available as i386. Debian 2.0 shipped for i386 and m68k architectures. Debian 2.1 ships for the i386, m68k, alpha, and sparc architectures. Debian 2.2 adds support for the -powerpc architecture. +powerpc and arm architectures.

Information for developers or uses about the specific ports are available at the Package uploads @@ -855,18 +874,25 @@ not duplicated. Read 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 normal. 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: @@ -907,9 +933,9 @@ The changes file is a control file with the following fields: &control-file-fields;

All of these fields are mandatory for a Debian upload. See the list -of control fields in the for the contents of these fields. You can close -bugs automatically using the Description field, see 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. @@ -921,16 +947,17 @@ Notably, the Distribution field, which originates from the debian/changelog file, indicates which distribution the package is intended for. There are four possible values for this field: `stable', `unstable', `frozen', or `experimental'; these values -can also be combined. For instance, if you have a crucial security -fix release of a package, and the package has not diverged between the -stable and unstable distributions, then you might -put `stable unstable' in the changelog's -Distribution field. Or, if Debian has been frozen, and you +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. Also note that setting the distribution to `stable' means +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 @@ -977,15 +1004,15 @@ some guidelines: Fixes for bugs of severity critical, grave, or -important severity are always allowed for those packages that +serious severity are always allowed for those packages that must exist in the final release -critical, grave, and important bug fixes -are only allowed for non-necessary packages if they don't add any new +critical, grave, and serious bug fixes are +allowed for non-necessary packages but only if they don't add any new features -normal bug fixes are allowed (though discouraged) on all packages if -and only if there are no new features +important, normal and minor bug fixes are allowed (though discouraged) +on all packages if and only if there are no new features wishlist fixes are not allowed (they are, after all, not really bugs) @@ -1060,11 +1087,11 @@ defaults for uploading via ftp to ftp-master, use ssh or rsync. See and for more information.

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

As discussed above, export controlled software should not be uploaded to ftp-master. Instead, use scp or non-anonymous @@ -1076,12 +1103,32 @@ The program dupload comes with support for uploading to non-us; please refer to the documentation that comes with the program for details.

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

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

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

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

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

If you have a slow network connection to ftp-master, there are @@ -1145,10 +1192,10 @@ anonymous FTP to . Announcing package uploads

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

The Debian archive maintainers are responsible for handling package uploads. For the most part, uploads are automatically handled on a -daily basis by an archive maintenance tool called -dinstall. Specifically, updates to existing packages to +daily basis by archive maintenance tools `dak' +(also referred to as katie or dinstall). +Specifically, updates to existing packages to the `unstable' distribution are handled automatically. In other cases, notably new packages, placing the uploaded package into the distribution is handled manually. When uploads are handled manually, -the change to the archive may take up to a week to occur. Please be +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 @@ -1289,7 +1337,7 @@ cannot be reached in time, the Security Manager may upload a fixed package (i.e., do a source NMU).

During the release freeze (see ), NMUs which -fix important or higher severity bugs are encouraged and accepted. +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 @@ -1500,10 +1548,8 @@ of things you should check or be aware of. Don't set architecture to a value other than ``all'' or ``any'' unless you really mean it. In too many cases, maintainers don't follow the -instructions in the . Setting your architecture to ``i386'' -is usually incorrect. +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 @@ -1549,7 +1595,7 @@ In a binary NMU, no real changes are being made to the source. You do not need to touch any of the files in the source package. This includes debian/changelog.

-Sometimes you need to recompile a packages against other packages +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 @@ -1560,7 +1606,7 @@ NMU of the source package ``foo_1.3-1'' would be numbered ``foo_1.3-1.0.1''.

The way to invoke dpkg-buildpackage is as -dpkg-buildpackage -B -mporter-email. Of course, +dpkg-buildpackage -B -eporter-email. Of course, set porter-email to your email address. This will do a binary-only build of only the architecture-dependant portions of the package, using the `binary-arch' target in debian/rules. @@ -1590,7 +1636,7 @@ the porting effort, at the discretion of the porter group. (Remember, none of this is Policy, just mutually agreed upon guidelines.)

Secondly, porters doing source NMUs should make sure that the bug they -submit to the BTS should be of severity `important' or greater. This +submit to the BTS should be of severity `serious' or greater. This ensures that a single source package can be used to compile every supported Debian architecture by release time. It is very important that we have one version of the binary and source package for all @@ -1691,19 +1737,19 @@ 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 +section, and re-upload the package (see the for details). Carefully examine the installation log sent to you when the package is installed into the archive. If for some reason the old location of the package remains, file a bug against ftp.debian.org asking that the old location be removed. Give details on what you did, since it might be -a dinstall bug. +a bug in the archive maintenance software.

If, on the other hand, you need to change the subsection of one of your packages (e.g., ``devel'', ``admin''), the procedure is slightly different. Correct the subsection as found in the control -file of the package, and reupload that. Also, you'll need to update -the override file, as described in . +file of the package, and reupload that. Also, you'll need to get the +override file updated, as described in . Removing packages @@ -1733,8 +1779,8 @@ announce list (either &email-debian-changes; or Sometimes you made a mistake naming the package and you need to rename it. In this case, you need to follow a two-step process. First, set your debian/control file to replace and conflict with the -obsolete name of the package (see the for details). Once you've uploaded +obsolete name of the package (see the for details). Once you've uploaded that package, and the package has moved into the archive, file a bug against ftp.debian.org asking to remove the package with the obsolete name. @@ -1744,15 +1790,20 @@ obsolete name. 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 +&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. Definitely copy the message to debian-devel in this +case, as described above.

Read instructions on the for more information. @@ -1776,10 +1827,10 @@ without leave), post a query to &email-debian-private;. If you take over an old package, you probably want to be listed as the package's official maintainer in the bug system. This will happen automatically once you upload a new version with an updated -Maintainer: field, although it can take a couple of weeks. If -you do not expect to upload a new version for a while, send an email -to &email-override; so that bug reports will go to you right away. - +Maintainer: field, although it can take a few hours after the +upload is done. If you do not expect to upload a new version for a while, +send an email to &email-override; so that bug reports will go to you +right away. @@ -1793,9 +1844,9 @@ packages. The BTS contains all the open bugs against your packages.

Maintainers interact with the BTS via email addresses at bugs.debian.org. Documentation on available commands can be -found at , or, if you have -installed the debian-doc package, you can look at -the local files /usr/doc/debian/bug-*. +found at , or, if you have installed the +doc-debian package, you can look at the local files +/usr/doc/debian/bug-*.

Some find it useful to get periodic reports on open bugs. You can add a cron job such as the following if you want to get a weekly email @@ -1846,10 +1897,10 @@ been accepted into the Debian archive. Therefore, once you get notification that your updated package has been installed into the archive, you can and should close the bug in the BTS.

-If you are using a new version of dpkg-dev and you -do your changelog entry properly, dinstall will close the -bugs automatically. All you have to do is follow a certain syntax -in your debian/changelog file: +If you are using a new version of dpkg-dev and you do +your changelog entry properly, the archive maintenance software will close +the bugs automatically. All you have to do is follow a certain syntax in +your debian/changelog file: acme-cannon (3.1415) unstable; urgency=low @@ -1907,6 +1958,41 @@ that the bug report is not forwarded to the bug distribution mailing list. + + Interaction with prospective developers + +

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

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

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

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

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

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

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

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

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