X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=7a19db8931a77659aff1c1eba7d8dcbf098b3c6c;hp=f9c21e0db714bedbcdd5284cc9ddd61b04416f06;hb=f2eca38b86c03d304f79ae137e9149f590601ea9;hpb=60021a3200167fc30b265fcee04aab2595c4a673 diff --git a/developers-reference.sgml b/developers-reference.sgml index f9c21e0..7a19db8 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -2,8 +2,16 @@ %versiondata; - - + + %commondata; + + + + + ]> + + +, &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 posting messages.

Online archives of mailing lists are available at . +id="&url-lists-archives;">. + Debian servers

@@ -344,88 +445,84 @@ Debian servers are well known servers which serve critical functions in the Debian project. Every developer should know what these servers are and what they do.

-If you have a problem with the operation of Debian server, and you +If you have a problem with the operation of a Debian server, and you think that the system operators need to be notified of this problem, -please find the contact address for the particular role at . If you have a -non-operating problems (such as packages to be remove, suggestions for -the web site, etc.), generally you'll report a bug against a -``pseudo-package''. See for information on how -to submit bugs. +please find the contact address for the particular machine at . If you have a non-operating problems +(such as packages to be remove, suggestions for the web site, etc.), +generally you'll report a bug against a ``pseudo-package''. See for information on how to submit bugs. The master server

-The master server, master.debian.org, holds the canonical copy -of the Debian archive (excluding the non-U.S. packages). Generally, -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. -

-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 -ftp.debian.org pseudo-package or an email to -ftpmaster@debian.org, but also see the procedures in +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 +&email-debian-admin;. + + The ftp-master server +

+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 +go to this server; see . +

+Problems with the Debian FTP archive generally need to be reported as +bugs against the ftp.debian.org pseudo-package or +an email to &email-ftpmaster;, but also see the procedures in . - The WWW servers + The WWW server

The main web server, www.debian.org, is also known as va.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 do this by putting material in the +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 either va.debian.org or -master.debian.org. Any material you put in those areas are -accessible via the URLs -http://www.debian.org/~user-id/ and -http://master.debian.org/~user-id/, respectively. -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. +do this on va.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 +servers not relating to Debian, unless you have prior 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, www.debian.org. First check whether or not someone -else has already reported the problem on the . +else has already reported the problem on the +. The CVS server

cvs.debian.org is also known as va.debian.org, -discussed above. If you need the use of a publically accessible CVS +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.

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 @@ -439,20 +536,15 @@ 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 have accounts on these machines. -

-Please do not mirror off of master.debian.org. This host -already has too much load. Check the sites above for information, or -email debian-devel@lists.debian.org. Other Debian Machines @@ -464,57 +556,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 . @@ -528,44 +572,7 @@ additional files (documentation, installation disk images, etc.).

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

- -main/ -main/binary-all/ -main/binary-all/admin/ -main/binary-all/base/ -main/binary-all/comm/ -main/binary-all/devel/ - ... -main/binary-i386/ -main/binary-i386/admin/ -main/binary-i386/base/ - ... -main/binary-m68k -main/binary-m68k/admin/ -main/binary-m68k/base/ - ... -main/source/ -main/source/admin/ -main/source/base/ - ... -main/disks-i386/ -main/disks-m68k/ - ... - -contrib/ -contrib/binary-all/ -contrib/binary-i386/ -contrib/binary-m68k/ - ... -contrib/source/ - -non-free/ -non-free/binary-all/ -non-free/binary-i386/ -non-free/binary-m68k/ - ... -non-free/source/ - +&sample-dist-dirtree;

As you can see, the top-level directory of the distribution contains three directories, namely main, contrib, and @@ -593,17 +600,14 @@ 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.

-Every package in the main section must fully comply with the (DFSG) and with all other policy requirements as -described in the . The DFSG is our definition of ``free -software.'' Check out the Debian Policy Manual for details. -

-The packages which do not apply to the DFSG are placed in the +Every package in the main section must fully comply with the (DFSG) and +with all other policy requirements as described in the . The DFSG is +our definition of ``free software.'' Check out the Debian Policy +Manual for details. +

+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 @@ -613,9 +617,9 @@ 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. +The +contains a more exact definition of the three sections. The above +discussion is just an introduction.

The separation of the three sections at the top-level of the archive is important for all people who want to distribute Debian, either via @@ -626,7 +630,7 @@ commercial distribution, for example.

On the other hand, a CD-ROM vendor could easily check the individual package licenses of the packages in non-free and include as -many on the CD-ROMs as he's allowed. (Since this varies greatly from +many on the CD-ROMs as he's allowed to. (Since this varies greatly from vendor to vendor, this job can't be done by the Debian developers.) @@ -641,17 +645,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 @@ -659,8 +667,8 @@ ships for the i386, m68k, alpha, and The sections main, contrib, and non-free are split into subsections to simplify the installation process and the maintainance of the archive. Subsections are not -formally defined, excepting perhaps the `base' subsection. -Subsections exist simply to simplify the organization and browsing of +formally defined, except perhaps the `base' subsection. +Subsections simply exist to simplify the organization and browsing of available packages. Please check the current Debian distribution to see which sections are available. @@ -684,14 +692,14 @@ 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

-The directory system described in the previous chapter, are themselves -contained within distribution directories. Every +The directory system described in the previous chapter is itself +contained within distribution directories. Each distribution is contained in the dists directory in the top-level of the Debian archive itself (the symlinks from the top-level directory to the distributions themselves are for backwards @@ -729,8 +737,8 @@ distribution change from day-to-day. Since no special effort is done to test this distribution, it is sometimes ``unstable.''

After a period of development, the unstable distribution is -copied in a new distribution directory, called frozen. When -that occurs, no changes are allowed to the frozen distribution except +copied to a new distribution directory, called frozen. After +that has been done, no changes are allowed to the frozen distribution except bug fixes; that's why it's called ``frozen.'' After another month or a little longer, the frozen distribution is renamed to stable, overriding the old stable distribution, @@ -749,23 +757,23 @@ 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 is continued during the +Note that development under unstable continues during the ``freeze'' period, since a new unstable distribution is be created when the older unstable 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 you can still find it from servers -which serve up older, obsolete distributions). +from the Debian archives (although they do live on at +archive-host;).

In summary, there is always a stable and an unstable -distribution available, and the frozen distribution shows up +distribution available, and a frozen distribution shows up for a month or so from time to time. Experimental

The experimental distribution is a specialty distribution. -It is not a full distribution in the same sense that `stable' and +It is not a full distribution in the same sense as `stable' and `unstable' are. Instead, it is meant to be a temporary staging area for highly experimental software where there's a good chance that the software could break your system. Users who download and install @@ -775,7 +783,7 @@ distribution.

Developers should be very selective in the use of the experimental distribution. Even if a package is highly -unstable, it could well still go into unstable; just state a +unstable, it could still go into unstable; just state a few warnings in the description. However, if there is a chance that the software could do grave damage to a system, it might be better to put it into experimental. @@ -793,7 +801,7 @@ However, using experimental as a personal staging area is not always the best idea. You can't replace or upgrade the files in there on your own (dinstall and the Debian archive maintainers do that). Additionally, you'll have to remember to ask the archive -maintainers to delete the package one you have uploaded it to +maintainers to delete the package once you have uploaded it to unstable. Using your personal web space on va.debian.org is generally a better idea, so that you put less strain on the Debian archive maintainers. @@ -804,19 +812,19 @@ less strain on the Debian archive maintainers. Every released Debian distribution has a code name: Debian 1.1 is called `buzz'; Debian 1.2, `rex'; Debian 1.3, `bo'; Debian 2.0, `hamm'; Debian 2.1, `slink'; and Debian 2.2, `potato'. There is also -a ``pseudo-distribution'', called `sid' which is contains packages for +a ``pseudo-distribution'', called `sid', which is contains packages for architectures which are not yet officially supported or released by Debian. These architectures are planned to be integrated into the mainstream distribution at some future date.

-Since the Debian has an open development model (i.e., everyone can +Since Debian has an open development model (i.e., everyone can participate and follow the development) even the unstable distribution -is distributed via the Internet on the Debian FTP and HTTP server +is distributed to the Internet through the Debian FTP and HTTP server network. Thus, if we had called the directory which contains the development version `unstable', then we would have to rename it to `stable' when the version is released, which would cause all FTP -mirrors to re-retrieve the whole distribution (which is already very -large!). +mirrors to re-retrieve the whole distribution (which is quite +large).

On the other hand, if we called the distribution directories Debian-x.y from the beginning, people would think that Debian @@ -828,9 +836,9 @@ version. That's the reason why the first official Debian release was Thus, the names of the distribution directories in the archive are determined by their code names and not their release status (i.e., `slink'). These names stay the same during the development period and -after the release; symbolic links, which can be changed, are made to +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 and symbolic +real distribution directories use the code names, while symbolic links for stable, unstable, and frozen point to the appropriate release directories. @@ -840,44 +848,51 @@ 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. -

-There are a number of reasons why we ask maintainers to follow these -steps: +should first check the list. Checking the WNPP list ensures that +no one is already working on packaging that software, and that effort is +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; +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 +-- 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 (). +

+There are a number of reasons why we ask maintainers to announce their +intentions: It helps the (potentially new) maintainer to tap into the experience -of people on the list, and lets them know if any one else is working +of people on the list, and lets them know if anyone else is working 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. +there already is a volunteer, so efforts may be shared. It lets the rest of the maintainers know more about the package than -the one line description and the changelog entry ``Initial version'' -that generally gets posted to debian-devel-changes by -default. +the one line description and the usual changelog entry ``Initial release'' +that gets posted to debian-devel-changes. It is helpful to the people who live off unstable (and form our first -line of testers); we should encourage these people. +line of testers). We should encourage these people. The announcements give maintainers and other interested parties a better feel of what is going on, and what is new, in the project. + + Uploading a package Generating the changes file @@ -889,27 +904,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

@@ -924,31 +928,35 @@ 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 -included in the .changes file; subsequent times the very same +upstream version, the original source tar file should be uploaded and +included in the .changes file. Subsequently, this very same tar file should be used to build the new diffs and .dsc -files, and it need not then be uploaded. +files, and will not need to be re-uploaded.

-By default dpkg-genchanges and +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 +If no original source is included in the upload, the original source tar-file used by dpkg-source when constructing the .dsc file and diff to be uploaded must be byte-for-byte identical with the one already in the archive. If there -is some reason why this is not the case then the new version of the +is some reason why this is not the case, the new version of the original source should be uploaded, possibly by using the -sa flag. @@ -985,19 +993,20 @@ documentation bug fixes are allowed, since good documentation is important

-Remember, there is statistically a 15% chance that every bug fix will -introduce a new bug. The introduction and discovery of new bugs -either delays release or weakens the final product. There is little -correlation between the severity of the original bug and the severity -of the introduced bug. +Experience has shown that there is statistically a 15% chance that +every bug fix will introduce a new bug. The introduction and +discovery of new bugs either delays release or weakens the final +product. There is little correlation between the severity of the +original bug fixed and the severity of the bug newly introduced by the +fix. Checking the package prior to upload

-Before you upload your package, you should do basic testing on it. -Make sure you try the following activities (you'll need to have an -older version of the Debian package around). +Before you upload your package, you should do basic testing on it. At +a minimum, you should try the following activities (you'll need to +have an older version of the same Debian package around): Install the package and make sure the software works, or upgrade the @@ -1024,119 +1033,141 @@ Remove the package, then reinstall it. - Uploading to master + Uploading to ftp-master

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 -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.) +ftp-master.debian.org, which you should have as an +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/.

-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 +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 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 -defaults for uploading via ftp to master, +defaults for uploading via ftp to ftp-master, chiark, and erlangen. It can also be configured to -use ssh. See and - for more information. - +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 + Uploading to non-us (pandora) +

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

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

+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 + + Uploads via chiark

-If you have a slow network connection to master, there are +If you have a slow network connection to ftp-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. +chiark. Since this upload queue goes to ftp-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 +ftp-master's Incoming, i.e., a .changes files along with the other files mentioned in the .changes. The queue daemon also checks that the .changes is correctly PGP-signed by a Debian developer, so that no bogus files can find -their way to master via the queue. Please also make sure that +their way to ftp-master via this queue. Please also make sure that the Maintainer field in the .changes contains your e-mail address. The address found there is used for all -replies, just as on master. +replies, just as on ftp-master.

There's no need to move your files into a second directory after the -upload as on chiark. And, in any case, you should get some -mail reply from the queue daemon what happened to your -upload. Hopefully it should have been moved to master, but in +upload, as on chiark. And, in any case, you should get a +mail reply from the queue daemon explaining what happened to your +upload. Hopefully it should have been moved to ftp-master, but in case of errors you're notified, too.

Note: Do not upload packages containing software that is 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. +erlangen. Since this upload queue goes to ftp-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 ftp-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. +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 +.changes files that you uploaded with your package. +Previously, dupload used to send those announcements, so +please make sure that you configured your dupload not to +send those announcements (check its documentation and look for +``dinstall_runs'').

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 +The dupload program is clever enough to determine where the announcement should go, and will automatically mail the announcement to the right list. See . @@ -1150,11 +1181,11 @@ daily basis by an archive maintenance tool called 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 -patient). +the change to the archive may take up to a week to occur. Please be +patient.

-In any case, you will receive notification indicating that the package -has been uploaded via email. Please examine this notification +In any case, you will receive email notification indicating that the +package has been uploaded. Please examine this notification carefully. You may notice that the package didn't go into the section you thought you set it to go into. Read on for why. @@ -1171,13 +1202,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;. @@ -1208,7 +1238,7 @@ similar, since they involve an upload of a package by a developer who is not the official maintainer of that package. That is why it's a non-maintainer upload.

-A source NMU is a upload of a package by a developer who is not the +A source NMU is an upload of a package by a developer who is not the official maintainer, for the purposes of fixing a bug in the package. Source NMUs always involves changes to the source (even if it is just a change to debian/changelog). This can be either a change @@ -1216,7 +1246,7 @@ to the upstream source, or a change to the Debian bits of the source.

A binary NMU is a recompilation and upload of a binary package for a new architecture. As such, it is usually part of a porting effort. A -binary NMU is non-maintainer uploaded binary version of a package +binary NMU is a non-maintainer uploaded binary version of a package (often for another architecture), with no source changes required. There are many cases where porters must fix problems in the source in order to get them to compile for their target architecture; that would @@ -1250,7 +1280,7 @@ slightly different rules than non-porters, due to their unique circumstances (see ).

Only critical changes or security bug fixes make it into stable. When -a security bug is detected a fixed package should be uploaded as soon +a security bug is detected, a fixed package should be uploaded as soon as possible. In this case, the Debian Security Managers should get in contact with the package maintainer to make sure a fixed package is uploaded within a reasonable time (less than 48 hours). If the package @@ -1425,7 +1455,7 @@ fact, all the prescriptions from apply, including the need to announce the NMU to the proper lists.

Make sure you do not change the value of the maintainer in -the debian/control file. Your name from the NMU entry of +the debian/control file. Your name as given in the NMU entry of the debian/changelog file will be used for signing the changes file. @@ -1440,19 +1470,19 @@ is part of your duty as a maintainer to be aware of issues of portability. Therefore, even if you are not a porter, you should read most of this chapter.

-Porting is the act of building Debian packages for architectures which +Porting is the act of building Debian packages for architectures that is different from the original architecture of the package maintainer's binary package. It is a unique and essential activity. In fact, porters do most of the actual compiling of Debian packages. -For instance, for one i386 binary package, there has to be a -recompile for each architecture, which is around five more builds. +For instance, for a single i386 binary package, there must be a +recompile for each architecture, which is amounts to five more builds. Being Kind to Porters

Porters have a difficult and unique task, since they are required to deal with a large volume of packages. Ideally, every source package -should build right out of the box; unfortunately, this is often not +should build right out of the box. Unfortunately, this is often not the case. This section contains a checklist of ``gotchas'' often committed by Debian maintainers -- common problems which often stymie porters, and make their jobs unnecessarily more difficult. @@ -1491,7 +1521,7 @@ or programs. For instance, you should never be calling programs in be setup in a special way. Try building your package on another machine, even if it's the same architecture. -Don't depend on the package your building already being installed (a +Don't depend on the package you're building already being installed (a sub-case of the above issue). Don't rely on egcc being available; don't rely on @@ -1519,6 +1549,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 @@ -1601,7 +1641,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 @@ -1634,25 +1681,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 @@ -1661,56 +1715,55 @@ 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 obsolete name. - - Orphaning a package

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

+Read instructions on the +for more information. 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. +A list of packages in need of a new maintainer is available at in the +. If you wish to take over maintenance of any of the +packages listed in the WNPP, please take a look at the aforementioned +page for information and procedures.

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 @@ -1718,16 +1771,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. @@ -1737,9 +1788,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 @@ -1761,8 +1811,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 @@ -1773,22 +1823,21 @@ good job reporting a bug and redirecting it to the proper location. For extra credit, you can go through other packages, merging bugs which are reported more than once, or setting bug severities to `fixed' when they have already been fixed. Note that when you are -neither the bug submitter nor the package maintainer, you are should +neither the bug submitter nor the package maintainer, you should not actually close the bug (unless you secure permission from the maintainer). Responding to Bugs

Make sure that any discussions you have about bugs are sent both to -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, @@ -1797,8 +1846,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)?\#\s*\d+(?:,\s*(?:bug)?\#\s*\d+)*/ig + + +The author prefers the (closes: Bug#XXX) syntax, +since it stands out from the rest of the changelog entries. +

+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. @@ -1807,12 +1878,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 @@ -1825,12 +1895,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 @@ -1907,6 +1976,27 @@ 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. +

+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 dependencies. It is also sometimes used when making +``meta-packages'', which are packages whose only purpose is to depend +on other packages. + cvs-buildpackage @@ -1949,7 +2039,7 @@ install files with root ownership). If you have 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 build, which is a wrapper around +command-line, and debuild, which is a wrapper around dpkg-buildpackage. @@ -1961,6 +2051,7 @@ which can be helpful in downloading files from the Debian archive. You can use it to download source packages, for instance. +