[pkgsrc/trunk]: pkgsrc/mk/help Added some documentation on the DESTDIR suppor...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/b1674a966d7d
branches:  trunk
changeset: 521642:b1674a966d7d
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Wed Nov 15 19:27:16 2006 +0000

description:
Added some documentation on the DESTDIR support that has recently been
introduced to pkgsrc. There are still some FIXMEs left.

diffstat:

 mk/help/destdir.mk |  45 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 45 insertions(+), 0 deletions(-)

diffs (49 lines):

diff -r 6071ca7fd8af -r b1674a966d7d mk/help/destdir.mk
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/mk/help/destdir.mk        Wed Nov 15 19:27:16 2006 +0000
@@ -0,0 +1,45 @@
+# $NetBSD: destdir.mk,v 1.1 2006/11/15 19:27:16 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.
+#
+# === 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.
+#