summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2007-02-05 14:27:34 +0000
committerrillig <rillig@pkgsrc.org>2007-02-05 14:27:34 +0000
commit38cb040e39b9458321c6ab61ddf63e1c27b7b67c (patch)
tree89fc03f925921a7baf5510766c4717db88c5ef7d
parente150b2832a1c6e6399511d2c5cef09b543c476b3 (diff)
downloadpkgsrc-38cb040e39b9458321c6ab61ddf63e1c27b7b67c.tar.gz
More documentation for debugging pkgsrc.
-rw-r--r--mk/bsd.pkg.debug.mk21
-rw-r--r--mk/help/debug.help29
2 files changed, 42 insertions, 8 deletions
diff --git a/mk/bsd.pkg.debug.mk b/mk/bsd.pkg.debug.mk
index 2c67bd5ccdd..7dae6a1856a 100644
--- a/mk/bsd.pkg.debug.mk
+++ b/mk/bsd.pkg.debug.mk
@@ -1,13 +1,18 @@
-# $NetBSD: bsd.pkg.debug.mk,v 1.13 2007/01/08 11:06:44 rillig Exp $
+# $NetBSD: bsd.pkg.debug.mk,v 1.14 2007/02/05 14:27:34 rillig Exp $
#
-
-# The `debug' target outputs the values of some commonly used variables
-# and the contents of some files which are useful for tracking bugs,
-# especially for packages that use the GNU autotools.
+# Public targets:
+#
+# debug:
+# outputs the values of some commonly used variables and the
+# contents of some files which are useful for tracking bugs,
+# especially for packages that use the GNU autotools.
+#
+# build-env:
+# This target is intended to be used interactively when
+# debugging build problems. It runs a shell in exactly the same
+# environment as in the default do-build target, starting in
+# WRKSRC.
#
-# The `build-env' target is intended to be used interactively when
-# debugging build problems. It runs a shell in exactly the same
-# environment as in the default do-build target, starting in WRKSRC.
PRINTF?= printf
diff --git a/mk/help/debug.help b/mk/help/debug.help
new file mode 100644
index 00000000000..f75ea5ed71e
--- /dev/null
+++ b/mk/help/debug.help
@@ -0,0 +1,29 @@
+# $NetBSD: debug.help,v 1.1 2007/02/05 14:27:34 rillig Exp $
+#
+# Since pkgsrc is a quite large and complex software system, it
+# sometimes isn't obvious what it is doing exactly. For that reason,
+# there are some variables that control how much details are shown to
+# the pkgsrc user.
+#
+# User-settable variables:
+#
+# PKG_DEBUG_LEVEL
+# How verbose should pkgsrc be when running shell commands?
+#
+# * 0: don't show most shell commands.
+# * 1: print the complete shell command to stdout before running
+# it.
+# * 2: like 1, but in addition, set the "-x" option of /bin/sh,
+# so that every single command is printed to stderr before
+# running it.
+#
+# PKG_VERBOSE
+# When this variable is defined, pkgsrc gets a bit more verbose.
+# This variable is largely independent from PKG_DEBUG_LEVEL.
+#
+# Default value: (undefined)
+#
+# XXX: Why are there _two_ variables doing similar things?
+#
+# Keywords: debug verbose
+#