From mwm@mired.org  Thu May 31 23:47:03 2001
Return-Path: <mwm@mired.org>
Received: from guru.mired.org (okc-65-26-235-186.mmcable.com [65.26.235.186])
	by hub.freebsd.org (Postfix) with SMTP id AF5A537B440
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 31 May 2001 23:47:02 -0700 (PDT)
	(envelope-from mwm@mired.org)
Received: (qmail 30375 invoked by uid 100); 1 Jun 2001 06:47:02 -0000
Message-Id: <20010601064702.30374.qmail@guru.mired.org>
Date: 1 Jun 2001 06:47:02 -0000
From: mwm@mired.org
Reply-To: mwm@mired.org
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] The port variables for optional packages aren't documented
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         27807
>Category:       docs
>Synopsis:       [PATCH] The port variables for optional packages aren't documented
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu May 31 23:50:01 PDT 2001
>Closed-Date:    Fri Jun 1 20:00:09 PDT 2001
>Last-Modified:  Fri Jun 01 20:00:27 PDT 2001
>Originator:     Mike Meyer
>Release:        FreeBSD 4.3-STABLE i386
>Organization:
Meyer Consulting
>Environment:
System: FreeBSD guru.mired.org 4.3-STABLE FreeBSD 4.3-STABLE #17: Sun May 27 08:47:01 CDT 2001 mwm@guru.mired.org:/sharetmp/obj/usr/src/sys/GURU i386

>Description:

The various WANT/HAVE ports Makefile variables arent't documented in
the porters handbook. Neither is WITHOUT_X.

>How-To-Repeat:

Read the porters handbook looking for information on WITH_GIMP, etc.

>Fix:

Apply the attached patch to the porters handbook. WITHOUT_X has
already been documented in the make.conf man page. WITH/WITHOUT_* for
the WANT/HAVE variables should be done after this patch is
committed. And yes, I'm willing to write that up as well.

--- porters-handbook/book.sgml-orig	Thu May 31 21:21:58 2001
+++ porters-handbook/book.sgml	Fri Jun  1 01:42:20 2001
@@ -1265,6 +1265,42 @@
         </sect2>
       </sect1>
 
+     <sect1>
+      <title>Optional dependencies</title>
+      
+      <para>Some large applications can be built in a number of
+	configurations, adding functionality if one of a number of
+	libraries or applications is available. Since not all users
+	want those libraries or applications, the ports system
+	provides hooks that the port author can use to decide which
+	configuration should be built. Supporting these properly will
+	make uses happy, and effectively provide 2 or more ports for the
+	price of one.</para>
+	
+      <para>The easiest of these to use is
+	<literal>WITHOUT_X</literal>. If the port can be built both
+	with and without X support, then it should normally be built
+	with X support. If <literal>WITHOUT_X</literal> is defined,
+	then the version that does not have X support should be
+	built.</para>
+	
+      <para>Various parts of GNOME have such knobs, though they are
+	slightly more difficult to use. The variables to use in the
+	<filename>Makefile</filename> are <makevar>WANT_*</makevar>
+	and <makevar>HAVE_*</makevar>. If the application can be
+	built both with or without one of the dependencies listed
+	below, then the <filename>Makefile</filename> should set
+	<makevar>WANT_PKG</makevar>, and should build the version that
+	uses <makevar>PKG</makevar> if <makevar>HAVE_PKG</makevar>
+	is defined.</para>
+	
+      <para>The <makevar>WANT_*</makevar> variables currently
+	supported this way are <makevar>WANT_GLIB</makevar>,
+	<makevar>WANT_GTK</makevar>, <makevar>WANT_ESOUND</makevar>,
+	<makevar>WANT_IMLIB</makevar>, and
+	<makevar>WANT_GNOME</makevar>.</para>
+      </sect1>
+
       <sect1>
         <title>Building mechanisms</title>
 

>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: mwm@mired.org
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/27807: [PATCH] The port variables for optional packages aren't documented 
Date: Fri, 01 Jun 2001 00:19:03 -0700

 mwm@mired.org writes:
 > Apply the attached patch to the porters handbook. WITHOUT_X has
 > already been documented in the make.conf man page. WITH/WITHOUT_* for
 > the WANT/HAVE variables should be done after this patch is
 > committed. And yes, I'm willing to write that up as well.
 
 I hope you don't intend on documenting (WANT|HAVE)_* in the man page;
 they certainly don't belong there.  Sticking them along side the
 discussion of dependencies or some such in the Porter's Handbook would
 be great, though.
 
 > +      <para>The easiest of these to use is
 > +	<literal>WITHOUT_X</literal>. If the port can be built both
 
 Isn't WITHOUT_X a make variable?  I.e., shouldn't it be marked up with
 <makevar>?
 
 Other than that, this looks great!  I'll commit it later today.
 
 					Dima Dorfman
 					dima@unixfreak.org

From: Mike Meyer <mwm@mired.org>
To: Dima Dorfman <dima@unixfreak.org>
Cc: mwm@mired.org, FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/27807: [PATCH] The port variables for optional packages aren't documented 
Date: Fri, 1 Jun 2001 13:14:07 -0500

 Dima Dorfman <dima@unixfreak.org> types:
 > mwm@mired.org writes:
 > > Apply the attached patch to the porters handbook. WITHOUT_X has
 > > already been documented in the make.conf man page. WITH/WITHOUT_* for
 > > the WANT/HAVE variables should be done after this patch is
 > > committed. And yes, I'm willing to write that up as well.
 > I hope you don't intend on documenting (WANT|HAVE)_* in the man page;
 > they certainly don't belong there.  Sticking them along side the
 > discussion of dependencies or some such in the Porter's Handbook would
 > be great, though.
 
 Nope, I wasn't going to do that. What would go in the man page would
 be the WITH/WITHOUT variables.
 
 > > +      <para>The easiest of these to use is
 > > +	<literal>WITHOUT_X</literal>. If the port can be built both
 > Isn't WITHOUT_X a make variable?  I.e., shouldn't it be marked up with
 > <makevar>?
 
 Yes, it is, and yes, it should. I should have caught that when I
 proofed it.
 
 	Thanx,
 	<mike
 --
 Mike Meyer <mwm@mired.org>			http://www.mired.org/home/mwm/
 Independent WWW/Perforce/FreeBSD/Unix consultant, email for more information.
State-Changed-From-To: open->closed 
State-Changed-By: dd 
State-Changed-When: Fri Jun 1 20:00:09 PDT 2001 
State-Changed-Why:  
Committed, thanks! 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=27807 
>Unformatted:
