chiark / gitweb /
README.contrib: document that short lines are preferred. (#278267)
[developers-reference.git] / pkgs.dbk
index fdf7a0fc2ea957c584c74a47e9d1548227e0f7c6..15cb2f00a91c4a4e68fed3a9234b0a285972abfe 100644 (file)
--- a/pkgs.dbk
+++ b/pkgs.dbk
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-  <!ENTITY % commondata  SYSTEM "common.ent" > %commondata;
+  <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
 ]>
 <chapter id="pkgs">
 <title>Managing Packages</title>
@@ -32,8 +32,8 @@ You should set the subject of the bug to ``ITP: <replaceable>foo</replaceable>
 -- <replaceable>short description</replaceable>'', substituting the name of the
 new package for <replaceable>foo</replaceable>.  The severity of the bug report
 must be set to <emphasis>wishlist</emphasis>.  If you feel it's necessary, send
-a copy to <email>debian-devel@&lists-host;</email> by putting the address
-in the <literal>X-Debbugs-CC:</literal> header of the message (no, don't use
+a copy to &email-debian-devel; by putting the address in the
+<literal>X-Debbugs-CC:</literal> header of the message (no, don't use
 <literal>CC:</literal>, because that way the message's subject won't indicate
 the bug number).
 </para>
@@ -338,10 +338,10 @@ packages uninstallable, is strongly discouraged.
 </para>
 <para>
 The Release Team (which can be reached at
-<email>debian-release@&lists-host;</email>) will regularly evaluate the
-uploads To <emphasis>stable-proposed-updates</emphasis> and decide if your
-package can be included in <emphasis>stable</emphasis>.  Please be clear (and
-verbose, if necessary) in your changelog entries for uploads to
+&email-debian-release;) will regularly evaluate the uploads To
+<emphasis>stable-proposed-updates</emphasis> and decide if your package can be
+included in <emphasis>stable</emphasis>.  Please be clear (and verbose, if
+necessary) in your changelog entries for uploads to
 <emphasis>stable</emphasis>, because otherwise the package won't be considered
 for inclusion.
 </para>
@@ -373,7 +373,8 @@ and dsc-file) with anonymous ftp to <literal>&ftp-master-host;</literal> in
 the directory <ulink
 url="ftp://&ftp-master-host;&upload-queue;">&upload-queue;</ulink>.
 To get the files processed there, they need to be signed with a key in the
-debian keyring.
+Debian Developers keyring or the Debian Maintainers keyring
+(see <ulink url="&url-wiki-dm;"></ulink>).
 </para>
 <para>
 Please note that you should transfer the changes file last.  Otherwise, your
@@ -391,13 +392,6 @@ the Debian package <xref linkend="dcut"/> .
 </para>
 </section>
 
-<section id="upload-non-us">
-<title>Uploading to <literal>non-US</literal></title>
-<para>
-<emphasis>Note:</emphasis> non-us was discontinued with the release of sarge.
-</para>
-</section>
-
 <section id="delayed-incoming">
 <title>Delayed uploads</title>
 <para>
@@ -512,10 +506,10 @@ file</emphasis>.
 <para>
 To alter the actual section that a package is put in, you need to first make
 sure that the <filename>debian/control</filename> file in your package is
-accurate.  Next, send an email <email>override-change@debian.org</email> or
-submit a bug against <systemitem role="package">&ftp-debian-org;</systemitem>
-requesting that the section or priority for your package be changed from the
-old section or priority to the new one.  Be sure to explain your reasoning.
+accurate.  Next, send an email &email-override; or submit a
+bug against <systemitem role="package">ftp.debian.org</systemitem> requesting
+that the section or priority for your package be changed from the old section
+or priority to the new one.  Be sure to explain your reasoning.
 </para>
 <para>
 For more information about <emphasis>override files</emphasis>, see
@@ -565,10 +559,10 @@ can check them by browsing this page:
 </para>
 <para>
 Maintainers interact with the BTS via email addresses at
-<literal>&bugs-host;</literal>.  Documentation on available commands can be
-found at <ulink url="&url-bts;"></ulink>, or, if you have
-installed the <systemitem role="package">doc-debian</systemitem> package, you
-can look at the local files <filename>/usr/share/doc/debian/bug-*</filename>.
+<literal>&bugs-host;</literal>.  Documentation on available
+commands can be found at <ulink url="&url-bts;"></ulink>, or,
+if you have installed the <systemitem role="package">doc-debian</systemitem>
+package, you can look at the local files &file-bts-docs;.
 </para>
 <para>
 Some find it useful to get periodic reports on open bugs.  You can add a cron
@@ -609,9 +603,9 @@ linkend="upload-bugfix"/> .
 </para>
 <para>
 You should <emphasis>never</emphasis> close bugs via the bug server
-<literal>close</literal> command sent to
-<email>control@&bugs-host;</email>.  If you do so, the original submitter
-will not receive any information about why the bug was closed.
+<literal>close</literal> command sent to &email-bts-control;.
+If you do so, the original submitter will not receive any information about why
+the bug was closed.
 </para>
 </section>
 
@@ -657,7 +651,7 @@ unacceptable, you (or the submitter) may want to require a decision of the
 technical committee by reassigning the bug to <systemitem
 role="package">tech-ctte</systemitem> (you may use the clone command of the BTS
 if you wish to keep it reported against your package).  Before doing so, please
-read the <ulink url="&url-devel-docs;tech-ctte">recommended
+read the <ulink url="&url-tech-ctte;">recommended
 procedure</ulink>.
 </para>
 </listitem>
@@ -666,7 +660,7 @@ procedure</ulink>.
 If the bug is real but it's caused by another package, just reassign the bug to
 the right package.  If you don't know which package it should be reassigned to,
 you should ask for help on <link linkend="irc-channels">IRC</link> or
-on <email>debian-devel@&lists-host;</email>.  Please make sure that the
+on &email-debian-devel;.  Please make sure that the
 maintainer(s) of the package the bug is reassigned to know why you reassigned
 it.
 </para>
@@ -703,14 +697,14 @@ someone, the bug may be closed.
 <para>
 If the bug is related to the packaging, you just fix it.  If you are not able
 to fix it yourself, then tag the bug as <literal>help</literal>.  You can also
-ask for help on <email>debian-devel@&lists-host;</email> or
-<email>debian-qa@&lists-host;</email>.  If it's an upstream problem, you
-have to forward it to the upstream author.  Forwarding a bug is not enough, you
-have to check at each release if the bug has been fixed or not.  If it has, you
-just close it, otherwise you have to remind the author about it.  If you have
-the required skills you can prepare a patch that fixes the bug and send it to
-the author at the same time.  Make sure to send the patch to the BTS and to tag
-the bug as <literal>patch</literal>.
+ask for help on &email-debian-devel; or
+&email-debian-qa;.  If it's an upstream problem, you have to
+forward it to the upstream author.  Forwarding a bug is not enough, you have to
+check at each release if the bug has been fixed or not.  If it has, you just
+close it, otherwise you have to remind the author about it.  If you have the
+required skills you can prepare a patch that fixes the bug and send it to the
+author at the same time.  Make sure to send the patch to the BTS and to tag the
+bug as <literal>patch</literal>.
 </para>
 </listitem>
 <listitem>
@@ -784,7 +778,7 @@ If you happen to mistype a bug number or forget a bug in the changelog entries,
 don't hesitate to undo any damage the error caused.  To reopen wrongly closed
 bugs, send a <literal>reopen <replaceable>XXX</replaceable></literal> command
 to the bug tracking system's control address,
-<email>control@&bugs-host;</email>.  To close any remaining bugs that were
+&email-bts-control;.  To close any remaining bugs that were
 fixed by your upload, email the <filename>.changes</filename> file to
 <email>XXX-done@&bugs-host;</email>, where <replaceable>XXX</replaceable>
 is the bug number, and put Version: YYY and an empty line as the first two
@@ -820,7 +814,7 @@ security.debian.org.
 When you become aware of a security-related bug in a Debian package, whether or
 not you are the maintainer, collect pertinent information about the problem,
 and promptly contact the security team at
-<email>team@security.debian.org</email> as soon as possible.  <emphasis
+&email-security-team; as soon as possible.  <emphasis
 role="strong">DO NOT UPLOAD</emphasis> any packages for stable; the security
 team will do that.  Useful information includes, for example:
 </para>
@@ -933,8 +927,8 @@ has become public.
 Security advisories are only issued for the current, released stable
 distribution, and <emphasis>not</emphasis> for testing or unstable.  When
 released, advisories are sent to the
-<email>debian-security-announce@&lists-host;</email> mailing list and
-posted on <ulink url="http://&www-debian-org;/security/">the security web
+&email-debian-security-announce; mailing list and posted on
+<ulink url="&url-debian-security-advisories;">the security web
 page</ulink>.  Security advisories are written and posted by the security team.
 However they certainly do not mind if a maintainer can supply some of the
 information for them, or write part of the text.  Information that should be in
@@ -1222,7 +1216,7 @@ described in <xref linkend="override-file"/> .
 <para>
 If for some reason you want to completely remove a package (say, if it is an
 old compatibility library which is no longer required), you need to file a bug
-against <literal>&ftp-debian-org;</literal> asking that the package be removed;
+against <literal>ftp.debian.org</literal> asking that the package be removed;
 as all bugs, this bug should normally have normal severity.  Make sure you
 indicate which distribution the package should be removed from.  Normally, you
 can only have packages removed from <emphasis>unstable</emphasis> and
@@ -1259,14 +1253,14 @@ and <ulink url="&url-debian-qa;howto-remove.html"></ulink>.
 </para>
 <para>
 If in doubt concerning whether a package is disposable, email
-<email>debian-devel@&lists-host;</email> asking for opinions.  Also of
-interest is the <command>apt-cache</command> program from the <systemitem
+&email-debian-devel; asking for opinions.  Also of interest is
+the <command>apt-cache</command> program from the <systemitem
 role="package">apt</systemitem> package.  When invoked as <literal>apt-cache
 showpkg <replaceable>package</replaceable></literal>, the program will show
 details for <replaceable>package</replaceable>, including reverse depends.
 Other useful programs include <literal>apt-cache rdepends</literal>,
 <command>apt-rdepends</command> and <command>grep-dctrl</command>.  Removal of
-orphaned packages is discussed on <email>debian-qa@&lists-host;</email>.
+orphaned packages is discussed on &email-debian-qa;.
 </para>
 <para>
 Once the package has been removed, the package's bugs should be handled.  They
@@ -1300,7 +1294,7 @@ process to rename it.  First, set your <filename>debian/control</filename> file
 to replace and conflict with the obsolete name of the package (see the <ulink
 url="&url-debian-policy;">Debian Policy Manual</ulink> for
 details).  Once you've uploaded the package and the package has moved into the
-archive, file a bug against <literal>&ftp-debian-org;</literal> asking to remove
+archive, file a bug against <literal>ftp.debian.org</literal> asking to remove
 the package with the obsolete name.  Do not forget to properly reassign the
 package's bugs at the same time.
 </para>
@@ -1323,15 +1317,15 @@ mirror network.
 <para>
 If you can no longer maintain a package, you need to inform others, and see
 that the package is marked as orphaned.  You should set the package maintainer
-to <literal>Debian QA Group &lt;&pts-host;&gt;</literal> and submit
-a bug report against the pseudo package <systemitem
+to <literal>Debian QA Group &orphan-address;</literal> and
+submit a bug report against the pseudo package <systemitem
 role="package">wnpp</systemitem>.  The bug report should be titled <literal>O:
 <replaceable>package</replaceable> -- <replaceable>short
 description</replaceable></literal> indicating that the package is now
 orphaned.  The severity of the bug should be set to
 <emphasis>normal</emphasis>; if the package has a priority of standard or
 higher, it should be set to important.  If you feel it's necessary, send a copy
-to <email>debian-devel@&lists-host;</email> by putting the address in the
+to &email-debian-devel; by putting the address in the
 X-Debbugs-CC: header of the message (no, don't use CC:, because that way the
 message's subject won't indicate the bug number).
 </para>
@@ -1371,8 +1365,8 @@ package.  Complaints about maintainers should be brought up on the developers'
 mailing list.  If the discussion doesn't end with a positive conclusion, and
 the issue is of a technical nature, consider bringing it to the attention of
 the technical committee (see the <ulink
-url="&url-devel-docs;tech-ctte">technical committee web
-page</ulink> for more information).
+url="&url-tech-ctte;">technical committee web page</ulink> for
+more information).
 </para>
 <para>
 If you take over an old package, you probably want to be listed as the
@@ -1758,7 +1752,7 @@ architectures: A porter or any other person trying to build your package might
 accidently upload it without noticing it doesn't work.  If in the past some
 binary packages were uploaded on unsupported architectures, request their
 removal by filing a bug against <systemitem
-role="package">&ftp-debian-org;</systemitem>
+role="package">ftp.debian.org</systemitem>
 </para>
 </section>
 
@@ -2032,8 +2026,8 @@ Unless you know the maintainer is still active, it is wise to check the package
 to see if it has been orphaned.  The current list of orphaned packages which
 haven't had their maintainer set correctly is available at <ulink
 url="&url-debian-qa-orphaned;"></ulink>.  If you perform an NMU on an
-improperly orphaned package, please set the maintainer to ``Debian QA Group
-&lt;&pts-host;&gt;''.
+improperly orphaned package, please set the maintainer to <literal>Debian QA Group
+&lt;packages@qa.debian.org&gt;</literal>.
 </para>
 </section>
 
@@ -2102,7 +2096,9 @@ co-maintainers.
 Generally there is a primary maintainer and one or more co-maintainers.  The
 primary maintainer is the person whose name is listed in the
 <literal>Maintainer</literal> field of the <filename>debian/control</filename>
-file.  Co-maintainers are all the other maintainers.
+file.  Co-maintainers are all the other maintainers,
+usually listed in the <literal>Uploaders</literal> field of the
+<filename>debian/control</filename> file.
 </para>
 <para>
 In its most basic form, the process of adding a new co-maintainer is quite
@@ -2120,7 +2116,7 @@ such as <command>CVS</command> or <command>Subversion</command>.  Alioth (see
 <listitem>
 <para>
 Add the co-maintainer's correct maintainer name and address to the
-<literal>Uploaders</literal> field in the global part of the
+<literal>Uploaders</literal> field in the first paragraph of the
 <filename>debian/control</filename> file.
 </para>
 <screen>
@@ -2209,8 +2205,9 @@ during a freeze, or testing transitions may be switched off altogether;
 </listitem>
 <listitem>
 <para>
-It must have the same number or fewer release-critical bugs than the version
-currently available in <emphasis>testing</emphasis>;
+It must not have new release-critical bugs (RC bugs affecting the version
+available in <emphasis>unstable</emphasis>, but not affecting the version in 
+<emphasis>testing</emphasis>);
 </para>
 </listitem>
 <listitem>
@@ -2238,7 +2235,7 @@ all the necessary criteria);
 <para>
 To find out whether a package is progressing into testing or not, see the
 testing script output on the <ulink
-url="&url-devel-docs;testing">web page of the testing
+url="&url-testing-maint;">web page of the testing
 distribution</ulink>, or use the program <command>grep-excuses</command> which
 is in the <systemitem role="package">devscripts</systemitem> package.  This
 utility can easily be used in a <citerefentry>
@@ -2250,7 +2247,7 @@ to keep yourself informed of the progression of your packages into
 The <filename>update_excuses</filename> file does not always give the precise
 reason why the package is refused; you may have to find it on your own by
 looking for what would break with the inclusion of the package.  The <ulink
-url="&url-devel-docs;testing">testing web page</ulink> gives some
+url="&url-testing-maint;">testing web page</ulink> gives some
 more information about the usual problems which may be causing such troubles.
 </para>
 <para>
@@ -2403,8 +2400,8 @@ considered for update.
 </para>
 <para>
 Currently, this requires some manual hinting from the release team.  Please
-contact them by sending mail to <email>debian-release@&lists-host;</email>
-if this happens to one of your packages.
+contact them by sending mail to &email-debian-release; if this
+happens to one of your packages.
 </para>
 </section>
 
@@ -2477,7 +2474,7 @@ Keep in mind that packages uploaded there are not automatically processed, they
 have to go through the hands of the release manager.  So you'd better have a
 good reason to upload there.  In order to know what a good reason is in the
 release managers' eyes, you should read the instructions that they regularly
-give on <email>debian-devel-announce@&lists-host;</email>.
+give on &email-debian-devel-announce;.
 </para>
 <para>
 You should not upload to <emphasis>testing-proposed-updates</emphasis> when you
@@ -2535,8 +2532,7 @@ and lower than in <emphasis>unstable</emphasis>;
 <listitem>
 <para>
 After uploading and successful build on all platforms, contact the release team
-at <email>debian-release@&lists-host;</email> and ask them to approve your
-upload.
+at &email-debian-release; and ask them to approve your upload.
 </para>
 </listitem>
 </itemizedlist>