]> git.donarmstrong.com Git - debian/debian-policy.git/commitdiff
Better explanation of the Perl module naming policy
authorRuss Allbery <rra@debian.org>
Mon, 28 Jun 2010 17:56:19 +0000 (10:56 -0700)
committerRuss Allbery <rra@debian.org>
Mon, 28 Jun 2010 17:56:19 +0000 (10:56 -0700)
* Explain the Perl module package naming policy more explicitly and
  provide some examples.  (Closes: #175202)

debian/changelog
perl-policy.sgml

index dfc424656f5115beec62852d14afc0c3a5479d8a..880a3c57a08422fc82cc9a600aefa189baec3ad7 100644 (file)
@@ -2,6 +2,8 @@ debian-policy (3.9.0.1) UNRELEASED; urgency=low
 
   * Set the version of the Perl Policy to match the version of the Policy
     package.
+  * Explain the Perl module package naming policy more explicitly and
+    provide some examples.  (Closes: #175202)
 
  -- Russ Allbery <rra@debian.org>  Mon, 28 Jun 2010 09:34:54 -0700
 
index 7c3744647f5dff6dd94e0fefd8040937c33ecf8c..3b76b940ce12086b96b410823568f6deaf672c03 100644 (file)
@@ -298,10 +298,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>