X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=perl-policy.sgml;h=626c5144bc4124fbde9cbba8fcbedbc60405e5db;hb=bce4b938b4e603a7bceeaf2ad31d007d0a9dcb43;hp=1d26df7c40ab75eaa6cb2a1cf4e768c116aa7d0f;hpb=10f927594e0ddeffc217e675cbd16f380be2da4f;p=debian%2Fdebian-policy.git

diff --git a/perl-policy.sgml b/perl-policy.sgml
index 1d26df7..626c514 100644
--- a/perl-policy.sgml
+++ b/perl-policy.sgml
@@ -1,4 +1,8 @@
-<!doctype debiandoc system>
+<!doctype debiandoc system [
+<!-- include version information so we don't have to hard code it
+     within the document -->
+<!entity % versiondata SYSTEM "version.ent"> %versiondata;
+]>
 
 <debiandoc>
   <book>
@@ -14,11 +18,11 @@
 	<name>The Debian Policy mailing list</name>
 	<email>debian-policy@lists.debian.org</email>
       </author>
-      <version>version 1.20</version>
+      <version>version &version;, &date;</version>
 
       <abstract>
 	This document describes the packaging of Perl within the Debian
-	GNU/Linux distribution and the policy requirements for packaged
+	distribution and the policy requirements for packaged
 	Perl programs and modules.
       </abstract>
 
@@ -40,7 +44,7 @@
 	</p>
 	<p>
 	  A copy of the GNU General Public License is available as
-	  <tt>/usr/share/common-licenses/GPL</tt> in the Debian GNU/Linux
+	  <tt>/usr/share/common-licenses/GPL</tt> in the Debian
 	  distribution or on the World Wide Web at 
 	  <url id="http://www.gnu.org/copyleft/gpl.html"
 	  name="The GNU Public Licence">.
@@ -89,8 +93,11 @@
 	</p>
 	<p>
 	  The <package>perl-base</package> package must provide
-	  <package>perlapi-<var>version</var></package> for all released
-	  versions it is compatible with.
+	  <package>perlapi-<var>abiname</var></package> for all released
+	  package versions it is compatible with. The choice of
+	  <var>abiname</var> is arbitrary, but if it differs from
+	  <tt>$Config{version}</tt>, it must be specified in
+	  <tt>$Config{debian_abi}</tt>.
 	</p>
       </sect>
 
@@ -103,18 +110,18 @@
 	  the binary and a basic set of modules.
 	</p>
 	<p>
-	  As Perl is currently used by such things as
-	  <file>update-alternatives</file> and some package maintainer
-	  scripts, it must be priority <em>required</em> and marked as
-	  <em>essential</em>.
+	  As Perl has been part of the essential set for some time and is
+	  used without dependencies by such things as package maintainer
+	  scripts, <package>perl-base</package> must be
+	  priority <em>required</em> and marked as <em>essential</em>.
 	</p>
 	<p>
 	  Note that the <package>perl-base</package> package is intended
 	  only to provide for exceptional circumstances and the contents
-	  may change.  In general only packages which form part of the
-	  base system should declare a dependency on
-	  <package>perl-base</package> rather than
-	  <package>perl</package>.
+	  may change.  In general, only packages which form part of the
+	  base system should use only the facilities
+	  of <package>perl-base</package> rather than declaring a
+	  dependency on <package>perl</package>.
 	</p>
       </sect>
 
@@ -190,8 +197,8 @@
 	  package.
 	</p>
 	<p>
-	  Manual pages distributed with Perl packages must be installed
-	  into the standard directories:
+	  Manual pages distributed with packages built from the perl
+	  source package must be installed into the standard directories:
 	  <taglist>
 	    <tag>Programs</tag>
 	    <item>
@@ -210,6 +217,8 @@
 	      </p>
 	    </item>
 	  </taglist>
+	  The extensions used for manual pages distributed with module
+	  packages are different.  See <ref id="vendor_dirs">.
 	</p>
       </sect>
     </chapt>
@@ -291,10 +300,17 @@ make install
 	<heading>Module Package Names</heading>
 	<p>
 	  Perl module packages should be named for the primary module
-	  provided.  The naming convention for module <tt>Foo::Bar</tt>
-	  is <package>libfoo-bar-perl</package>.  Packages which include
-	  multiple modules may additionally include provides for those
-	  modules using the same convention.
+	  provided.  The naming convention is to lowercase the Perl module
+	  name, prepend, <tt>lib</tt>, change all occurrences
+	  of <tt>::</tt> to <tt>-</tt>, and append <tt>-perl</tt>.  For
+	  example:
+	  <example>
+Foo::Bar        libfoo-bar-perl
+Foo::Bar::Baz   libfoo-bar-baz-perl
+Foo::BarBaz     libfoo-barbaz-perl
+	  </example>
+	  Packages which include multiple modules may additionally include
+	  provides for the additional modules using the same convention.
 	</p>
       </sect>
 
@@ -313,7 +329,7 @@ $(MAKE) OPTIMIZE="-O2 -g -Wall"
 	  </example>
 	  and this one to install the results into the temporary tree:
 	  <example>
-$(MAKE) install PREFIX=$(CURDIR)/debian/&lt;tmp&gt;/usr
+$(MAKE) install DESTDIR=$(CURDIR)/debian/&lt;tmp&gt;
 	  </example><footnote>
 	    <p>Replace &lt;tmp&gt; with the appropriate directory
 	    (nominally just tmp)</p>
@@ -348,8 +364,9 @@ $(MAKE) install PREFIX=$(CURDIR)/debian/&lt;tmp&gt;/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> using
-	    the <tt>Config</tt> module.
+	    <package>perlapi-$Config{debian_abi}</package> using
+	    the <tt>Config</tt> module. If <tt>$Config{debian_abi}</tt>
+	    is empty or not set, <tt>$Config{version}</tt> must be used.
 	  </p>
 	</sect1>
 
@@ -446,6 +463,26 @@ perl -MExtUtils::Embed -e ldopts
 	  package must depend upon it explicitly.
 	</p>
       </sect>
+
+      <sect id="perl_upgrades">
+        <heading>Perl Package Upgrades</heading>
+        <p>
+          Starting from <package>perl</package> 5.12.3-2, a dpkg trigger
+          named <var>perl-major-upgrade</var> will be triggered by the
+          postinst of the <package>perl</package> package during major
+          upgrades. Some examples of things which constitute a major upgrade
+          are an upgrade which would change the value of versioned
+          directories in <tt>@INC</tt>, or one which changes <tt>abiname</tt>.
+          Any package may declare an interest in the trigger, especially
+          packages including long-running daemons which would stop working
+          until restart.
+        </p>
+        <p>
+          It is suggested that such packages include an appropriate section
+          in their postinst to handle the trigger by restarting relevant
+          daemons or notifying users of further action.
+        </p>
+      </sect>
     </chapt>
 
     <appendix id="perl6">