docs/97477: [PATCH] Porter's Handbook: clarify why OPTIONS need testing the way they do

[Shaun Amott]

>Number:         97477
>Category:       docs
>Synopsis:       [PATCH] Porter's Handbook: clarify why OPTIONS need testing the way they do
>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:   Fri May 19 02:50:12 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator:     Shaun Amott
>Release:        FreeBSD 6.1-STABLE i386
>Organization:
>Environment:

>Description:

It has recently come to light that the note about having to test OPTIONS
in a particular way does not provide an adequete explanation as to what
the problem is.

Therefore, I propose the following minor addition in order to help clear
things up.

I twiddled the punctuation a bit in the shifted 'Due to a deficiency...'
statement, because it was difficult to read.

>How-To-Repeat:

>Fix:

	

--- book.sgml.diff begins here ---
Index: book.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.709
diff -u -r1.709 book.sgml
--- book.sgml	18 May 2006 05:05:30 -0000	1.709
+++ book.sgml	19 May 2006 02:17:40 -0000
@@ -3825,12 +3825,20 @@
 	      the inclusion of <filename>bsd.port.pre.mk</filename>.
 	      The <makevar>WITH_*</makevar> and <makevar>WITHOUT_*</makevar>
 	      variables can only be tested after the inclusion of
-	      <filename>bsd.port.pre.mk</filename>.  Due to a deficiency
-	      in the infrastructure, you can only test
-	      <makevar>WITH_*</makevar> variables for options, which are
+	      <filename>bsd.port.pre.mk</filename>.</para>
+
+	    <para>
+	      Due to a deficiency in the infrastructure, you can only test
+	      <makevar>WITH_*</makevar> variables for options which are
 	      <literal>OFF</literal> by default, and
-	      <makevar>WITHOUT_*</makevar> variables for options, which
-	      defaults to <literal>ON</literal>.</para>
+	      <makevar>WITHOUT_*</makevar> variables for options which
+	      default to <literal>ON</literal>.  The reason for this is
+	      that when packages are built on the build cluster, or if
+	      <makevar>BATCH</makevar> is defined, the <command>config</command>
+	      target is not run, and therefore no <makevar>OPTIONS</makevar>
+	      are defined. This would cause <command>make depends</command> and
+	      <command>make describe</command> to break for ports not following
+	      the aforementioned rule.</para>
 
 	<sect3>
 	  <title>Example</title>
--- book.sgml.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted: