From 9eea97260c70176f0be9842c6158e7488f65b6b0 Mon Sep 17 00:00:00 2001 From: rillig Date: Sat, 19 Jan 2008 22:41:47 +0000 Subject: Renamed some *.mk files to *.help, since they only contain comments. --- mk/help/destdir.help | 47 ++++++++++++++++++++++++++ mk/help/destdir.mk | 47 -------------------------- mk/help/directories.help | 86 ++++++++++++++++++++++++++++++++++++++++++++++++ mk/help/directories.mk | 86 ------------------------------------------------ mk/help/env.help | 61 ++++++++++++++++++++++++++++++++++ mk/help/env.mk | 58 -------------------------------- 6 files changed, 194 insertions(+), 191 deletions(-) create mode 100644 mk/help/destdir.help delete mode 100644 mk/help/destdir.mk create mode 100644 mk/help/directories.help delete mode 100644 mk/help/directories.mk create mode 100644 mk/help/env.help delete mode 100644 mk/help/env.mk (limited to 'mk') diff --git a/mk/help/destdir.help b/mk/help/destdir.help new file mode 100644 index 00000000000..e94ef754ae6 --- /dev/null +++ b/mk/help/destdir.help @@ -0,0 +1,47 @@ +# $NetBSD: destdir.help,v 1.1 2008/01/19 22:41:47 rillig Exp $ +# +# === +# Warning: This file is still under construction. Don't rely on it. +# === +# +# This file documents the variables around the DESTDIR support. +# +# Normally, packages are installed directly into LOCALBASE and may +# overwrite files of other packages there. It also makes it easy to +# create packages which behave differently depending on whether they +# are installed from source or from a binary package. This is not good. +# +# The DESTDIR support tries to prevent some of these problems. When it +# is enabled, packages are not installed directly into LOCALBASE. +# Instead, they are installed in a temporary directory, and a binary +# package is created from the files that have been installed there. +# +# === User-settable variables === +# +# USE_DESTDIR +# * "yes" to enable DESTDIR support for those packages that +# explicitly support it. +# +# * "full": This makes the build completely unprivileged and in +# turn detects any attempt to write e.g. to ${LOCALBASE}. +# This is not supported for actual installation yet, due to +# short comings of pkg_create. [FIXME] +# +# === Package-settable variables === +# +# PKG_DESTDIR_SUPPORT +# * "user-destdir" means that all files of the packages should be +# installed with default ownership and permissions. +# +# * "destdir" means that some of the installed files need special +# ownership or permissions. The installation is done by the +# privileged user. +# +# === Implementation notes === +# +# In the "install" phase, the variable DESTDIR is set in the make(1) +# environment of the default "do-install" target. Additionally, the +# variable is passed in the INSTALL_MAKE_FLAGS to override potential +# "DESTDIR=" entries in the Makefiles. +# +# Keywords: destdir diff --git a/mk/help/destdir.mk b/mk/help/destdir.mk deleted file mode 100644 index 76c2f3b1a97..00000000000 --- a/mk/help/destdir.mk +++ /dev/null @@ -1,47 +0,0 @@ -# $NetBSD: destdir.mk,v 1.2 2007/02/06 19:47:13 rillig Exp $ -# -# === -# Warning: This file is still under construction. Don't rely on it. -# === -# -# This file documents the variables around the DESTDIR support. -# -# Normally, packages are installed directly into LOCALBASE and may -# overwrite files of other packages there. It also makes it easy to -# create packages which behave differently depending on whether they -# are installed from source or from a binary package. This is not good. -# -# The DESTDIR support tries to prevent some of these problems. When it -# is enabled, packages are not installed directly into LOCALBASE. -# Instead, they are installed in a temporary directory, and a binary -# package is created from the files that have been installed there. -# -# === User-settable variables === -# -# USE_DESTDIR -# * "yes" to enable DESTDIR support for those packages that -# explicitly support it. -# -# * "full": This makes the build completely unprivileged and in -# turn detects any attempt to write e.g. to ${LOCALBASE}. -# This is not supported for actual installation yet, due to -# short comings of pkg_create. [FIXME] -# -# === Package-settable variables === -# -# PKG_DESTDIR_SUPPORT -# * "user-destdir" means that all files of the packages should be -# installed with default ownership and permissions. -# -# * "destdir" means that some of the installed files need special -# ownership or permissions. The installation is done by the -# privileged user. -# -# === Implementation notes === -# -# In the "install" phase, the variable DESTDIR is set in the make(1) -# environment of the default "do-install" target. Additionally, the -# variable is passed in the INSTALL_MAKE_FLAGS to override potential -# "DESTDIR=" entries in the Makefiles. -# -# Keywords: destdir diff --git a/mk/help/directories.help b/mk/help/directories.help new file mode 100644 index 00000000000..600a2953f5e --- /dev/null +++ b/mk/help/directories.help @@ -0,0 +1,86 @@ +# $NetBSD: directories.help,v 1.1 2008/01/19 22:41:48 rillig Exp $ +# +# This file contains some short documentation on the directories that +# are used within pkgsrc. + +# PREFIX +# This is the directory where the package should install its +# files. The actual value depends on the variables +# PKG_INSTALLATION_TYPE, USE_X11BASE and USE_CROSSBASE. +# +# Tags: read-only, system-defined, non-overridable, etc. +# +# See also: +# CROSSBASE, +# INSTALLATION_PREFIX, +# LOCALBASE, +# X11PREFIX, +# PKG_INSTALLATION_TYPE. +# + +# LOCALBASE +# This is the directory where all packages are usually installed. +# It is set by the user, and packages must not modify it. +# + +# PKG_SYSCONFBASE +# PKG_SYSCONFDIR.* +# These variables may be set in mk.conf to control where the +# configuration files are put. +# +# See also: guide:faq.html#faq.conf +# + +# PKG_SYSCONFVAR +# This variable can be set by packages to select the variable +# which can then be overridden in mk.conf to change the directory +# where the configuration files go. +# +# Default value: ${PKGBASE} +# + +# PKG_SYSCONFDIR +# This is the directory where the current package should install +# its configuration files. It may be changed by the package to +# point to a subdirectory of PKG_SYSCONFBASE. +# + +# TODO:PKG_SYSCONFDEPOTBASE +# TODO:PKG_SYSCONFBASEDIR +# + +# PKGDIR +# The directory where the various files that define a package are +# read from. These are: +# +# * DESCR +# * HEADER, HEADER_TEMPLATES +# * INSTALL, DEINSTALL +# * MESSAGE, MESSAGE.* +# * PLIST, PLIST.* +# * distinfo +# * hacks.mk +# +# Default value: the current directory. +# +# Tags: package-settable +# + +# WRKDIR +# The base directory where all the work is done for building a +# package. The pkgsrc infrastructure creates various files in this +# directory, whose names all start with a dot. +# +# The default value of EXTRACT_DIR is ${WRKDIR}. +# The default value of WRKSRC is ${WRKDIR}/${DISTNAME}. +# +# When PKGSRC_LOCKTYPE is set, a lock file is placed into this +# directory to prevent multiple processes from trying to build +# the package at the same time. +# +# See also: +# EXTRACT_DIR, WRKSRC, CREATE_WRKDIR_SYMLINK, WRKOBJDIR, +# WRKDIR_BASENAME, OBJHOSTNAME, OBJMACHINE +# +# Keywords: work +# diff --git a/mk/help/directories.mk b/mk/help/directories.mk deleted file mode 100644 index 8a9b23a8750..00000000000 --- a/mk/help/directories.mk +++ /dev/null @@ -1,86 +0,0 @@ -# $NetBSD: directories.mk,v 1.4 2007/01/17 12:47:21 rillig Exp $ -# -# This file contains some short documentation on the directories that -# are used within pkgsrc. - -# PREFIX -# This is the directory where the package should install its -# files. The actual value depends on the variables -# PKG_INSTALLATION_TYPE, USE_X11BASE and USE_CROSSBASE. -# -# Tags: read-only, system-defined, non-overridable, etc. -# -# See also: -# CROSSBASE, -# INSTALLATION_PREFIX, -# LOCALBASE, -# X11PREFIX, -# PKG_INSTALLATION_TYPE. -# - -# LOCALBASE -# This is the directory where all packages are usually installed. -# It is set by the user, and packages must not modify it. -# - -# PKG_SYSCONFBASE -# PKG_SYSCONFDIR.* -# These variables may be set in mk.conf to control where the -# configuration files are put. -# -# See also: guide:faq.html#faq.conf -# - -# PKG_SYSCONFVAR -# This variable can be set by packages to select the variable -# which can then be overridden in mk.conf to change the directory -# where the configuration files go. -# -# Default value: ${PKGBASE} -# - -# PKG_SYSCONFDIR -# This is the directory where the current package should install -# its configuration files. It may be changed by the package to -# point to a subdirectory of PKG_SYSCONFBASE. -# - -# TODO:PKG_SYSCONFDEPOTBASE -# TODO:PKG_SYSCONFBASEDIR -# - -# PKGDIR -# The directory where the various files that define a package are -# read from. These are: -# -# * DESCR -# * HEADER, HEADER_TEMPLATES -# * INSTALL, DEINSTALL -# * MESSAGE, MESSAGE.* -# * PLIST, PLIST.* -# * distinfo -# * hacks.mk -# -# Default value: the current directory. -# -# Tags: package-settable -# - -# WRKDIR -# The base directory where all the work is done for building a -# package. The pkgsrc infrastructure creates various files in this -# directory, whose names all start with a dot. -# -# The default value of EXTRACT_DIR is ${WRKDIR}. -# The default value of WRKSRC is ${WRKDIR}/${DISTNAME}. -# -# When PKGSRC_LOCKTYPE is set, a lock file is placed into this -# directory to prevent multiple processes from trying to build -# the package at the same time. -# -# See also: -# EXTRACT_DIR, WRKSRC, CREATE_WRKDIR_SYMLINK, WRKOBJDIR, -# WRKDIR_BASENAME, OBJHOSTNAME, OBJMACHINE -# -# Keywords: work -# diff --git a/mk/help/env.help b/mk/help/env.help new file mode 100644 index 00000000000..8624499f546 --- /dev/null +++ b/mk/help/env.help @@ -0,0 +1,61 @@ +# $NetBSD: env.help,v 1.1 2008/01/19 22:41:48 rillig Exp $ +# +# This file describes the *_ENV variables, where they are defined and +# where they are used. +# +# In general, all environments should be ordered from general to specific +# ones. That is, first comes the BARRIER_ENV, then the MAKE_ENV, then the +# MAKE_BUILD_ENV. +# +# Additionally, the package should be able to override all settings from +# the infrastructure. That means that the package-settable variables +# must appear behind the system-defined ones. +# + +# XXX: I'm missing BARRIER_ENV or something like that. + +# XXX: The do-* targets are not run with ALL_ENV (or better: +# BARRIER_ENV) in effect. + +# +# Common environments. +# + +# PKGSRC_MAKE_ENV +# + +# ALL_ENV +# This is the basic environment for the configure, build and install +# phases. It can be overridden by CONFIGURE_ENV and MAKE_ENV. +# + +# +# Environments for individual phases. +# + +# EXTRACT_ENV + +# CONFIGURE_ENV + +# MAKE_ENV + +# BSD_MAKE_ENV +# This environment can be appended to MAKE_ENV by a package to +# support packages using BSD-style Makefiles, for example +# . +# +# See also: +# USE_BSD_MAKE +# + +# INSTALL_ENV +# This environment is prepended to MAKE_ENV in the install phase. +# XXX: Shouldn't this be _ap_pended? + +# +# Other environments. +# + +# INSTALL_SCRIPTS_ENV +# TODO +# diff --git a/mk/help/env.mk b/mk/help/env.mk deleted file mode 100644 index 5c662f1fc2a..00000000000 --- a/mk/help/env.mk +++ /dev/null @@ -1,58 +0,0 @@ -# $NetBSD: env.mk,v 1.3 2007/03/01 18:30:11 wiz Exp $ -# -# This file describes the *_ENV variables, where they are defined and -# where they are used. -# -# In general, all environments should be ordered from general to specific -# ones. That is, first comes the BARRIER_ENV, then the MAKE_ENV, then the -# MAKE_BUILD_ENV. -# -# Additionally, the package should be able to override all settings from -# the infrastructure. That means that the package-settable variables -# must appear behind the system-defined ones. -# - -# XXX: I'm missing BARRIER_ENV or something like that. - -# XXX: The do-* targets are not run with ALL_ENV (or better: -# BARRIER_ENV) in effect. - -# -# Common environments. -# - -# PKGSRC_MAKE_ENV -# - -# ALL_ENV -# This is the basic environment for the configure, build and install -# phases. It can be overridden by CONFIGURE_ENV and MAKE_ENV. -# - -# -# Environments for individual phases. -# - -# EXTRACT_ENV - -# CONFIGURE_ENV - -# MAKE_ENV - -# BSD_MAKE_ENV -# This environment can be appended to MAKE_ENV by a package to -# support packages using BSD-style Makefiles, for example -# . -# - -# INSTALL_ENV -# This environment is prepended to MAKE_ENV in the install phase. -# XXX: Shouldn't this be _ap_pended? - -# -# Other environments. -# - -# INSTALL_SCRIPTS_ENV -# TODO -# -- cgit v1.2.3