X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=developers-reference.sgml;h=16732d2ee61ee3d9effdf6f5232b3de9eb51482e;hb=90c9e75afaf1cf7994b255f399474aae07db5bfb;hp=bc8d66b123b8da0c1f7f8adc698e05c36336a10d;hpb=8e0675e353aa931b01fa42667d5e005c23d75b03;p=developers-reference.git diff --git a/developers-reference.sgml b/developers-reference.sgml index bc8d66b..16732d2 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -8,6 +8,7 @@ TODO: - bugs in upstream versions should be reported upstream! - fill in ftp and www server discussion + - how to mirror - porter instructions - - volunteers needed for this x86-centric maintainer! - talk about CVS access --> @@ -78,7 +79,7 @@ Manual">. Getting started

So, you've read all the documentation, you understand what everything -in the pgp -ks If your PGP key isn't on public PGP key servers such as pgp.net, please read the documentation available locally /usr/doc/pgp/keyserv.doc. That document contains -instructions on how to put your key on the public keyservers. +instructions on how to put your key on the public key servers.

Due to export restrictions by the United States government some Debian packages, including PGP, have been moved to an ftp site outside of the @@ -189,7 +190,7 @@ United States. You can find the current locations of those packages on Some countries restrict the use of cryptographic software by their citizens. This need not impede one's activities as a Debian package maintainer however, as it may be perfectly legal to use cryptographic -products for authenication, rather than encryption purposes (as is +products for authentication, rather than encryption purposes (as is the case in France). The Debian Project does not require the use of cryptography pgp underway) for the database of keys which is distributed from /pub/debian/doc/debian-keyring.tar.gz, or the -debian-keyring package). Please be sure to sign your + Once this information is received and processed, you should be @@ -241,7 +242,7 @@ 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. +doc-debian package installed.

When replying to messages on the mailing list, please do not send a carbon copy (. - The master server + The master server

-The master server, . All Debian -developers have accounts on this machine. +The master server, . +

+ +All Debian developers have accounts on +If you find a problem with debian-admin@debian.org. + + The FTP servers +

+ + The WWW servers +

+The main web server, +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 +public_html directory under your home directory. You can do +this on either http://www.debian.org/~user-id/ and +http://master.debian.org/~user-id/, respectively. +Please do not put any materials on Debian servers which do +not relate to Debian. +

+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 . - The FTP servers + The CVS server

+ssh. +

+To request a CVS area, send a request via email to +debian-admin@debian.org. + - The WWW servers + Mirrors of Debian servers

+The web and FTP servers have several mirrors available. Please do not +put heavy load on the canonical FTP or web servers. Ideally, the +canonical servers only mirror out to a first tier of mirrors, and all +user access is to the mirrors. This allows Debian to better spread +our bandwidth requirements over several servers and networks. Note +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 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. The Debian Archive @@ -310,9 +382,9 @@ main/binary-i386/ main/binary-i386/admin/ main/binary-i386/base/ ... -main/binary-m86k -main/binary-m86k/admin/ -main/binary-m86k/base/ +main/binary-m68k +main/binary-m68k/admin/ +main/binary-m68k/base/ ... main/source/ main/source/admin/ @@ -325,14 +397,14 @@ main/disks-m68k/ contrib/ contrib/binary-all/ contrib/binary-i386/ -contrib/binary-m86k/ +contrib/binary-m68k/ ... contrib/source/ non-free/ non-free/binary-all/ non-free/binary-i386/ -non-free/binary-m86k/ +non-free/binary-m68k/ ... non-free/source/ @@ -343,7 +415,7 @@ three directories, namely main, contrib, and

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

The -For instance, an experimental encrypted filesystem should probably go +For instance, an experimental encrypted file system should probably go into experimental. A new, beta, version of some software which uses completely different configuration might go into experimental at the maintainer's discretion. New software which isn't likely to damage @@ -664,7 +736,6 @@ to The first time a version is uploaded which corresponds to a particular upstream version the original source tar file should be uploaded and @@ -693,25 +764,29 @@ 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). - install the package and make sure the software - works, or upgrade the package from an older version to - your new version if a Debian package for it already - exists - - downgrade the package to the previous version - (if one exists) -- this tests the remove the package - - run lintian -v - package-NN.changes. This will check the - source package as well as the binary package. If you - don't understand the output that +Install the package and make sure the software works, or upgrade the +package from an older version to your new version if a Debian package +for it already exists. + + +Run lintian -v package-NN.changes. This will +check the source package as well as the binary package. If you don't +understand the output that +Normally, a package should +For more information on . + +Downgrade the package to the previous version (if one exists) -- this +tests the +Remove the package, then reinstall it. @@ -735,7 +810,7 @@ of such software should go to -You may also find the Debian package . Note, that the .changes file must have a valid PGP signature from one of -the keys of the developers keyring. +the keys of the developers key-ring. Announcing package uploads @@ -808,7 +883,7 @@ If a package is released with -On occassion, it is necessary to upload a package to both the The normal maintainer should do at least one of the following: @@ -947,15 +1022,15 @@ name="Debian Packaging Manual"> 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 -Removing packages

If for some reason you want to completely remove a package (say, if it -is an old compatability library which is not longer required), you -need to file a bug against @@ -972,7 +1047,7 @@ 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 , or, if you have -installed the /usr/doc/debian/bug-*.

Often as a package maintainer, you find bugs in other packages or else @@ -1030,13 +1105,13 @@ number. Lintian reports

-You should periodically get the new . That report, which is updated automatically, contains Reporting lots of bugs at once @@ -1054,70 +1129,69 @@ send the bug report to Whirlwind Tour of Debian Maintainer Tools + Overview of Debian Maintainer Tools

This section contains a rough overview of the tools available to maintainers. These tools are meant to help convenience developers and free their time for critical tasks.

Some people prefer to use high-level package maintenance tools and -some do not. Debian is officially agnostic on this issue, other than -making the attempt to accomodate the reasonable wishes of developers. -Therefore, this section is not meant to stipulate to anyone which -tools they should use or how they should go about with their duties of -maintainership. Nor is it meant to endorse any particular tool to the -exclusion of a competing tool. +some do not. Debian is officially agnostic on this issue; any tool +which gets the job done is fine. Therefore, this section is not meant +to stipulate to anyone which tools they should use or how they should +go about with their duties of maintainership. Nor is it meant to +endorse any particular tool to the exclusion of a competing tool.

Most of the descriptions of these packages come from the actual package descriptions themselves. - dpkg-dev + -dpkg-dev contains the tools (including + - lintian + -Lintian dissects Debian packages and reports bugs and +lintian has already been discussed in and . - debhelper + -debhelper is a collection of programs that can be used in +debian/rules to automate common tasks related to building binary Debian packages. Programs are included to install various files into your package, compress files, fix file permissions, integrate your package with the Debian menu system.

-Unlike debmake, debhelper is broken into +Unlike debmake. + - debmake + -debmake, a pre-cursor to debhelper, is a +debian/rules assistant. It includes two main programs: deb-make, which can be used to help a maintainer convert a regular (non-Debian) source archive into a Debian source package; and debstd, which incorporates in one big shot the same sort of automated functions that one finds in -debhelper. + - cvs-buildpackage + -cvs-buildpackage provides the capability to inject or + - dupload + -dupload is a package and a script to automagically upload +