svn commit: r39455 - head/en_US.ISO8859-1/books/porters-handbook

[Glen Barber]

Author: gjb
Date: Mon Aug 27 03:44:33 2012
New Revision: 39455
URL: http://svn.freebsd.org/changeset/doc/39455

Log:
  Document PORTSCOUT Makefile usage, and provide a few examples.
  
  Reviewed by:	wblock

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/book.sgml

Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Sun Aug 26 22:04:06 2012	(r39454)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Mon Aug 27 03:44:33 2012	(r39455)
@@ -3449,6 +3449,56 @@ ALWAYS_KEEP_DISTFILES=	yes
 	<filename>Makefile</filename>.</para>
     </sect1>
 
+    <sect1 id="makefile-portscout">
+      <title><makevar>PORTSCOUT</makevar></title>
+
+      <para><application>Portscout</application> is an automated
+	distfile check utility for the &os;&nbsp;Ports Collection,
+	described in detail in
+	<xref linkend="distfile-survey">.</para>
+
+      <para>The <makevar>PORTSCOUT</makevar> variable defines
+	special conditions within which the
+	<application>Portscout</application> distfile
+	scanner should be restricted.</para>
+
+      <para>Situations where the <makevar>PORTSCOUT</makevar>
+	variable should be set include:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para>When distfiles should be ignored, whether for
+	    specific versions, or specific minor revisions.  For
+	    example, to exclude version
+	    <replaceable>8.2</replaceable> from distfile version
+	    checks because it is known to be broken, add:</para>
+
+	  <programlisting>PORTSCOUT=	ignore:8.2</programlisting>
+
+	</listitem>
+	<listitem>
+	  <para>When specific versions or specific major and minor
+	    revisions of a distfile should be checked.  For
+	    example, if only version
+	    <replaceable>0.6.4</replaceable> should be monitored
+	    because newer versions have compatablity issues with
+	    &os;, add:</para>
+
+	  <programlisting>PORTSCOUT=	limit:^0\.6\.4</programlisting>
+
+	</listitem>
+	<listitem>
+	  <para>When URLs listing the available versions differ
+	    from the download URLs.  For example, to limit
+	    distfile version checks to the download page for the
+	    <filename role="package">databases/pgtune</filename>
+	    port, add:</para>
+
+	  <programlisting>PORTSCOUT=	site:http://pgfoundry.org/frs/?group_id=1000416</programlisting>
+	</listitem>
+      </itemizedlist>
+    </sect1>
+
     <sect1 id="makefile-depend">
       <title>Dependencies</title>