X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=21efdba90a06f0d0153083ee39cec7c2023f83cf;hb=005539079f0145f21fe041ed455377fbb280d81d;hp=13f2368ce266b9117e079a85b9742f60af4b0170;hpb=51521555be3ad4f8da4c287ce6afd155a588315c;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index 13f2368..21efdba 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -5,7 +5,7 @@ %commondata; - + @@ -48,11 +48,10 @@ This is distributed in the hope that it will be useful, but 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 -/usr/doc/copyright/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;. +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;. @@ -99,22 +98,19 @@ Debianize your favourite piece of software. How do you actually become a Debian developer so that your work can be incorporated into the Project?

-Firstly, subscribe to debian-devel@lists.debian.org if -you haven't already. Send the word subscribe in the -Subject of an email to -debian-devel-REQUEST@lists.debian.org. In case of -problems, contact the list administrator at -listmaster@lists.debian.org. More information on -available mailing lists can be found in . +Firstly, subscribe to &email-debian-devel; if you haven't already. +Send the word subscribe in the Subject of an email +to &email-debian-devel-req;. In case of problems, contact the list +administrator at &email-listmaster;. More information on available +mailing lists can be found in .

-You should subscribe and lurk for a bit before doing any coding, and -you should post about your intentions to work on something to avoid -duplicated effort. +You should subscribe and lurk (that is, read without posting) for a +bit before doing any coding, and you should post about your intentions +to work on something to avoid duplicated effort.

-Another good list to subscribe to is -debian-mentors@lists.debian.org. See for details. The IRC channel #debian on the -Linux People IRC network (i.e., irc.debian.org) can also be +Linux People IRC network (e.g., irc.debian.org) can also be helpful. @@ -137,17 +133,15 @@ maintainers before we can give them accounts on our servers and letting them upload packages.

Registration requires that the following information be sent to -new-maintainer@debian.org as part of the registration -application: +&email-new-maintainer; as part of the registration application: 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 debian-private@lists.debian.org -(typically this will be either your primary mail address or your new -debian.org address). +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 @@ -159,14 +153,13 @@ 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 . +id="&url-social-contract;" name="Debian Social Contract">. Some mechanism by which we can verify your real-life identity. For example, any of the following mechanisms would suffice: -A PGP key signed by any well-known signature, such as: +An OpenPGP key signed by any well-known signature, such as: Any current Debian developer you have met in real life. @@ -179,41 +172,49 @@ address, and not you identity, is not sufficient. Alternatively, you may identify yourself with a scanned (or physically mailed) copy of any formal documents certifying your identity (such as a birth certificate, national ID card, U.S. Driver's License, etc.). -If emailed, please sign the mail with your PGP key. +If emailed, please sign the mail with your OpenPGP key.

-If you do not have a PGP key yet, generate one. Every developer needs -a PGP key in order to sign and verify package uploads. You should read -the PGP manual, since it has much important information which is -critical to its security. Many more security failures are due to -human error than to software failure or high-powered spy techniques. -

-Our standard is to use pgp version 2.x. You can use -pgp version 5, if and only if you make an RSA key. Note -that we are also working with the gpg team so that we can -have a free alternative to PGP; however, this may take a little bit of -time. -

-Your PGP key must be at least 1024 bits long. There is no reason to -use a smaller key, and doing so would be much less secure. Your key -must be signed with at least your own user ID. This prevents user ID -tampering. You can do it by executing pgp -ks -your_userid. -

-If your PGP key isn't on public key servers such as -&pgp-keyserv;, please read the documentation available -locally /usr/doc/pgp/keyserv.doc. 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. +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 +should read the manual for the software you are using, since it has +much important information which is critical to its security. Many +more security failures are due to human error than to software failure +or high-powered spy techniques. See for more +information on maintianing your public key. +

+Debian uses the GNU Privacy Guard (package +gnupg version 1 or better as its baseline standard. +You can use some other implementation of OpenPGP as well. Note that +OpenPGP is a open standard based on . +

+The recommended public key algorithm for use in Debian development +work is the DSA (sometimes call ``DSS'' or ``DH/ElGamal''). Other key +types may be used however. Your key length must be at least 1024 +bits; there is no reason to use a smaller key, and doing so would be +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 PGP, have been moved to an ftp site outside of the -United States. You can find the current locations of those packages on -ftp.debian.org or -ftp.us.debian.org in the -/pub/debian/README.non-US file. +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 @@ -226,55 +227,132 @@ 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 -new-maintainer@debian.org to register as an offical -Debian developer so that you will be able to upload your packages. -This message must contain all the information discussed above. The -message must also contain your PGP or RSA public key (extracted using -pgp -kxa in the case of PGP) for the database of keys which -is distributed from ftp.debian.org in -/pub/debian/doc/debian-keyring.tar.gz, or the -debian-keyring package. Please be sure to sign -your request message with your chosen public key. +&email-new-maintainer; to register as an offical Debian developer so +that you will be able to upload your packages. This message must +contain all the information discussed above. The message must also +contain your public key (extracted using gpg --armor --export +user_id in the case of gpg) for the +database of keys which is distributed from and the debian-keyring +package. Please be sure to sign your request message with your chosen +public key.

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 7-14 days, please send a followup +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 team. Please be patient, especially near release +the New Maintainer Group. Please be patient, especially near release points; mistakes do occasionally happen, and people do sometimes run out of volunteer time. Debian Mentors

-A mailing list called debian-mentors@lists.debian.org -which has been set up for novice maintainers who seek help with -initial packaging and other developer-related issues. Every new -developer is invited to subscribe to that list (see for details). +The mailing list &email-debian-mentors; has been set up for novice +maintainers who seek help with initial packaging and other +developer-related issues. Every new developer is invited to subscribe +to that list (see for details).

Those who prefer one-on-one help (e.g., via private email) should also post to that list and an experienced developer will volunteer to help. - Maintaining Your Debian Information + Debian Developer's Duties + + Maintaining Your Debian Information +

+There's a LDAP database containing many informations concerning all +developers, you can access it at . You can +update your password (this password is propagated to most of the machines +that are accessible to you), your adress, your country, the latitude and +longitude from the point where you live, phone and fax numbers, your +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 : . +

+You have to keep the information available there up to date. Maintaining Your Public Key

Be very careful with your private keys. Do not place them on any -public servers. Back them up. Read the documentation that comes with -your software (either PGP or GNUPG); read the FAQs too, for good -measure. +public servers or multiuser machines, such as +master.debian.org. Back your keys up; keep a copy offline. +Read the documentation that comes with your software; read the .

If you add or remove signatures from your public key, or add or remove user identities, you need to update the key servers and mail your -public key to keyring-maint@debian.org. The same key -extraction routines discussed in apply. +public key to &email-debian-keyring;. The same key extraction +routines discussed in apply.

You can find a more in-depth discussion of Debian key maintenance in the documentation for the debian-keyring package. + Going On Vacation Gracefully +

+Most of the developers take vacation, 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. +

+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 » +(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 +

+A big part of your job as Debian maintainer will be to stay in contact +with the upstream developers since you'll have to share information that +you get from the Bug Tracking System. It's not your job to fix non-Debian +specific bugs so you have to forward the bugs to the upstream developers +(of course, if you are able to fix them, you can ...). This way the bug +may be corrected when the next upstream version comes out. From time to +time, you may get a patch attached to a bug report, you have to send the +patch upstream and make sure that it gets included (if the authors accept +the proposed fix). If you need to modify the upstream sources in order to +build a policy conformant package, then you should propose a nice fix +to the upstream developers which can be included so that you won't have to +modify the sources of the next upstream version. Whatever changes you +need, always try not to fork from the upstream sources. + + Managing Release Critical Bugs +

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

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

If you choose to leave the Debian project, you should make sure you do @@ -284,10 +362,10 @@ the following steps: Orphan all your packages, as described in . Send an email about how you are leaving the project to -debian-private@lists.debian.org. +&email-debian-private;. -Notify the Debian key ring maintainers that you are leaving by emailing -to keyring-maint@debian.org. +Notify the Debian key ring maintainers that you are leaving by +emailing to &email-debian-keyring;. @@ -299,38 +377,41 @@ which may be available to you as a developer. Mailing lists

-The mailing list server is at lists.debian.org. Mail -debian-foo-REQUEST@lists.debian.org, where +The mailing list server is at &lists-host;. Mail +debian-foo-REQUEST@&lists-host;, where debian-foo is the name of the list, with the word subscribe in the Subject to subscribe to the list or unsubscribe to unsubscribe. More detailed instructions on how to subscribe and unsubscribe to the mailing lists can be found at , -or locally in /usr/doc/debian/mailing-lists.txt if you -have the doc-debian package installed. +or locally in &file-mail-lists; if you have the +doc-debian package installed.

When replying to messages on the mailing list, please do not send a carbon copy (CC) to the original poster unless they explicitly request to be copied. Anyone who posts to a mailing list should read it to see the responses.

-In addition, all messages should usually only be sent to one of the -following mailing lists: debian-devel@lists.debian.org, -debian-policy@lists.debian.org, -debian-user@lists.debian.org, -debian-announce@lists.debian.org, or -debian-devel-announce@lists.debian.org. Additional -mailing lists are available for special purposes; see . Cross-posting +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 + for a list. Cross-posting (sending the same message to multiple lists) is discouraged.

-debian-private@lists.debian.org is a special mailing -lists 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 debian-private@lists.debian.org unless it is -really necessary. Moreover, do not forward email from that -list to anyone. +&email-debian-private; is a special mailing lists 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 +&email-debian-private; unless it is really necessary. Moreover, do +not forward email from that list to anyone. +

+&email-debian-email; is a special mailing list used as a grab-bag +for Debian related correspondence such as contacting upstream authors +about licenses, bugs, etc. or discussing the project with others where it +might be useful to have the discussion archived somewhere.

As ever on the net, please trim down the quoting of articles you're replying to. In general, please adhere to the usual conventions for @@ -339,6 +420,7 @@ posting messages. Online archives of mailing lists are available at . + Debian servers

Debian servers are well known servers which serve critical functions @@ -362,23 +444,22 @@ package uploads go to this server; see . master.debian.org is the canonical location for the Bug Tracking System (BTS). If you plan on doing some statistical analysis or processing of Debian bugs, this would be the place to do it. -Please describe your plans on -debian-devel@lists.debian.org before implementing +Please describe your plans on &email-debian-devel; before implementing anything, however, to reduce unnecessary duplication of effort or wasted processing time.

-All Debian developers have accounts on master.debian.org. Please -take care to protect your password to this machine. Try to avoid -login or upload methods which send passwords over the Internet in the -clear. +All Debian developers have accounts on master.debian.org. +Please take care to protect your password to this machine. Try to +avoid login or upload methods which send passwords over the Internet +in the clear.

-If you find a problem with master.debian.org such as disk full, -suspicious activity, or whatever, send an email to -debian-admin@debian.org. Problems with the Debian FTP -archive generally need to be reported as bugs against the +If you find a problem with master.debian.org such as disk +full, suspicious activity, or whatever, send an email to +&email-debian-admin;. Problems with the Debian FTP archive generally +need to be reported as bugs against the ftp.debian.org pseudo-package or an email to -ftpmaster@debian.org, but also see the procedures in -. +&email-ftpmaster;, but also see the procedures in . The WWW servers

@@ -398,8 +479,8 @@ Generally, you'll want to use va, for the www.debian.org address, although in some cases you may need to put it on master. Please do not put any material on Debian servers not relating to Debian, unless you have prior -permission. Send mail to debian-devel@lists.debian.org -if you have any questions. +permission. Send mail to &email-debian-devel; if you have any +questions.

If you find a problem with the Debian web server, you should generally submit a bug against the pseudo-package, @@ -418,13 +499,12 @@ many different developers, you can request a CVS area on the server. Generally, cvs.debian.org offers a combination of local CVS access, anonymous client-server read-only access, and full client-server access through ssh. Also, the CVS area can -be accessed read-only via the Web at . +be accessed read-only via the Web at .

To request a CVS area, send a request via email to -debian-admin@debian.org. Include the name of the -requested CVS area, what va.debian.org user account should -own the CVSROOT, and why you need it. +&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. Mirrors of Debian servers @@ -438,12 +518,11 @@ that newer push mirroring techniques ensure that mirrors are as up-to-date as they can be.

The main web page listing the available public FTP (and, usually, -HTTP) servers can be found at . More information -concerning Debian mirrors can be found at . This useful page includes -information and tools which can be helpful if you are interested in -setting up your own mirror, either for internal or public access. +HTTP) servers can be found at . More +information concerning Debian mirrors can be found at . This useful page includes information +and tools which can be helpful if you are interested in setting up +your own mirror, either for internal or public access.

Note that mirrors are generally run by third-parties who are interested in helping Debian. As such, developers generally do not @@ -463,57 +542,9 @@ disk space, network bandwidth, or CPU without first getting the approval of the local maintainers. Usually these machines are run by volunteers. Generally, these machines are for porting activities.

-Aside from the servers mentioned in , the -following machines are, or may be made, available to you. If an email -address is listed, generally that person is the party to contact about -issues on the machine. Otherwise, the machine is probably managed by -debian-admin@debian.org. - - - faure.debian.org - -An Alpha; if you have an account on master, you probably -already have an account here. - - kubrick.debian.org - -A SPARC; if you have an account on master, you probably -already have an account here. - - pandora.debian.org - -An i386; if you have an account on master, you probably -already have an account here. - - albert.debian.org - -An Alpha; you probably want to use faure instead, but you may -request an account from debian-admin@debian.org. - - powerpc.debian.org - -A PowerPC; also known as tervola.infodrom.north.de. You may -request an account from joey@debian.org or -koptein@debian.org. - - m68k.debian.org - -A Motorola 6800x0 machine; you may request an account from -joey@debian.org or james@nocrew.org. -Runs an autobuilder. - - alpha.debian.nl - -An Alpha; you may request an account from -debian@cistron.nl. - - xia0[123].kachinatech.com - -SPARC and UltraSPARC machines. xia0[12] are used for -automatic compilation; you can request an account on xia03 (an -UltraSPARC) from wdeng@kachinatech.com. - - +Aside from the servers mentioned in , there +is a list of machines available to Debian developers at . @@ -600,17 +631,21 @@ The Linux 2.0 kernel supports Intel x86, DEC Alpha, SPARC, Motorola 680x0 (like Atari, Amiga and Macintoshes), MIPS, and PowerPC. The Linux 2.2 kernel supports even more architectures, including ARM and UltraSPARC. Since Linux supports these platforms, Debian decided that -it should, too. Therefore, Debian has ports underway. In fact, we +it should, too. Therefore, Debian has ports underway; in fact, we also have ports underway to non-Linux kernel. Aside from i386 (our name for Intel x86), there is m68k, alpha, powerpc, sparc, hurd-i386, and arm, as of this writing. -

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. +sparc architectures. Debian 2.2 adds support for the +powerpc architecture. +

+Information for developers or uses about the specific ports are +available at the . Subsections @@ -643,8 +678,8 @@ the software). In this case, the .diff.gz contains the changes made by the Debian maintainer.

The .dsc lists all the files in the source package together -with checksums (md5sums) and some additional info about the package -(maintainer, version, etc.). +with checksums (md5sums) and some additional info about +the package (maintainer, version, etc.). Distribution directories @@ -799,16 +834,15 @@ point to the appropriate release directories. Announcing new packages

If you want to create a new package for the Debian distribution, you -should first check the list. Checking -the WNPP ensures that no one is already working on packaging that -software, and that effort is not duplicated. Assuming no one else is -already working on your prospective package, you must then send a -short email to debian-devel@lists.debian.org describing -your plan to create a new package. You should set the subject of the -email to ``intent to package foobar'', substituting the -name of the new package for foobar. +should first check the list. Checking the WNPP ensures that no +one is already working on packaging that software, and that effort is +not duplicated. Assuming no one else is already working on your +prospective package, you must then send a short email to +&email-debian-devel; describing your plan to create a new package. +You should set the subject of the email to ``intent to package +foo'', substituting the name of the new package for +foo.

There are a number of reasons why we ask maintainers to follow these steps: @@ -820,9 +854,9 @@ on it already. It lets other people thinking about working on the package know that there already is a volunteer, and efforts may be shared. The ``intent -to package'' message to debian-devel@lists.debian.org -will be picked up the the WNPP maintainer, and your intention will be -published in subsequent versions of the WNPP document. +to package'' message to &email-debian-devel@; will be picked up the +the WNPP maintainer, and your intention will be published in +subsequent versions of the WNPP document. It lets the rest of the maintainers know more about the package than the one line description and the changelog entry ``Initial version'' @@ -848,27 +882,16 @@ archive maintainers for its handling. This is usually generated by

The changes file is a control file with the following fields:

- - Format - Date - Source - Binary - Architecture - Version - Distribution - Urgency - Maintainer - Description - Changes - Files - +&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. -Only the Distribution field is discussed here, since it -relates to the archive maintenance policies. +of control fields in the for the contents of these fields. You can close +bugs automatically using the Description field, see . Only the Distribution field is +discussed in this section, since it relates to the archive maintenance +policies. + Picking a distribution

@@ -883,12 +906,16 @@ put `stable unstable' in the changelog's Distribution field. Or, if Debian has been frozen, and you want to get a bug-fix release into frozen, you would set the distribution to `frozen unstable'. (See for -more information on when to upload to frozen.) Note that -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. Also note that it never makes sense to combine the -experimental distribution with anything else. +more information on when to upload to frozen.) Note that it +never makes sense to combine the experimental distribution with +anything else. Also note that setting the distribution to `stable' means +that the package will be placed into the proposed-updates +directory of the Debian archive for further testing before it is actually +included in stable. The Release Team (which can be reached at +&email-debian-release;) will decide if your package can be included in +stable, therefore if your changelog entry is not clear enough, you may +want to explain them why you uploaded your package to stable by sending +them a short explication.

The first time a version is uploaded which corresponds to a particular upstream version the original source tar file should be uploaded and @@ -899,9 +926,9 @@ files, and it need not then be 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 may be modified by using -sa to always include -it or -sd to always leave it out. +number is 0 or 1, indicating a new upstream version. This behaviour +may be modified by using -sa to always include it or +-sd to always leave it out.

If no original source is included in the upload then the original source tar-file used by dpkg-source when constructing the @@ -988,22 +1015,22 @@ Remove the package, then reinstall it. To upload a package, you need a personal account on master.debian.org. All maintainers should already have this account, see . You can use either -ssh or ftp to transfer the files. In either +scp or ftp to transfer the files. In either case, the files need to be placed into -/home/Debian/ftp/private/project/Incoming. (You -cannot upload to Incoming on master using anonymous FTP -- you must -use your user-name and password.) +&master-upload-dir. (You cannot upload to Incoming +on master using anonymous FTP -- you must use your user-name and +password.)

Note: Do not upload packages containing software that is export-controlled by the United States government to master, -or to the overseas upload queues on chiark or +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 below). If you are not sure whether -U.S. export controls apply to your package, post a message to -debian-devel@lists.debian.org and ask. +to non-us (see ). If you are not +sure whether U.S. export controls apply to your package, post a +message to &email-debian-devel; and ask.

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

+After uploading your package, you can check how dinstall will +process it by running dinstall on your changes file: +~maor/dinstall/dinstall -n foo.changes - + Uploading to pandora (non-us) +

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

+The program dupload comes with support for uploading to +pandora; please refer to the documentation that comes with +the program for details. +

+Just as for an upload to master, you can check your upload with : +/org/non-us.debian.org/scripts/dinstall/dinstall -n foo.changes + + Uploads via chiark

If you have a slow network connection to master, there are alternatives. One is to upload files to Incoming via a upload queue in Europe on chiark. For details connect to -ftp.chiark.greenend.org.uk using anonymous FTP and -read -/pub/debian/private/project/README.how-to-upload. +.

Note: Do not upload packages containing software that is export-controlled by the United States government to the queue on chiark. Since this upload queue goes to master, the prescription found in applies here as well.

-The program dupload supports uploads to chiark; please refer -to the documentation that comes with the program for details. +The program dupload comes with support for uploading to +chiark; please refer to the documentation that comes with the +program for details. Uploads via erlangen

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

The upload must be a complete Debian upload, as you would put it into master's Incoming, i.e., a .changes files @@ -1058,41 +1103,45 @@ export-controlled by the United States government to the queue on erlangen. Since this upload queue goes to master, the prescription found in applies here as well.

-The program dupload supports uploads to +The program dupload comes with support for uploading to erlangen; please refer to the documentation that comes with the program for details. - Uploading to the non-us server + Other Upload Queues

-To upload a package to the non-us server you just have to -transfer the files via anonymous ftp to . Note, that -the .changes file must have a valid PGP signature from one of -the keys of the developers key-ring. +Another upload queue is available which is based in the US, and is a +good backup when there are problems reaching master. You can +upload files, just as in erlangen, to . +

+An upload queue is available in Japan: just upload the files via +anonymous FTP to . + Announcing package uploads

When a package is uploaded an announcement should be posted to one of -the ``debian-changes'' lists. The announcement should give the -(source) package name and version number, and a very short summary of -the changes, in the Subject field, and should contain the -PGP-signed .changes file. Some additional explanatory text -may be added before the start of the .changes file. +the ``debian-changes'' lists. This is now done automatically by dinstall +when it runs (usually once a day), you just need to use a recent +dpkg-dev (>= 1.4.1.2). Before that, +dupload was used to send those announcements, please make +sure that you configured your dupload to no more send those +announcements (check its documentation and look for dinstall_runs). The +mail generated by dinstall will contain the PGP/GPG signed .changes files +that you uploaded with your package.

If a package is released with the Distribution: set to -`stable', the announcement is sent to -debian-changes@lists.debian.org. If a package is -released with Distribution: set to `unstable', -`experimental', or `frozen' (when present), the announcement should be -posted to debian-devel-changes@lists.debian.org -instead. +`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 +posted to &email-debian-devel-changes; instead.

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

The dupload program is clever enough to determine for itself @@ -1130,13 +1179,12 @@ The archive maintainers keep track of the canonical sections and priorities for packages in the override file. Sometimes the override file needs correcting. Simply changing the package's control file is not going to work. Instead, -you should email override-change@debian.org or submit a -bug against ftp.debian.org. +you should email &email-override; or submit a bug against +ftp.debian.org.

For more information about override files, see , -/usr/doc/debian/bug-log-mailserver.txt, and -/usr/doc/debian/bug-maint-info.txt. +name="dpkg-scanpackages" section="8">, &file-bts-mailing;, and +&file-bts-info;. @@ -1478,6 +1526,16 @@ 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 +which have been updated, such as libraries. You do have to bump the +version number in this case, so that the upgrade system can function +properly. Even so, these are considered binary-only NMUs -- there is +no need in this case for all architectures to recompile. You should +set the version number as in the case of NMU versioning, but add a +``.0.'' before the the NMU version. For instance, a recompile-only +NMU of the source package ``foo_1.3-1'' would be numbered +``foo_1.3-1.0.1''. +

The way to invoke dpkg-buildpackage is as dpkg-buildpackage -B -mporter-email. Of course, set porter-email to your email address. This will do a @@ -1560,7 +1618,14 @@ cannot yet be autobuilt) and work on it. most porting efforts are either using it currently or planning to use it in the near future. It collects a number of as yet unpackaged components which are currently very useful and in use continually, -such as sbuild and wanna-build. +such as andrea, sbuild and +wanna-build. +

+Some of the data produced by buildd which is +generally useful to porters is available on the web at . This data includes nightly updated information +from andrea (source dependencies) and +quinn-diff (packages needing recompilation).

We are very excited about this system, since it potentially has so many uses. Independent development groups can use the system for @@ -1593,25 +1658,32 @@ cases. Moving packages

-Sometimes a package will change either its section or its subsection. -For instance, a package from the `non-free' section might be GPL'd in -a later version; in this case you should consider moving it to `main' -or `contrib' (see the for guidelines). -

-In this case, it is sufficient to edit the package control information -normally and re-upload the package (see the See the for guidelines on what section a package +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 dinstall bug. +

+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 . - 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 @@ -1620,26 +1692,25 @@ package be removed. Make sure you indicate which distribution the package should be removed from.

If in doubt concerning whether a package is disposable, email -debian-devel@lists.debian.org asking for opinions. -Also of interest is the apt-cache program from the -apt package. When invoked as apt-cache showpkg -/var/cache/apt/pkgcache.bin package, the program will -show details for package, including reverse depends. +&email-debian-devel; asking for opinions. Also of interest is the +apt-cache program from the apt +package. When invoked as apt-cache showpkg +package, the program will show details for +package, including reverse depends. 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 debian-changes@lists.debian.org -or debian-devel-changes@lists.debian.org). +announce list (either &email-debian-changes; or +&email-debian-devel-changes;). 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 your debian/control file to replace and conflict with the -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 @@ -1651,25 +1722,21 @@ obsolete name.

If you can no longer maintain a package, then you should set the package maintainer to Debian QA Group -<debian-qa@lists.debian.org> and email -wnpp@debian.org indicating that the package is now -orphaned. If the package is especially crucial to Debian, you should -instead email debian-devel@lists.debian.org asking for -a new maintainer. +<debian-qa@lists.debian.org> and email &email-wnpp; +indicating that the package is now orphaned. If the package is +especially crucial to Debian, you should instead email +&email-debian-devel; asking for a new maintainer. Adopting a package

Periodically, a listing of packages in need of new maintainers will be -sent to debian-devel@lists.debian.org list. This list -is also available at in the Work-Needing and Prospective Packages -document (WNPP), -and at . -If you wish to take over maintenance of any of the packages listed in -the WNPP, or if you can no longer maintain a packages you have, or you -simply want to know if any one is working on a new package, send a -message to wnpp@debian.org. +sent to &email-debian-devel list. This list is also available at in +the Work-Needing and Prospective Packages document (WNPP), . If you wish to take over maintenance of any of the +packages listed in the WNPP, or if you can no longer maintain a +packages you have, or you simply want to know if any one is working on +a new package, send a message to &email-wnpp;.

It is not OK to simply take over a package that you feel is neglected -- that would be package hijacking. You can, of course, contact the @@ -1677,16 +1744,14 @@ current maintainer and ask them if you may take over the package. However, without their assent, you may not take over the package. Even if they ignore you, that is still not grounds to take over a package. If you really feel that a maintainer has gone AWOL (absent -without leave), post a query to -debian-private@lists.debian.org. +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 override-change@debian.org so that bug reports will -go to you right away. +to &email-override; so that bug reports will go to you right away. @@ -1696,9 +1761,8 @@ go to you right away. Monitoring bugs

If you want to be a good maintainer, you should periodically check the - for your packages. The BTS contains all the open bugs against -your packages. + for your +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 @@ -1720,8 +1784,8 @@ maintainer address.

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 -BTS can tell you how to do this. + can tell you how +to do this.

We encourage you to file bugs when there are problems. Try to submit the bug from a normal user account at which you are likely to receive @@ -1739,15 +1803,14 @@ maintainer). 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 (i.e., +the original submitter of the bug, and the bug itself (e.g., 123@bugs.debian.org).

You should never close bugs via the bug server `close' -command sent to control@bugs.debian.org. If you do so, -the original submitter will not receive any feedback on why the bug -was closed. +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 + 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, @@ -1756,8 +1819,30 @@ 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.

-Again, see the BTS documentation for details on how to do this. -Often, it is sufficient to mail the .changes file to +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: + +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. + + +Technically speaking, the following Perl regular expression is what is +used: + + /closes:\s*(bug)?\#\d+(,\s*(bug)?\#\d+)*/gi + + +The author prefers the (closes: Bug#XXX) syntax, +since it stands out from the rest of the changelog entries. +

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

You should periodically get the new lintian from `unstable' and check over all your packages. Alternatively you can -check for your maintainer email address at the . -That report, which is updated automatically, contains -lintian reports against the latest version of the -distribution (usually from 'unstable') using the latest -lintian. +check for your maintainer email address at the . That report, which is updated +automatically, contains lintian reports against the +latest version of the distribution (usually from 'unstable') using the +latest lintian. Reporting lots of bugs at once @@ -1784,12 +1868,11 @@ a new check to lintian so that an error or warning is emitted.

If you report more than 10 bugs on the same topic at once, it is -recommended that you send a message to -debian-devel@lists.debian.org describing your intention -before submitting the report. This will allow other developers to -verify that the bug is a real problem. In addition, it will help -prevent a situation in which several maintainers start filing the same -bug report simultaneously. +recommended that you send a message to &email-debian-devel; describing +your intention before submitting the report. This will allow other +developers to verify that the bug is a real problem. In addition, it +will help prevent a situation in which several maintainers start +filing the same bug report simultaneously.

Note that when sending lots of bugs on the same subject, you should send the bug report to maintonly@bugs.debian.org so @@ -1873,6 +1956,19 @@ favor of debhelper. However, it's not a bug to use different philosophy. It uses a debian/packages file to auto-generate other necessary files in the debian/ subdirectory. +

+Note that yada is still quite new and possibly not +yet as robust as other systems. + + + + equivs +

+equivs is another package for making packages. It +is often suggested for local use if you need to make a package simply +to fulfill dependancies. It is also sometimes used when making +``meta-packages'', which are packages whose only purpose is to depend +on other packages. @@ -1928,6 +2024,7 @@ which can be helpful in downloading files from the Debian archive. You can use it to download source packages, for instance. +