docs/99554: [patch] suggestion about MASTER_SITE_SUBDIR for perl in porter's handbook

[Cheng-Lung Sung]

>Number:         99554
>Category:       docs
>Synopsis:       [patch] suggestion about MASTER_SITE_SUBDIR for perl in porter's handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          update
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jun 27 16:00:37 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator:     Cheng-Lung Sung
>Release:        FreeBSD 6.1-PRERELEASE i386
>Organization:
FreeBSD @ Taiwan
>Environment:
System: FreeBSD FreeBSD.csie.nctu.edu.tw 6.1-PRERELEASE FreeBSD 6.1-PRERELEASE #7: Thu Apr 13 03:20:20 CST 2006 root at FreeBSD.csie.nctu.edu.tw:/home/usr.obj/usr/src/sys/FREEBSD i386

>Description:
    We encourage p5-* ports maintainer to set MASTER_SITE_SUBDIR to module's
upper-level name, but this is not documented.
>How-To-Repeat:
>Fix:

--- porters-handbook/book.sgml.orig	Tue Jun 27 18:44:10 2006
+++ porters-handbook/book.sgml	Tue Jun 27 23:49:25 2006
@@ -4561,6 +4561,32 @@
     <sect1 id="using-perl">
       <title>Using <literal>perl</literal></title>
 
+      <para>If <literal>MASTER_SITES</literal> is set to 
+	<literal>${MASTER_SITE_PERL_CPAN}</literal>, 
+	then preferred value of <literal>MASTER_SITE_SUBDIR</literal> 
+	is top-level hierarchy name instead of author's id. 
+	For example, the recommend value for 
+	<literal>p5-Module-Name</literal> is <literal>Module</literal>.
+	The top-level hierarchy can be examined in 
+	<ulink url="http://cpan.org/modules/by-module/">cpan.org</ulink>.
+      </para>
+
+      <para>The exception is:</para>
+	<itemizedlist>
+	  <listitem>
+	    <para>The top-level hierarchy name of module does not exist in 
+	      <ulink url="http://cpan.org/modules/by-module/">cpan.org</ulink>.
+	      In such case, using author's id is more appropriate.
+	    </para>
+	  </listitem>
+	</itemizedlist>
+
+      <note>
+	<para>The reasons is that author of the Perl module may
+	  change, and it will cause <maketarget>fetch</maketarget>
+	  cannot find the required files.</para>
+      </note>
+
       <table frame="none">
 	<title>Variables for ports that use <literal>perl</literal></title>
 

>Release-Note:
>Audit-Trail:
>Unformatted: