From mwm@mired.org  Sat Jun  2 18:53:06 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 7906D37B423
	for <FreeBSD-gnats-submit@freebsd.org>; Sat,  2 Jun 2001 18:53:05 -0700 (PDT)
	(envelope-from mwm@mired.org)
Received: (qmail 51271 invoked by uid 100); 3 Jun 2001 01:53:04 -0000
Message-Id: <20010603015304.51270.qmail@guru.mired.org>
Date: 3 Jun 2001 01:53:04 -0000
From: mwm@mired.org
Reply-To: mwm@mired.org
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] make.conf WITH_* variables aren't documented.
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         27843
>Category:       docs
>Synopsis:       [PATCH] make.conf WITH_* variables aren't documented.
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sat Jun 02 19:00:01 PDT 2001
>Closed-Date:    Fri Dec 23 21:16:20 GMT 2005
>Last-Modified:  Fri Dec 23 21:16:20 GMT 2005
>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 WITH_* and WITHOUT_* variables in the ports make system
aren't documented.

>How-To-Repeat:

Read the make.conf man page, and notice they aren't there.

>Fix:

Here's a patch for the make.conf man page to add documentation for all
of those variables.

--- make.conf.5	Fri May 18 07:27:37 2001
+++ /tmp/make.conf.5	Sat Jun  2 20:50:02 2001
@@ -727,6 +727,51 @@
 .Pq Vt bool
 Set this if you are a resident of the USA so that ports that
 need to can attempt to comply with U.S. export regulations.
+.It Va  WITH_ESOUND / WITHOUT_ESOUND
+.Pq Vt bool
+Set WITH_ESOUND to indicate that ports for which ESOUND support is optional
+should use it.
+Set WITHOUT_ESOUND to indicate that ports for which ESOUND support is
+optional should not use it.
+If neither is set, ESOUND support will be provided if the
+.Pa audio/esound
+package is already available.
+.It Va WITH_GLIB / WITHOUT_GLIB
+.Pq Vt bool
+Set WITH_GLIB to indicate that ports for which GLIB is optional should
+use it.
+Set WITHOUT_GLIB to indicate that ports for which GLIB is optional
+should not use it.
+If neither is set, GLIB will be used if one of the
+.Pa devel/glib
+packages is already available.
+.It Va WITH_GNOME / WITHOUT_GNOME
+.Pq Vt bool
+Set WITH_GNOME to indicate that ports for which GNOME support is optional
+should use it.
+Set WITHOUT_GNOME to indicate that ports for which GNOME support is
+optional should not use it.
+If neither is set, GNOME support will be provided if the
+.Pa x11/gnome
+package is already available.
+.It Va WITH_GTK / WITHOUT_GTK
+.Pq Vt bool
+Set WITH_GTK to indicate that ports for which GTK is optional should
+use it.
+Set WITHOUT_GTK to indicate that ports for which GTK is optional
+should not use it.
+If neither is set, GTK will be used if one of the
+.Pa x11-toolkits/gtk
+packages is already available.
+.It Va WITH_IMLIB / WITHOUT_IMLIB
+.Pq Vt bool
+Set WITH_IMLIB to indicate that ports for which IMLIB is optional should
+use it.
+Set WITHOUT_IMLIB to indicate that ports for which IMLIB is optional
+should not use it.
+If neither is set, IMLIB will be used if the
+.Pa graphics/imlib
+package is already available.
 .It Va WRKDIRPREFIX
 .Pq Vt str
 Where to create temporary files used when building ports.

>Release-Note:
>Audit-Trail:

From: Ruslan Ermilov <ru@FreeBSD.ORG>
To: mwm@mired.org
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/27843: [PATCH] make.conf WITH_* variables aren't documented.
Date: Mon, 4 Jun 2001 13:38:30 +0300

 These should probably go into the ports(7) manpage.
 
 On Sun, Jun 03, 2001 at 01:53:04AM -0000, mwm@mired.org wrote:
 > 
 > The various WITH_* and WITHOUT_* variables in the ports make system
 > aren't documented.
 [...]
 
 
 
 Cheers,
 -- 
 Ruslan Ermilov		Oracle Developer/DBA,
 ru@sunbay.com		Sunbay Software AG,
 ru@FreeBSD.org		FreeBSD committer,
 +380.652.512.251	Simferopol, Ukraine
 
 http://www.FreeBSD.org	The Power To Serve
 http://www.oracle.com	Enabling The Information Age

From: Mike Meyer <mwm@mired.org>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: ports@freebsd.org, doc@freebsd.org,
	FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/27843: [PATCH] make.conf WITH_* variables aren't documented.
Date: Mon, 4 Jun 2001 06:51:58 -0500

 > On Sun, Jun 03, 2001 at 01:53:04AM -0000, mwm@mired.org wrote:
 > Ruslan Ermilov <ru@FreeBSD.ORG> types:
 > > The various WITH_* and WITHOUT_* variables in the ports make system
 > > aren't documented.
 > These should probably go into the ports(7) manpage.
 
 Possibly true. On the other hand, there's a lot of things in the
 make.conf man page that should go there as well, and a lot of
 duplication between the two.
 
 Someone should decide which of the two pages they belong in (*), merge
 them into one place with an appropriate replacement in the other, and
 add a reference to make.conf(7) to ports(7). I'm willing to do the
 work; I just want to make sure it goes in the right place before
 starting.
 
 	<mike
 
 *) I'd vote for putting them in make.conf(7), as doing so would help fix
 one of the bugs on the ports(7) man page: "This man page is too long."
 --
 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->suspended 
State-Changed-By: dd 
State-Changed-When: Tue Sep 4 02:54:46 PDT 2001 
State-Changed-Why:  
Documentation for ports options are in a state of flux in -current, 
since Alex removed all of the from make.conf(5), but, AFAIK, hasn't 
readded them anywhere yet.  Until such time as we figure out where 
they should go, this PR should be suspended. 


Responsible-Changed-From-To: freebsd-doc->alex 
Responsible-Changed-By: dd 
Responsible-Changed-When: Tue Sep 4 02:54:46 PDT 2001 
Responsible-Changed-Why:  
Alex removed things like this from make.conf(5), so perhaps he can figure 
out where this should go, and merge stuff from this PR when the time comes 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=27843 
Responsible-Changed-From-To: alex->freebsd-doc 
Responsible-Changed-By: linimon 
Responsible-Changed-When: Thu Sep 9 18:44:22 GMT 2004 
Responsible-Changed-Why:  
alex has given up his commit bit, so reset Responsible to the mailing list. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=27843 
State-Changed-From-To: suspended->closed 
State-Changed-By: linimon 
State-Changed-When: Fri Dec 23 21:14:19 UTC 2005 
State-Changed-Why:  
Since this PR came in long ago, a framework to centrally document all the 
ports knobs has been committed as ports/KNOBS.  But thanks for the submission. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=27843 
>Unformatted:
