From owner-freebsd-doc Thu May 31 23:50: 9 2001 Delivered-To: freebsd-doc@freebsd.org Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by hub.freebsd.org (Postfix) with ESMTP id EEE7837B423 for ; Thu, 31 May 2001 23:50:01 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.11.1/8.11.1) id f516o1q76907; Thu, 31 May 2001 23:50:01 -0700 (PDT) (envelope-from gnats) 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 ; 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 X-Send-Pr-Version: 3.113 Subject: docs/27807: [PATCH] The port variables for optional packages aren't documented Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org >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 @@ + + Optional dependencies + + 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. + + The easiest of these to use is + WITHOUT_X. If the port can be built both + with and without X support, then it should normally be built + with X support. If WITHOUT_X is defined, + then the version that does not have X support should be + built. + + Various parts of GNOME have such knobs, though they are + slightly more difficult to use. The variables to use in the + Makefile are WANT_* + and HAVE_*. If the application can be + built both with or without one of the dependencies listed + below, then the Makefile should set + WANT_PKG, and should build the version that + uses PKG if HAVE_PKG + is defined. + + The WANT_* variables currently + supported this way are WANT_GLIB, + WANT_GTK, WANT_ESOUND, + WANT_IMLIB, and + WANT_GNOME. + + Building mechanisms >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message