docs/167295: [PATCH] porters-handbook: document PERL recommended dependency

[Jason Helfman]

>Number:         167295
>Category:       docs
>Synopsis:       [PATCH] porters-handbook: document PERL recommended dependency
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Apr 25 18:10:07 UTC 2012
>Closed-Date:
>Last-Modified:
>Originator:     Jason Helfman
>Release:        FreeBSD 8.3-RELEASE amd64
>Organization:
>Environment:
System: FreeBSD dormouse.experts-exchange.com 8.3-RELEASE FreeBSD 8.3-RELEASE #0: Mon Apr  9 21:23:18 UTC
>Description:
document PERL recommended dependency
portions migrated from wiki:
http://wiki.freebsd.org/PortsLongtermTargets#Use_of_SITE_PERL_in_dependencies

Port maintainer (doc at FreeBSD.org) is cc'd.

Generated with FreeBSD Port Tools 0.99_5 (mode: change, diff: CVS)
>How-To-Repeat:
>Fix:

--- .patch begins here ---
Index: book.sgml
===================================================================
RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.1182
diff -u -r1.1182 book.sgml
--- book.sgml	22 Apr 2012 03:20:30 -0000	1.1182
+++ book.sgml	25 Apr 2012 17:58:30 -0000
@@ -5600,6 +5600,23 @@
 	  <literal>http://search.cpan.org/dist/Module-Name/</literal>
 	  (including the trailing slash).</para>
       </note>
+      <note>
+        <para>It is <emphasis>not</emphasis> recommended to use <literal>
+	  ${SITE_PERL}</literal> as a dependency listing. This is problematic
+	  because it means that bsd.perl.mk must be included to satisfy the
+	  dependency.
+	</para>
+      </note>
+
+	<example id="use-perl-not-recommended-example">
+	  <title>PERL Not Recommended Dependency Example</title>
+	  <programlisting>${SITE_PERL}/IO/Tee.pm:${PORTSDIR}/devel/p5-IO-Tee</programlisting>
+	</example>
+
+	<example id="use-perl-dependency-example">
+	  <title>PERL Recommended Dependency Example</title>
+	  <programlisting>p5-IO-Tee>=0.64:${PORTSDIR}/devel/p5-IO-Tee</programlisting>
+	</example>
     </sect1>
 
     <sect1 id="using-x11">
--- .patch ends here ---

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