Sync with upstream

[debian/debian-policy.git] / perl-policy.sgml

diff --git a/perl-policy.sgml b/perl-policy.sgml
index 94ba0c25dbbb875580ecf484b61303ff46916843..1421b46892a622124e0803da2a1a57daf0455f58 100644 (file)
--- a/perl-policy.sgml
+++ b/perl-policy.sgml
@@ -6,13 +6,15 @@
       <title>Debian Perl Policy</title>
       <author>
        <name>Rapha&euml;l Hertzog</name>
-       <email>hertzog@debian.org</email>
       </author>
       <author>
        <name>Brendan O'Dea</name>
-       <email>bod@debian.org</email>
       </author>
-      <version>version 1.19</version>
+      <author>
+       <name>The Debian Policy mailing list</name>
+       <email>debian-policy@lists.debian.org</email>
+      </author>
+      <version>version 1.20</version>
 
       <abstract>
        This document describes the packaging of Perl within the Debian
@@ -38,21 +40,33 @@
        </p>
        <p>
          A copy of the GNU General Public License is available as
-         <tt>/usr/share/common-licences/GPL</tt> in the Debian GNU/Linux
+         <tt>/usr/share/common-licenses/GPL</tt> in the Debian GNU/Linux
          distribution or on the World Wide Web at 
          <url id="http://www.gnu.org/copyleft/gpl.html"
          name="The GNU Public Licence">.
        </p>
        <p>
          You can also obtain it by writing to the
-         Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-         Boston, MA 02111-1307, USA.
+         Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+         Boston, MA 02110-1301, USA. 
        </p>
       </copyright>
     </titlepag>
 
     <toc detail="sect">
 
+    <chapt>
+      <heading>About this document</heading>
+      <p>
+       This document is distributed as the <tt>perl-policy</tt> files
+       in the Debian package
+        <package><url name="debian-policy" id="http://packages.debian.org/debian-policy"></package>.
+       It is also available from the Debian web mirrors at
+       <tt><url name="/doc/packaging-manuals/perl-policy/"
+               id="http://www.debian.org/doc/packaging-manuals/perl-policy/"></tt>.
+      </p>
+    </chapt>
+
     <chapt id="perl">
       <heading>Perl Packaging</heading>
       <sect id="versions">
@@ -299,8 +313,11 @@ $(MAKE) OPTIMIZE="-O2 -g -Wall"
          </example>
          and this one to install the results into the temporary tree:
          <example>
-$(MAKE) install PREFIX=$(CURDIR)/debian/tmp/usr
-         </example>
+$(MAKE) install PREFIX=$(CURDIR)/debian/&lt;tmp&gt;/usr
+         </example><footnote>
+           <p>Replace &lt;tmp&gt; with the appropriate directory
+           (nominally just tmp)</p>
+         </footnote>
        </p>
        <p>
          A <tt>Build-Depends</tt> on <tt>perl (>= 5.6.0-16)</tt> is
@@ -342,7 +359,8 @@ $(MAKE) install PREFIX=$(CURDIR)/debian/tmp/usr
            a minimum version of the <package>perl</package> package
            used to build the module, and must additionally depend on
            the expansion of
-           <package>perlapi-$Config{version}</package>.
+           <package>perlapi-$Config{version}</package> using
+           the <tt>Config</tt> module.
          </p>
        </sect1>
 
@@ -352,14 +370,22 @@ $(MAKE) install PREFIX=$(CURDIR)/debian/tmp/usr
            Rather than hard-coding the dependencies into the control
            file, using a substitution such as <tt>${perl:Depends}</tt>
            is suggested.  This allows the dependencies to be determined
-           as build time and written to the <file>substvars</file> file
-           in the form <tt>perl:Depends=<var>deps</var></tt>.
+           at build time and written to the <file>substvars</file> file
+           in the form
+           <tt>perl:Depends=<var>deps</var></tt>.<footnote>
+             <p>Please note that dependencies caused by versioned
+             uses and on separately packaged modules are not included
+             in this variable and must be explicitly included.</p>
+           </footnote>
          </p>
          <p>
-           Packages built with <prgn>debhelper</prgn> may use <manref
-           name="dh_perl" section=1> to generate this substitution
-           automatically.  Additionally requires a
-           <tt>Build-Depends</tt> on <tt>debhelper (>= 3.0.18)</tt>.
+           Packages built with <prgn>debhelper</prgn> may use
+
+           <manref name="dh_perl" section="1"> to generate this
+           substitution automatically.  This additionally requires a
+           versioned <tt>Build-Depends</tt> (or
+           <tt>Build-Depends-Indep</tt>) on <tt>debhelper (>=
+           3.0.18)</tt>.
          </p>
        </sect1>
       </sect>
@@ -393,7 +419,7 @@ $(MAKE) install PREFIX=$(CURDIR)/debian/tmp/usr
        </p>
        <p>
          As with modules, packages using <prgn>debhelper</prgn> may use
-         <manref name="dh_perl" section=1> to automatically generate
+         <manref name="dh_perl" section="1"> to automatically generate
          dependences (see <ref id="dh_perl">).
        </p>
       </sect>
@@ -462,3 +488,6 @@ perl -MExtUtils::Embed -e ldopts
     </appendix>
   </book>
 </debiandoc>
+<!-- Local variables: -->
+<!-- indent-tabs-mode: t -->
+<!-- End: -->