add stuff for dinstall bug closing; note alternate names for DSA

git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@842 313b444b-1b9f-4f58-a734-7bb04f332e8d

diff --git a/debian/changelog b/debian/changelog
index 4bedc9652e000599aedc04b4f457a1dd94271c3b..dc477b6d6c2d6f7639e86ae93c1105a6792b3861 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,14 +2,18 @@ developers-reference (2.7.1) unstable; urgency=low
 
   * Sec. "Registering as a Debian developer": we are transitioning away
     from non-free PGP -- remove allusions to non-free software such as
 
   * Sec. "Registering as a Debian developer": we are transitioning away
     from non-free PGP -- remove allusions to non-free software such as

-    PGPv2 or v5 insofar as possible; recommend use of DSA keys rather than
+    PGPv2 or v5 insofar as possible; recommend use of DSS keys rather than

     RSA
   * Sec. "Maintaining Your Public Key": remove PGP-centric stuff
     RSA
   * Sec. "Maintaining Your Public Key": remove PGP-centric stuff

+  * Sec. "When bugs are closed by new uploads": describe how to close bugs
+    via a magic changelog entry (closes: Bug#43690)
+  * Sec. "Generating the changes file": refer to Sec. "When bugs are
+    closed by new uploads" for closing bugs via a changelog entry

   * developers-reference.sgml: re-enable RCS variables in CVS sources
   * debian/control,rules: dynamically generate the TOC in the package
     description from developers-reference.sgml
 
   * developers-reference.sgml: re-enable RCS variables in CVS sources
   * debian/control,rules: dynamically generate the TOC in the package
     description from developers-reference.sgml
 

- -- Adam Di Carlo <aph@debian.org>  Sat, 11 Sep 1999 21:22:10 -0400
+ --

 
 developers-reference (2.7.0) unstable; urgency=low
 
 
 developers-reference (2.7.0) unstable; urgency=low
 

diff --git a/developers-reference.sgml b/developers-reference.sgml
index 987c7d3824ed9403d83b3eb7f80f078409c19e21..40e198746cabc6c1d055a1c4a68eece2b8e07e7a 100644 (file)
--- a/developers-reference.sgml
+++ b/developers-reference.sgml
@@ -5,7 +5,7 @@
   <!-- common, language independant entities -->
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
   <!-- CVS revision of this document -->
   <!-- common, language independant entities -->
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
   <!-- CVS revision of this document -->

-  <!entity cvs-rev "$Revision: 1.36 $">
+  <!entity cvs-rev "$Revision: 1.37 $">

 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->
 
   <!-- if you are translating this document, please notate the RCS
        revision of the developers reference here -->


@@ -191,11 +191,12 @@ OpenPGP is a open standard based on <url id="&url-rfc2440;" name="RFC
 2440">.
        <p>
 The recommended public key algorithm for use in Debian development
 2440">.
        <p>
 The recommended public key algorithm for use in Debian development

-work is the DSA (Digital Signature Standard).  Other key types may be
-used however.  Your key length must be at least 1024 bits; there is no
-reason to use a smaller key, and doing so would be much less secure.
-Your key must be signed with at least your own user ID; this prevents
-user ID tampering.  <prgn>gpg</prgn> does this automatically.
+work is the DSA (sometimes call ``DSS'' or ``DH/ElGamal'').  Other key
+types may be used however.  Your key length must be at least 1024
+bits; there is no reason to use a smaller key, and doing so would be
+much less secure.  Your key must be signed with at least your own user
+ID; this prevents user ID tampering.  <prgn>gpg</prgn> does this
+automatically.

        <p>
 Also remember that one of the names on your key must match the email
 address you list as the official maintainer for your packages.  For
        <p>
 Also remember that one of the names on your key must match the email
 address you list as the official maintainer for your packages.  For


@@ -804,9 +805,11 @@ The changes file is a control file with the following fields:
          <p>
 All of these fields are mandatory for a Debian upload.  See the list
 of control fields in the <url id="&url-pkg-manual;" name="Debian
          <p>
 All of these fields are mandatory for a Debian upload.  See the list
 of control fields in the <url id="&url-pkg-manual;" name="Debian

-Packaging Manual"> for the contents of these fields.  Only the
-<tt>Distribution</tt> field is discussed here, since it relates to the
-archive maintenance policies.
+Packaging Manual"> for the contents of these fields.  You can close
+bugs automatically using the <tt>Description</tt> field, see <ref
+id="upload-bugfix">.  Only the <tt>Distribution</tt> field is
+discussed in this section, since it relates to the archive maintenance
+policies.

 
 
        <sect1 id="upload-dist">Picking a distribution
 
 
        <sect1 id="upload-dist">Picking a distribution


@@ -1712,7 +1715,7 @@ You should <em>never</em> close bugs via the bug server `close'
 command sent to &email-bts-control;.  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.
 

-      <sect>When bugs are closed by new uploads
+      <sect id="upload-bugfix">When bugs are closed by new uploads

        <p>
 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,
        <p>
 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,


@@ -1721,8 +1724,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.
        <p>
 notification that your updated package has been installed into the
 archive, you can and should close the bug in the BTS.
        <p>

-Again, see the BTS documentation for details on how to do this.
-Often, it is sufficient to mail the <tt>.changes</tt> file to
+If you are using a new version of <package>dpkg-dev</package> and you
+do your changelog entry properly, <prgn>dinstall</prgn> will close the
+bugs automatically.  All you have to do is follow a certain syntax
+in your <file>debian/changelog</file> file:
+<example>
+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.
+</example>
+
+Technically speaking, the following Perl regular expression is what is
+used:
+<example>
+  /closes:\s*(bug)?\#\d+(,\s*(bug)?\#\d+)*/gi
+</example>
+
+The author prefers the <tt>(closes: Bug#<var>XXX</var>)</tt> syntax,
+since it stands out from the rest of the changelog entries.
+       <p>
+If you want to close bugs the old fashioned, manual way, it is usually
+sufficient to mail the <tt>.changes</tt> file to

 <email>XXX-done@bugs.debian.org</email>, where <var>XXX</var> is your
 bug number.
 
 <email>XXX-done@bugs.debian.org</email>, where <var>XXX</var> is your
 bug number.