X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=developers-reference.sgml;h=0b0de53fac9614ff1b7301e56bd6819a400ff0e0;hp=ee56b8dce239f5c187273041fbb88a9cdeb08a07;hb=d8f60cb36cd4fd22d02851d4465749f4233391da;hpb=8219bde1988be32e9c0af39d9add1d93dd49c65a diff --git a/developers-reference.sgml b/developers-reference.sgml index ee56b8d..0b0de53 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -5,7 +5,7 @@ %commondata; - + @@ -204,11 +204,6 @@ That document contains instructions on how to put your key on the public key servers. The New Maintainer Group will put your public key on the servers if it isn't already there.

-Due to export restrictions by the United States government some Debian -packages, including gnupg, are located on ftp sites -outside of the United States. You can find the current locations of -those packages at . -

Some countries restrict the use of cryptographic software by their citizens. This need not impede one's activities as a Debian package maintainer however, as it may be perfectly legal to use cryptographic @@ -428,7 +423,10 @@ discussions amongst Debian developers. It is meant to be used for posts which for whatever reason should not be published publically. As such, it is a low volume list, and users are urged not to use &email-debian-private; unless it is really necessary. Moreover, do -not forward email from that list to anyone. +not forward email from that list to anyone. Archives of this +list are not available on the web for obvious reasons, but you can see +them using your shell account master.debian.org and looking +in the ~debian/archive/debian-private directory.

&email-debian-email; is a special mailing list used as a grab-bag for Debian related correspondence such as contacting upstream authors @@ -479,7 +477,7 @@ full, suspicious activity, or whatever, send an email to

The ftp-master server, ftp-master.debian.org (or auric.debian.org), holds the canonical copy of the Debian -archive (excluding the non-U.S. packages). Generally, package uploads +archive (excluding the non-US packages). Generally, package uploads go to this server; see .

Problems with the Debian FTP archive generally need to be reported as @@ -872,7 +870,7 @@ symbolic links for stable, testing, and Package uploads - Announcing new packages + New packages

If you want to create a new package for the Debian distribution, you should first check the + Adding an entry to debian/changelog +

+Changes that you make to the package need to be recorded in the +debian/changelog. These changes should provide a concise +description of what was changed, why (if it's in doubt), and note if +any bugs were closed. They also record when the package was +completed. This file will be installed in +/usr/share/doc/package/changelog.Debian.gz, or +/usr/share/doc/package/changelog.gz for native +packages. +

+The debian/changelog file conform to a certain structure, +with a number of different fields. One field of note, the +distribution, is described in . More +information about the structure of this file can be found in +the Debian Policy section titled "debian/changelog". +

+Changelog entries can be used to automatically close Debian bugs when +the package is installed into the archive. See . +

+It is conventional that the changelog entry notating of a package that +contains a new upstream version of the software looks like this: + + * new upstream version + +

+There are tools to help you create entries and finalize the +changelog for release — see +and . + + Checking the package prior to upload

@@ -1117,21 +1148,21 @@ directory on ftp-master and then move them to &us-upload-dir;.

Note: Do not upload to ftp-master packages -containing software that is export-controlled by the United States -government, nor to the overseas upload queues on chiark or -erlangen. This prohibition covers almost all cryptographic -software, and even sometimes software that contains ``hooks'' to -cryptographic software, such as electronic mail readers that support -PGP encryption and authentication. Uploads of such software should go -to non-us (see ). If you are not -sure whether U.S. export controls apply to your package, post a +containing software that is patent-restricted by the United States +government, nor any cryptographic packages which belong to +contrib or non-free. If you can't upload it to +ftp-master, then neither can you upload it to the overseas +upload queues on chiark or erlangen. Uploads of +such software should go to non-us (see ). If you are not sure whether U.S. patent +controls or cryptographic controls apply to your package, post a message to &email-debian-devel; and ask.

You may also find the Debian packages dupload or dput useful when uploading packages. These handy program are distributed with defaults for uploading via ftp to ftp-master, -chiark, and erlangen. It can also be configured to +chiark, and erlangen. They can also be configured to use ssh or rsync. See , and for more information. @@ -1143,25 +1174,28 @@ file: dinstall -n foo.changes Uploading to non-US (pandora)

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

-The program dupload comes with support for uploading to -non-us; please refer to the documentation that comes with -the program for details. +to ftp-master. Instead, upload the package to +non-us.debian.org, placing the files in +&non-us-upload-dir; (both and can be used also, with the right invokation). By default, +you can use the same account/password that works on +ftp-master. If you use anonymous FTP to upload, place the +files into /pub/UploadQueue/.

You can check your upload the same way it's done on ftp-master, with: dinstall -n foo.changes

Note that U.S. residents or citizens are subject to restrictions on -export of cryptographic software. As of this writing, U.S. citizens are -allowed to export some cryptographic software, subject to notification -rules by the U.S. Department of Commerce. +export of cryptographic software. As of this writing, U.S. citizens +are allowed to export some cryptographic software, subject to +notification rules by the U.S. Department of Commerce. However, this +restriction has been waived for software which is already available +outside the U.S. Therefore, any cryptographic software which belongs +in the main section of the Debian archive and does not depend +on any package outside of main (e.g., does not depend on +anything in non-US/main) can be uploaded to ftp-master +or its queues, described above.

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

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

This section is for information only and does not constitute legal advice. Again, it is strongly recommended that U.S. citizens and @@ -2200,7 +2235,7 @@ favor of debhelper. However, it's not a bug to use

yada is another packaging helper tool. It uses a debian/packages file to auto-generate -debian/rules other necessary files in the +debian/rules and other necessary files in the debian/ subdirectory.

Note that yada is called "essentially unmaintained" @@ -2271,13 +2306,12 @@ The debootstrap package and script allows you to By "base system", we mean the bare minimum of packages required to operate and install the rest of the system.

-Having a system link this can be useful in many ways. For instance, +Having a system like this can be useful in many ways. For instance, you can chroot into it if you want to test your build depends. Or, you can test how your package behaves when installed into a bare base system. - devscripts

@@ -2289,6 +2323,17 @@ file from the command-line, and debuild, which is a wrapper around dpkg-buildpackage. + + + dpkg-dev-el +

+dpkg-dev-el is an Emacs lisp package which provides +assistance when editing some of the files in the debian +directory of your package. For instance, when editing +debian/changelog, there are handy functions for +finalizing a version and listing the package's current bugs. + + debget

@@ -2299,6 +2344,12 @@ You can use it to download source packages, for instance (although thing). +