From owner-freebsd-doc@FreeBSD.ORG  Fri May 19 02:50:13 2006
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@hub.freebsd.org
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 7383B16A420
	for <freebsd-doc@hub.freebsd.org>; Fri, 19 May 2006 02:50:13 +0000 (UTC)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id F300143D49
	for <freebsd-doc@hub.freebsd.org>; Fri, 19 May 2006 02:50:12 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.13.4/8.13.4) with ESMTP id k4J2oC1s031917
	for <freebsd-doc@freefall.freebsd.org>; Fri, 19 May 2006 02:50:12 GMT
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.13.4/8.13.4/Submit) id k4J2oCh8031916;
	Fri, 19 May 2006 02:50:12 GMT (envelope-from gnats)
Resent-Date: Fri, 19 May 2006 02:50:12 GMT
Resent-Message-Id: <200605190250.k4J2oCh8031916@freefall.freebsd.org>
Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer)
Resent-To: freebsd-doc@FreeBSD.org
Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org,
	Shaun Amott <shaun@inerd.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 9946116A42A
	for <FreeBSD-gnats-submit@freebsd.org>;
	Fri, 19 May 2006 02:45:21 +0000 (UTC) (envelope-from shaun@inerd.com)
Received: from dione.picobyte.net (host-212-158-207-124.bulldogdsl.com
	[212.158.207.124])
	by mx1.FreeBSD.org (Postfix) with SMTP id 0434F43D49
	for <FreeBSD-gnats-submit@freebsd.org>;
	Fri, 19 May 2006 02:45:20 +0000 (GMT) (envelope-from shaun@inerd.com)
Received: from charon.picobyte.net (charon.picobyte.net
	[IPv6:2001:4bd0:201e::fe03])
	by dione.picobyte.net (Postfix) with ESMTP
	for <FreeBSD-gnats-submit@freebsd.org>;
	Fri, 19 May 2006 03:45:18 +0100 (BST)
Message-Id: <1148006718.8503@charon.picobyte.net>
Date: Fri, 19 May 2006 03:45:18 +0100
From: Shaun Amott <shaun@inerd.com>
To: FreeBSD-gnats-submit@FreeBSD.org
X-Send-Pr-Version: 3.113
Cc: 
Subject: docs/97477: [PATCH] Porter's Handbook: clarify why OPTIONS need
	testing the way they do
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
Reply-To: Shaun Amott <shaun@inerd.com>
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Fri, 19 May 2006 02:50:13 -0000


>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: