summaryrefslogtreecommitdiff
path: root/mk/bsd.options.mk
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2007-03-07 00:33:24 +0000
committerrillig <rillig@pkgsrc.org>2007-03-07 00:33:24 +0000
commite7e1da68343717a03daa317cfaa788a1e0f7aefb (patch)
tree31824b34055ab28b517db33099406054a2b5df47 /mk/bsd.options.mk
parent85ffd1d2aec6a7ba9e7feef5a4bcd41dcc20d1c5 (diff)
downloadpkgsrc-e7e1da68343717a03daa317cfaa788a1e0f7aefb.tar.gz
Split the documentation into a user and a developer part.
Diffstat (limited to 'mk/bsd.options.mk')
-rw-r--r--mk/bsd.options.mk11
1 files changed, 8 insertions, 3 deletions
diff --git a/mk/bsd.options.mk b/mk/bsd.options.mk
index 8b8195581fe..81d8351cd85 100644
--- a/mk/bsd.options.mk
+++ b/mk/bsd.options.mk
@@ -1,4 +1,4 @@
-# $NetBSD: bsd.options.mk,v 1.58 2006/10/01 14:51:03 rillig Exp $
+# $NetBSD: bsd.options.mk,v 1.59 2007/03/07 00:33:24 rillig Exp $
#
# This Makefile fragment provides boilerplate code for standard naming
# conventions for handling per-package build options.
@@ -85,7 +85,10 @@
# This is the list of the selected build options, properly
# filtered to remove unsupported and duplicate options.
#
-# Example usage:
+
+# To add options support to a package, here is an example for an
+# options.mk file. This file should be included by the package Makefile
+# or Makefile.common.
#
# -------------8<-------------8<-------------8<-------------8<-------------
# PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
@@ -97,9 +100,9 @@
# PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_SASL2:sasl
# PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
#
-# # this package was previously named wibble2
# .include "../../mk/bsd.prefs.mk"
#
+# # this package was previously named wibble2
# .if defined(PKG_OPTIONS.wibble2)
# PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
# PKG_OPTIONS_DEPRECATED_WARNINGS+="Deprecated variable PKG_OPTIONS.wibble2 used, use "${PKG_OPTIONS_VAR:Q}" instead."
@@ -142,6 +145,8 @@
# . include "../../mk/pgsql.buildlink3.mk"
# .endif
# -------------8<-------------8<-------------8<-------------8<-------------
+#
+# Keywords: options.mk
.include "../../mk/bsd.prefs.mk"