ports/73633: [patch] clean up bsd.port.mk comments
Edwin Groothuis
edwin at mavetju.org
Sun Nov 7 01:40:27 UTC 2004
>Number: 73633
>Category: ports
>Synopsis: [patch] clean up bsd.port.mk comments
>Confidential: no
>Severity: serious
>Priority: low
>Responsible: freebsd-ports-bugs
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: change-request
>Submitter-Id: current-users
>Arrival-Date: Sun Nov 07 01:40:26 GMT 2004
>Closed-Date:
>Last-Modified:
>Originator: Edwin Groothuis
>Release: FreeBSD 5.2.1-RELEASE i386
>Organization:
-
>Environment:
System: FreeBSD k7.mavetju 5.2.1-RELEASE FreeBSD 5.2.1-RELEASE #7: Tue Sep 21 23:13:39 EST 2004 root at k7.mavetju:/usr/src-5.2.1/sys/i386/compile/k7 i386
>Description:
# $FreeBSD: ports/Mk/bsd.port.mk,v 1.499 2004/10/07 17:59:18 kris Exp $
# $NetBSD: $
#
# bsd.port.mk - 940820 Jordan K. Hubbard.
# This file is in the public domain.
#
# Please view me with 4 column tabs!
4 column tabs... Great idea, too bad not everybody sticks to it.
The result: lots of places where eight-column-tabs are used, lots
of spaces where spaces are used.
This is an attempt to streamline the documentation part of the
bsd.port.mk file.
There is no change the to code, only to the layout of the comments
at the beginning.
The layout of this diff looks horrible, but that's because it shows
up as a eight-column-tab instead if a four-column-tab.
>How-To-Repeat:
>Fix:
Index: bsd.port.mk
===================================================================
RCS file: /home/pcvs/ports/Mk/bsd.port.mk,v
retrieving revision 1.499
diff -u -r1.499 bsd.port.mk
--- bsd.port.mk 7 Oct 2004 17:59:18 -0000 1.499
+++ bsd.port.mk 7 Nov 2004 01:26:50 -0000
@@ -89,7 +89,8 @@
# MASTER_SITES - Primary location(s) for distribution files if not found
# locally. See bsd.sites.mk for common choices for
# MASTER_SITES.
-# MASTER_SITE_SUBDIR - Subdirectory of MASTER_SITES (default: empty).
+# MASTER_SITE_SUBDIR
+# - Subdirectory of MASTER_SITES (default: empty).
# Will sometimes need to be set to ${PORTNAME} for (e.g.)
# MASTER_SITE_SOURCEFORGE. Only guaranteed to work for
# choices of ${MASTER_SITES} defined in bsd.sites.mk.
@@ -116,17 +117,17 @@
# the user's preferred location to fetch files from. You should
# rarely need to set these.
#
-# MASTER_SITE_BACKUP - Backup location(s) for distribution files and patch
+# MASTER_SITE_BACKUP
+# - Backup location(s) for distribution files and patch
# files if not found locally and ${MASTER_SITES}/${PATCH_SITES}
-# (default:
-# ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/${DIST_SUBDIR}/)
-# MASTER_SITE_OVERRIDE - If set, override the MASTER_SITES setting with this
-# value.
-# MASTER_SITE_FREEBSD - If set, only use ${MASTER_SITE_BACKUP} for
-# MASTER_SITES.
-# CD_MOUNTPTS - List of CDROM mountpoints to look for distfiles under.
-# This variable supercedes CD_MOUNTPT, which is
-# obsolete.
+# Default:
+# ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/distfiles/${DIST_SUBDIR}/
+# MASTER_SITE_OVERRIDE
+# - If set, override the MASTER_SITES setting with this value.
+# MASTER_SITE_FREEBSD
+# - If set, only use ${MASTER_SITE_BACKUP} for MASTER_SITES.
+# CD_MOUNTPTS - List of CDROM mountpoints to look for distfiles under.
+# This variable supercedes CD_MOUNTPT, which is obsolete.
#
# Set these if your port should not be built under certain circumstances.
# These are string variables; you should set them to the reason why
@@ -154,13 +155,15 @@
# or patchfiles have redistribution restrictions, set the following
# to the list of such files.
#
-# RESTRICTED_FILES - List of files that cannot be redistributed
+# RESTRICTED_FILES
+# - List of files that cannot be redistributed
# (default: "${DISTFILES} ${PATCHFILES}" if RESTRICTED
# or NO_CDROM is set, empty otherwise).
#
# These variables are booleans, so you don't need to set them to the reason.
#
-# IS_INTERACTIVE - Set this if your port needs to interact with the user
+# IS_INTERACTIVE
+# - Set this if your port needs to interact with the user
# during any step in a package build. User can then decide
# to skip this port by setting ${BATCH}, or compiling only
# the interactive ports by setting ${INTERACTIVE}.
@@ -190,177 +193,171 @@
# usage inside the ports framework, and the latter are reserved for user-
# settable options. (Setting USE_* in /etc/make.conf is always wrong).
#
-# USE_BZIP2 - Says that the port tarballs use bzip2, not gzip, for
-# compression.
-# USE_ZIP - Says that the port distfile uses zip, not tar w/[bg]zip
-# for compression.
-# USE_GCC - Says that the port requires this version of gcc, either in
-# the system or installed from a port.
-# USE_GMAKE - Says that the port uses gmake.
-# GMAKE - Set to path of GNU make if not in $PATH (default: gmake).
+# USE_BZIP2 - Says that the port tarballs use bzip2, not gzip, for
+# compression.
+# USE_ZIP - Says that the port distfile uses zip, not tar w/[bg]zip
+# for compression.
+# USE_GCC - Says that the port requires this version of gcc, either in
+# the system or installed from a port.
+# USE_GMAKE - Says that the port uses gmake.
+# GMAKE - Set to path of GNU make if not in $PATH (default: gmake).
##
# USE_GETOPT_LONG - Says that the port uses getopt_long. If OSVERSION
-# less than 500041, automatically adds devel/libgnugeopt
-# to LIB_DEPENDS, and pass adjusted values of
-# CPPFLAGS and LDFLAGS in CONFIGURE_ENV.
-# Default: not set.
+# less than 500041, automatically adds devel/libgnugeopt
+# to LIB_DEPENDS, and pass adjusted values of
+# CPPFLAGS and LDFLAGS in CONFIGURE_ENV.
+# Default: not set.
##
-# USE_ICONV - Says that the port uses libiconv.
+# USE_ICONV - Says that the port uses libiconv.
# USE_GETTEXT - Says that the port uses GNU gettext (libintl).
##
-# USE_PERL5 - Says that the port uses perl5 in one or more of the extract,
-# patch, build, install or run phases.
-# USE_PERL5_BUILD - Says that the port uses perl5 in one or more of the extract,
-# patch, build or install phases.
+# USE_PERL5 - Says that the port uses perl5 in one or more of the
+# extract, patch, build, install or run phases.
+# USE_PERL5_BUILD - Says that the port uses perl5 in one or more of the
+# extract, patch, build or install phases.
# USE_PERL5_RUN - Says that the port uses perl5 for running.
-# PERL5 - Set to full path of perl5, either in the system or
-# installed from a port.
-# PERL - Set to full path of perl5, either in the system or
-# installed from a port, but without the version number.
-# Use this if you need to replace "#!" lines in scripts.
-# PERL_VERSION - Full version of perl5 (see below for current value).
-# PERL_VER - Short version of perl5 (see below for current value).
-# PERL_LEVEL - Perl version as an integer of the form MNNNPP, where
-# M is major version, N is minor version, and P is
-# the patch level. E.g., PERL_VERSION=5.6.1 would give
-# a PERL_LEVEL of 500601. This can be used in comparisons
-# to determine if the version of perl is high enough,
-# whether a particular dependency is needed, etc.
-# PERL_ARCH - Directory name of architecture dependent libraries
-# (value: ${ARCH}-freebsd).
-# PERL_PORT - Name of the perl port that is installed
-# (value: perl5)
-# SITE_PERL - Directory name where site specific perl packages go.
-# This value is added to PLIST_SUB.
+# PERL5 - Set to full path of perl5, either in the system or
+# installed from a port.
+# PERL - Set to full path of perl5, either in the system or
+# installed from a port, but without the version number.
+# Use this if you need to replace "#!" lines in scripts.
+# PERL_VERSION - Full version of perl5 (see below for current value).
+# PERL_VER - Short version of perl5 (see below for current value).
+# PERL_LEVEL - Perl version as an integer of the form MNNNPP, where
+# M is major version, N is minor version, and P is
+# the patch level. E.g., PERL_VERSION=5.6.1 would give
+# a PERL_LEVEL of 500601. This can be used in comparisons
+# to determine if the version of perl is high enough,
+# whether a particular dependency is needed, etc.
+# PERL_ARCH - Directory name of architecture dependent libraries
+# Default: ${ARCH}-freebsd
+# PERL_PORT - Name of the perl port that is installed
+# Default: perl5
+# SITE_PERL - Directory name where site specific perl packages go.
+# This value is added to PLIST_SUB.
# PERL_MODBUILD - Use Module::Build to configure, build and install
-# port.
+# port.
#
# USE_GHOSTSCRIPT - Says that the port needs ghostscript to both
-# build and run. Default: not set.
-# USE_GHOSTSCRIPT_BUILD - Says that the port needs ghostscript to build.
-# Default: not set.
-# USE_GHOSTSCRIPT_RUN - Says that the port needs ghostscript to run.
-# Default: not set.
+# build and run. Default: not set.
+# USE_GHOSTSCRIPT_BUILD
+# - Says that the port needs ghostscript to build.
+# Default: not set.
+# USE_GHOSTSCRIPT_RUN
+# - Says that the port needs ghostscript to run.
+# Default: not set.
# GHOSTSCRIPT_PORT - The port that provides postscript functionality.
-# Some installations may wish to override the default
-# to specify a version without X11 and/or localized
-# versions for their nationality.
-# WITH_GHOSTSCRIPT_AFPL - If set to Yes, says to use the AFPL
-# version of the ghostscript software instead
-# of the GNU version, which is used otherwise.
+# Some installations may wish to override the default
+# to specify a version without X11 and/or localized
+# versions for their nationality.
+# WITH_GHOSTSCRIPT_AFPL
+# - If set to Yes, says to use the AFPL
+# version of the ghostscript software instead
+# of the GNU version, which is used otherwise.
##
-# USE_BISON - Says that the port uses bison for building.
+# USE_BISON - Says that the port uses bison for building.
##
-# USE_IMAKE - Says that the port uses imake. Implies USE_X_PREFIX.
-# XMKMF - Set to path of `xmkmf' if not in $PATH (default: xmkmf -a ).
-# USE_X_PREFIX - Says that the port installs in ${X11BASE}. Implies USE_XLIB.
-# USE_XLIB - Says that the port uses the X libraries.
-#
-# USE_FREETYPE - Says that the port uses the freetype print libraries.
-# USE_GL - Says that the port uses libGL (not needed with XFree86 4.x
-# which already includes this functionality).
-# USE_MESA - Says that the port uses libGL/libglut (deprecated).
-# USE_MOTIF - Says that the port uses a Motif toolkit. Implies USE_XPM.
+# USE_IMAKE - Says that the port uses imake. Implies USE_X_PREFIX.
+# XMKMF - Set to path of `xmkmf' if not in $PATH.
+# Default: xmkmf -a
+# USE_X_PREFIX - Says that the port installs in ${X11BASE}.
+# Implies USE_XLIB.
+# USE_XLIB - Says that the port uses the X libraries.
+#
+# USE_FREETYPE - Says that the port uses the freetype print libraries.
+# USE_GL - Says that the port uses libGL (not needed with XFree86 4.x
+# which already includes this functionality).
+# USE_MESA - Says that the port uses libGL/libglut (deprecated).
+# USE_MOTIF - Says that the port uses a Motif toolkit. Implies USE_XPM.
# NO_OPENMOTIF - Says that the port uses a custom Motif toolkit
-# instead of Openmotif.
-# Used only when USE_MOTIF is set.
+# instead of Openmotif.
+# Used only when USE_MOTIF is set.
# WANT_LESSTIF - Says that the port uses Lesstif as Motif toolkit.
-# Used only when USE_MOTIF is set. Implies
-# NO_OPENMOTIF.
-# USE_SDL - Says that the port uses the sdl libraries.
-# See bsd.sdl.mk for more information.
-# USE_XPM - Says that the port uses the xpm graphics libraries.
+# Used only when USE_MOTIF is set. Implies NO_OPENMOTIF.
+# USE_SDL - Says that the port uses the sdl libraries.
+# See bsd.sdl.mk for more details.
+# USE_XPM - Says that the port uses the xpm graphics libraries.
##
-# USE_OPENSSL - Says that the port relies on the OpenSSL package.
-# Default: not set.
+# USE_OPENSSL - Says that the port relies on the OpenSSL package.
+# Default: not set.
##
-#
# USE_OPENLDAP - Says that the port uses the OpenLDAP libraries
# Implies: WANT_OPENLDAP_VER?=22
# WANT_OPENLDAP_VER - Legal values are: 21, 22
# If set to an unkown value, the port is marked BROKEN.
# WANT_OPENLDAP_SASL - Says that the system should use OpenLDAP libraries
# with SASL support.
-#
##
-# USE_AUTOTOOLS - Says that the port uses various GNU autotools
-# (libtool, autoconf, autoheader, automake et al.)
-# See bsd.autotools.mk for more details.
-# XXX: not currently in active use - this is a placeholder.
+# USE_AUTOTOOLS - Says that the port uses various GNU autotools
+# (libtool, autoconf, autoheader, automake et al.)
+# See bsd.autotools.mk for more details.
+# XXX: not currently in active use - this is a placeholder.
##
-# USE_JAVA - Says that the port relies on the Java language.
-# Implies inclusion of bsd.java.mk. (Also see
-# that file for more information on USE_JAVA_*).
-# Default: not set.
-# USE_PYTHON - Says that the port relies on the Python language.
-# Implies inclusion of bsd.python.mk. (Also see
-# that file for more information on USE_PYTHON_*
-# and USE_PYDISTUTILS).
-# Default: not set.
-# USE_RUBY - Says that the port relies on the Ruby language.
-# Implies inclusion of bsd.ruby.mk. (Also see
-# that file for more information on USE_RUBY_*).
-# Default: not set.
+# USE_JAVA - Says that the port relies on the Java language.
+# Implies inclusion of bsd.java.mk. (Also see
+# that file for more information on USE_JAVA_*).
+# Default: not set.
+# USE_PYTHON - Says that the port relies on the Python language.
+# Implies inclusion of bsd.python.mk. (Also see
+# that file for more information on USE_PYTHON_*
+# and USE_PYDISTUTILS).
+# Default: not set.
+# USE_RUBY - Says that the port relies on the Ruby language.
+# Implies inclusion of bsd.ruby.mk. (Also see
+# that file for more information on USE_RUBY_*).
+# Default: not set.
# USE_GNUSTEP - Says that the port relies on the GNUstep system.
-# Implies the inclusion of bsd.gnustep.mk.
-# (Also see that file for more information on
-# USE_GNUSTEP_*).
-# Default: not set.
+# Implies the inclusion of bsd.gnustep.mk.
+# (Also see that file for more information on
+# USE_GNUSTEP_*).
+# Default: not set.
+##
+# USE_GNOME - A list of the Gnome dependencies the port has (e.g.,
+# glib12, gtk12). Implies that the port needs Gnome.
+# Implies inclusion of bsd.gnome.mk. See bsd.gnome.mk
+# or http://www.FreeBSD.org/gnome/docs/porting.html
+# for more details.
+# Default: not set.
##
-# USE_GNOME - A list of the Gnome dependencies the port has (e.g.,
-# glib12, gtk12). Implies that the port needs Gnome.
-# Implies inclusion of bsd.gnome.mk. See bsd.gnome.mk
-# or http://www.FreeBSD.org/gnome/docs/porting.html
-# for more details.
-# Default: not set.
-#
# USE_KDEBASE_VER - Set to 3 to use the KDE windowing system.
-# Implies inclusion
-# of bsd.kde.mk. Default: not set.
+# Implies inclusion of bsd.kde.mk. Default: not set.
# USE_KDELIBS_VER - Set to 3 to use the KDE libraries.
-# Implies inclusion
-# of bsd.kde.mk. Default: not set.
+# Implies inclusion of bsd.kde.mk. Default: not set.
# USE_QT_VER - Set to either 2 or 3 to use the QT libraries.
# (Only 3 is currently supported). Implies inclusion
# of bsd.kde.mk. Default: not set.
-#
+##
# USE_LINUX - Set to yes to say the port needs emulators/linux_base.
# Default: not set.
# USE_LINUX_PREFIX - controls the action of PREFIX (see above).
-#
-#
+##
# USE_MYSQL - Add MySQL client dependency.
# If no version is given (by the maintainer via the port or
# by the user via defined variable), try to find the
# currently installed version. Fall back to default if
# necessary (MySQL4.0 = 40).
-#
# DEFAULT_MYSQL_VER - MySQL default version. Can be overriden within a port.
# Default: 40.
-#
# WANT_MYSQL_VER - Maintainer can set an arbitrary version of MySQL by
# using it.
-#
# BROKEN_WITH_MYSQL - This variable can be defined if the ports doesn't support
# one or more version of MySQL.
-#
# MYSQL_VER - Internal variable for MySQL version.
-#
# WITH_MYSQL_VER - User defined variable to set MySQL version.
-#
+##
# USE_RC_SUBR - Says the ports startup/shutdown script uses the common
-# routines found in etc/rc.subr and may need to
-# depend on the sysutils/rc_subr port.
-#
-# RC_SUBR - Set to path of rc.subr, defaults to ${LOCALBASE}/etc/rc.subr.
-#
+# routines found in etc/rc.subr and may need to
+# depend on the sysutils/rc_subr port.
+# RC_SUBR - Set to path of rc.subr,
+# Default: ${LOCALBASE}/etc/rc.subr.
+##
# USE_APACHE - Says that the port relies on an apache webserver.
# APACHE_PORT - CATEGORY and portname of the prefered port for apache.
-# Default: www/apache13
-# If WITH_APACHE2 is defined defaults to www/apache2
-# APXS - Full path to the prefered apxs binary to configure
-# apache modules. Default: ${LOCALBASE}/sbin/apxs
-#
+# Default: www/apache13
+# If WITH_APACHE2 is defined defaults to www/apache2
+# APXS - Full path to the prefered apxs binary to configure
+# apache modules. Default: ${LOCALBASE}/sbin/apxs
+##
#
#
# Dependency checking. Use these if your port requires another port
@@ -375,7 +372,7 @@
# a "make all install" if it's not found. If the third
# field ("target") exists, it will be used instead of
# ${DEPENDS_TARGET}.
-# PATCH_DEPENDS - A list of "path:dir[:target]" tuples of other ports this
+# PATCH_DEPENDS - A list of "path:dir[:target]" tuples of other ports this
# package depends on in the "patch" stage. "path" is the
# name of a file if it starts with a slash (/), an
# executable otherwise. make will test for the existence
@@ -422,10 +419,10 @@
# Conflict checking. Use if your port cannot be installed at the same time as
# another package.
#
-# CONFLICTS - A list of package name patterns that the port conflicts with.
-# It's possible to use any shell meta-characters for pattern
-# matching.
-# E.g. apache*-1.2* apache*-1.3.[012345] apache-*+ssl_*
+# CONFLICTS - A list of package name patterns that the port conflicts with.
+# It's possible to use any shell meta-characters for pattern
+# matching.
+# E.g. apache*-1.2* apache*-1.3.[012345] apache-*+ssl_*
#
#
# Various directory definitions and variables to control them.
@@ -466,19 +463,20 @@
# Variables that serve as convenient "aliases" for your *-install targets.
# Use these like: "${INSTALL_PROGRAM} ${WRKSRC}/prog ${PREFIX}/bin".
#
-# INSTALL_PROGRAM - A command to install binary executables. (By
-# default, also strips them, unless ${STRIP} is
-# overridden to be the empty string).
-# INSTALL_SCRIPT - A command to install executable scripts.
-# INSTALL_DATA - A command to install sharable data.
-# INSTALL_MAN - A command to install manpages. May or not compress,
-# depending on the value of MANCOMPRESSED (see below).
+# INSTALL_PROGRAM - A command to install binary executables. (By
+# default, also strips them, unless ${STRIP} is
+# overridden to be the empty string).
+# INSTALL_SCRIPT - A command to install executable scripts.
+# INSTALL_DATA - A command to install sharable data.
+# INSTALL_MAN - A command to install manpages. May or not compress,
+# depending on the value of MANCOMPRESSED (see below).
#
# Boolean to control whether manpages are installed.
#
-# NO_INSTALL_MANPAGES - Says that the port doesn't want to install any
-# manpages (default: not set, i.e. manpages
-# are installed by default).
+# NO_INSTALL_MANPAGES
+# - Says that the port doesn't want to install any
+# manpages (default: not set, i.e. manpages
+# are installed by default).
#
# Set the following to specify all manpages that your port installs.
# These manpages will be automatically listed in ${PLIST}. Depending
@@ -497,7 +495,8 @@
# correctly in ${PLIST}.)
# MANPREFIX - The directory prefix for ${MAN<sect>} and ${MLINKS}
# (default: ${PREFIX}).
-# MAN<sect>PREFIX - If manual pages of some sections install in different
+# MAN<sect>PREFIX
+# - If manual pages of some sections install in different
# locations than others, use these (default: ${MANPREFIX}).
# MANCOMPRESSED - This variable can take values "yes", "no" or
# "maybe". "yes" means manpages are installed
@@ -512,8 +511,8 @@
# INFO - A list of .info files (omitting the trailing ".info");
# only one entry per document!
# INFO_PATH - Path, where all .info files will be installed by your
-# port, relative to ${PREFIX} (default: "share/info" if
-# ${PREFIX} is equal to /usr and "info" otherwise).
+# port, relative to ${PREFIX} (default: "share/info" if
+# ${PREFIX} is equal to /usr and "info" otherwise).
#
# Set the following to specify all documentation your port installs into
# ${DOCSDIR}
@@ -527,26 +526,27 @@
#
# Default targets and their behaviors:
#
-# fetch - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined)
-# into ${DISTDIR} as necessary.
-# fetch-list - Show list of files that would be retrieved by fetch.
-# fetch-recursive - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined),
-# for port and dependencies into ${DISTDIR} as necessary.
-# fetch-recursive-list - Show list of files that would be retrieved by
-# fetch-recursive.
-# fetch-required-list - Show list of files that would be retrieved by
-# fetch-required.
-# fetch-required - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined),
-# for port and dependencies that are not already installed
-# into ${DISTDIR}.
-# all-depends-list - Show all directories which are dependencies
-# for this port.
-# build-depends-list - Show all directories which are build-dependencies
-# for this port.
-# package-depends-list - Show all directories which are
-# package-dependencies for this port.
-# run-depends-list - Show all directories which are run-dependencies
-# for this port.
+# fetch - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined)
+# into ${DISTDIR} as necessary.
+# fetch-list - Show list of files that would be retrieved by fetch.
+# fetch-recursive - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined),
+# for port and dependencies into ${DISTDIR} as
+# necessary.
+# fetch-recursive-list - Show list of files that would be retrieved by
+# fetch-recursive.
+# fetch-required-list - Show list of files that would be retrieved by
+# fetch-required.
+# fetch-required - Retrieves ${DISTFILES} (and ${PATCHFILES} if defined),
+# for port and dependencies that are not already
+# installed into ${DISTDIR}.
+# all-depends-list - Show all directories which are dependencies
+# for this port.
+# build-depends-list - Show all directories which are build-dependencies
+# for this port.
+# package-depends-list - Show all directories which are
+# package-dependencies for this port.
+# run-depends-list - Show all directories which are run-dependencies
+# for this port.
#
# extract - Unpacks ${DISTFILES} into ${WRKDIR}.
# patch - Apply any provided patches to the source.
@@ -559,26 +559,28 @@
# deinstall - Remove the installation.
# deinstall-all - Remove all installations with the same PKGORIGIN.
# package - Create a package from an _installed_ port.
-# package-recursive - Create a package for a port and _all_ of its dependancies.
+# package-recursive
+# - Create a package for a port and _all_ of its dependancies.
# describe - Try to generate a one-line description for each port for
# use in INDEX files and the like.
# checkpatch - Do a "patch -C" instead of a "patch". Note that it may
# give incorrect results if multiple patches deal with
# the same file.
# checksum - Use distinfo to ensure that your distfiles are valid.
-# checksum-recursive - Run checksum in this port and all dependencies.
+# checksum-recursive
+# - Run checksum in this port and all dependencies.
# makesum - Generate distinfo (only do this for your own ports!).
-# clean - Remove ${WRKDIR} and other temporary files used for building.
+# clean - Remove ${WRKDIR} and other temporary files used for building.
# clean-depends - Do a "make clean" for all dependencies.
-# config - Configure options for this port (using ${DIALOG}).
-# Automatically run prior to extract, patch, configure, build,
-# install, and package.
+# config - Configure options for this port (using ${DIALOG}).
+# Automatically run prior to extract, patch, configure, build,
+# install, and package.
# showconfig - Display options config for this port
-# rmconfig - Remove the options config for this port
+# rmconfig - Remove the options config for this port
#
# Default sequence for "all" is:
#
-# check-sanity fetch checksum extract patch configure build
+# check-sanity fetch checksum extract patch configure build
#
# Please read the comments in the targets section below; you
# should be able to use the pre-* or post-* targets/scripts
@@ -601,25 +603,25 @@
#
# For options:
# OPTIONS - List of what WITH_<option> options this port accept. The
-# format is <option> "<description>" [on|off]
-# Example:
-# FLEXRESP "Flexible response to events" off
-# which tell that an option WITH_FLEXRESP exists for this port,
-# that by default it is not defined, and that the description to
-# show to a user in the config dialog is "Flexible response to
-# events". If you have more than one option, just chain them
-# into a single variable. NOTE: To make options work, you need
-# to include bsd.port.pre.mk before you start testing the
-# WITH_xyz variables.
+# format is <option> "<description>" [on|off]
+# Example:
+# FLEXRESP "Flexible response to events" off
+# which tell that an option WITH_FLEXRESP exists for this port,
+# that by default it is not defined, and that the description to
+# show to a user in the config dialog is "Flexible response to
+# events". If you have more than one option, just chain them
+# into a single variable. NOTE: To make options work, you need
+# to include bsd.port.pre.mk before you start testing the
+# WITH_xyz variables.
#
# For fetch:
#
# FETCH_CMD - Full path to ftp/http fetch command if not in $PATH
# (default: "/usr/bin/fetch -ARr").
-# FETCH_BEFORE_ARGS -
-# Arguments to ${FETCH_CMD} before filename (default: none).
-# FETCH_AFTER_ARGS -
-# Arguments to ${FETCH_CMD} following filename (default: none).
+# FETCH_BEFORE_ARGS
+# - Arguments to ${FETCH_CMD} before filename (default: none).
+# FETCH_AFTER_ARGS
+# - Arguments to ${FETCH_CMD} following filename (default: none).
# FETCH_ENV - Environment to pass to ${FETCH_CMD} (default: none).
# FETCH_REGET - Times to retry fetching of files on checksum errors (default: 1).
#
@@ -628,21 +630,21 @@
# EXTRACT_CMD - Command for extracting archive (default: "bzip2" if
# USE_BZIP2 is set, "unzip" if USE_ZIP is set, "gzip"
# otherwise).
-# EXTRACT_BEFORE_ARGS -
-# Arguments to ${EXTRACT_CMD} before filename
+# EXTRACT_BEFORE_ARGS
+# - Arguments to ${EXTRACT_CMD} before filename
# (default: "-dc").
-# EXTRACT_AFTER_ARGS -
-# Arguments to ${EXTRACT_CMD} following filename
+# EXTRACT_AFTER_ARGS
+# - Arguments to ${EXTRACT_CMD} following filename
# (default: "| tar -xf -").
-# EXTRACT_PRESERVE_OWNERSHIP -
-# Normally, when run as "root", the extract stage will
+# EXTRACT_PRESERVE_OWNERSHIP
+# - Normally, when run as "root", the extract stage will
# change the owner and group of all files under ${WRKDIR}
# to 0:0. Set this variable if you want to turn off this
# feature.
#
# For makesum:
#
-# NO_SIZE - Don't record size data in distinfo, needed
+# NO_SIZE - Don't record size data in distinfo, needed
# when the master site does not report file
# sizes, or when multiple valid versions of
# a distfile, having different sizes, exist.
@@ -667,12 +669,16 @@
# configure stage will not do anything if this is not set.
# GNU_CONFIGURE - Set if you are using GNU configure (optional). Implies
# HAS_CONFIGURE.
-# PERL_CONFIGURE - Configure using Perl's MakeMaker. Implies USE_PERL5.
-# CONFIGURE_WRKSRC - Directory to run configure in (default: ${WRKSRC}).
-# CONFIGURE_SCRIPT - Name of configure script, relative to ${CONFIGURE_WRKSRC}
+# PERL_CONFIGURE
+# - Configure using Perl's MakeMaker. Implies USE_PERL5.
+# CONFIGURE_WRKSRC
+# - Directory to run configure in (default: ${WRKSRC}).
+# CONFIGURE_SCRIPT
+# - Name of configure script, relative to ${CONFIGURE_WRKSRC}
# (default: "Makefile.PL" if PERL_CONFIGURE is set,
# "configure" otherwise).
-# CONFIGURE_TARGET - The name of target to call when GNU_CONFIGURE is
+# CONFIGURE_TARGET
+# - The name of target to call when GNU_CONFIGURE is
# defined (default: ${MACHINE_ARCH}-portbld-freebsd${OSREL}).
# CONFIGURE_ARGS - Pass these args to configure if ${HAS_CONFIGURE} is set
# (default: "--prefix=${PREFIX} ${CONFIGURE_TARGET}" if
@@ -684,11 +690,12 @@
# ${HAS_CONFIGURE} is set.
# CONFIGURE_LOG - The name of configure log file (default: config.log).
# It will be printed to the screen if configure fails.
-# CONFIGURE_FAIL_MESSAGE - A message displayed to users when configure
-# fails (note: this assumes the do-configure
-# target has not been overwritten). This message
-# will be passed through /usr/bin/fmt before
-# being shown to the user.
+# CONFIGURE_FAIL_MESSAGE
+# - A message displayed to users when configure
+# fails (note: this assumes the do-configure
+# target has not been overwritten). This message
+# will be passed through /usr/bin/fmt before
+# being shown to the user.
#
# For build and install:
#
@@ -710,8 +717,8 @@
# MTREE_FILE - The name of the mtree file (default: /etc/mtree/BSD.x11.dist
# if USE_X_PREFIX is set, /etc/mtree/BSD.local.dist
# otherwise.)
-# PLIST_DIRS - Directories to be added to packing list
-# PLIST_FILES - Files and symbolic links to be added to packing list
+# PLIST_DIRS - Directories to be added to packing list
+# PLIST_FILES - Files and symbolic links to be added to packing list
#
# PLIST - Name of the `packing list' file (default: ${PKGDIR}/pkg-plist).
# Change this to ${WRKDIR}/PLIST or something if you
@@ -734,7 +741,7 @@
# ${LOCALBASE} and %%X11BASE%% for ${X11BASE}.
# DOCSDIR - Name of the directory to install the packages docs in
# (default: ${PREFIX}/share/doc/${PORTNAME}).
-# EXAMPLESDIR - Name of the directory to install the packages examples in
+# EXAMPLESDIR - Name of the directory to install the packages examples in
# (default: ${PREFIX}/share/examples/${PORTNAME}).
# DATADIR - Name of the directory to install the packages shared data
# in (default: ${PREFIX}/share/${PORTNAME}).
@@ -750,16 +757,17 @@
#
# For package:
#
-# NO_LATEST_LINK - Do not install the "Latest" link for package. Define this
-# if this port is a beta version of another stable port
-# which is also in the tree.
-# LATEST_LINK - Install the "Latest" link for the package as ___. Define
-# this if the "Latest" link name will be incorrectly determined.
+# NO_LATEST_LINK - Do not install the "Latest" link for package. Define this
+# if this port is a beta version of another stable port
+# which is also in the tree.
+# LATEST_LINK - Install the "Latest" link for the package as ___. Define
+# this if the "Latest" link name will be incorrectly
+# determined.
#
# This is used in all stages:
#
# SCRIPTS_ENV - Additional environment vars passed to scripts in
-# ${SCRIPTDIR} executed by bsd.port.mk (default: see below).
+# ${SCRIPTDIR} executed by bsd.port.mk (default: see below).
#
# Finally, variables to change if you want a special behavior. These
# are for debugging purposes. Don't set them in your Makefile.
@@ -769,24 +777,28 @@
# PATCH_DEBUG - If set, print out more information about the patches as
# it attempts to apply them.
# PKG_DBDIR - Where package installation is recorded; this directory
-# must not contain anything else (default: /var/db/pkg).
-# PORT_DBDIR - Where port configuration options are recorded
-# (default: /var/db/ports)
-# NO_PKG_REGISTER - Don't register a port installation as a package.
-# FORCE_PKG_REGISTER - If set, it will overwrite any existing package
+# must not contain anything else (default: /var/db/pkg).
+# PORT_DBDIR - Where port configuration options are recorded
+# (default: /var/db/ports)
+# NO_PKG_REGISTER
+# - Don't register a port installation as a package.
+# FORCE_PKG_REGISTER
+# - If set, it will overwrite any existing package
# registration information in ${PKG_DBDIR}/${PKGNAME}.
# NO_DEPENDS - Don't verify build of dependencies.
# NO_CHECKSUM - Don't verify the checksum. Typically used when
# when you noticed the distfile you just fetched has
# a different checksum and you intend to verify if
# the port still works with it.
-# USE_PACKAGE_DEPENDS - Install dependencies from existing packages instead
+# USE_PACKAGE_DEPENDS
+# - Install dependencies from existing packages instead
# of building the port from scratch.
-# INSTALL_AS_USER - Define this to install as the current user, intended
-# for systems where you have no root access.
-# DISABLE_SIZE - Do not check the size of a distfile even if the SIZE field
-# has been specified in distinfo. This is useful
-# when using an alternate FETCH_CMD.
+# INSTALL_AS_USER
+# - Define this to install as the current user, intended
+# for systems where you have no root access.
+# DISABLE_SIZE - Do not check the size of a distfile even if the SIZE field
+# has been specified in distinfo. This is useful
+# when using an alternate FETCH_CMD.
#
# End of the list of all variables that need to be defined in a port.
# Most port authors should not need to understand anything after this point.
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-ports-bugs
mailing list