Date: 1 Jun 2001 06:47:02 -0000 From: mwm@mired.org To: FreeBSD-gnats-submit@freebsd.org Subject: docs/27807: [PATCH] The port variables for optional packages aren't documented Message-ID: <20010601064702.30374.qmail@guru.mired.org>
next in thread | raw e-mail | index | archive | help
>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: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Thu May 31 23:50:01 PDT 2001
>Closed-Date:
>Last-Modified:
>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:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010601064702.30374.qmail>