pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regen (option names)
details: https://anonhg.NetBSD.org/pkgsrc/rev/229eec82c65e
branches: trunk
changeset: 500293:229eec82c65e
user: dillo <dillo%pkgsrc.org@localhost>
date: Wed Oct 05 14:04:23 2005 +0000
description:
regen (option names)
diffstat:
doc/pkgsrc.html | 90 +++++++++++++++++++++++++++++++++++++++++---------------
doc/pkgsrc.txt | 46 ++++++++++++++++++++--------
2 files changed, 97 insertions(+), 39 deletions(-)
diffs (300 lines):
diff -r 68f655bc015e -r 229eec82c65e doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Oct 05 14:02:09 2005 +0000
+++ b/doc/pkgsrc.html Wed Oct 05 14:04:23 2005 +0000
@@ -61,13 +61,13 @@
</div>
<div>
- <p class="copyright">Copyright © 1994-2004 The
+ <p class="copyright">Copyright © 1994-2005 The
NetBSD Foundation, Inc</p>
</div>
<div xmlns="http://www.w3.org/TR/xhtml1/transitional";>
- <p xmlns="" class="pubdate">$NetBSD: pkgsrc.xml,v 1.9
- 2005/06/08 13:59:30 dillo Exp $</p>
+ <p xmlns="" class="pubdate">$NetBSD: pkgsrc.xml,v 1.10
+ 2005/10/05 13:59:56 dillo Exp $</p>
</div>
<div>
@@ -503,8 +503,8 @@
Variable substitution in PLIST</a></span></dt>
<dt><span class="sect1"><a href=
- "#manpage-compression">10.5. Man
- page-compression</a></span></dt>
+ "#manpage-compression">10.5. Man page
+ compression</a></span></dt>
<dt><span class="sect1"><a href=
"#using-PLIST_SRC">10.6. Changing PLIST source with
@@ -668,6 +668,9 @@
to use <code xmlns=
"http://www.w3.org/TR/xhtml1/transitional"; class=
"filename">bsd.options.mk</code></a></span></dt>
+
+ <dt><span class="sect1"><a href=
+ "#option-names">13.3. Option Names</a></span></dt>
</dl>
</dd>
@@ -1310,7 +1313,8 @@
<div>
<div>
<h1 class="title"><a name="users-guide" id=
- "users-guide"></a>The pkgsrc user's guide</h1>
+ "users-guide"></a>Part I. The pkgsrc user's
+ guide</h1>
</div>
</div>
</div>
@@ -5533,8 +5537,8 @@
<div>
<div>
<h1 class="title"><a name="developers-guide" id=
- "developers-guide"></a>The pkgsrc developer's
- guide</h1>
+ "developers-guide"></a>Part II. The pkgsrc
+ developer's guide</h1>
</div>
</div>
</div>
@@ -5654,8 +5658,8 @@
Variable substitution in PLIST</a></span></dt>
<dt><span class="sect1"><a href=
- "#manpage-compression">10.5. Man
- page-compression</a></span></dt>
+ "#manpage-compression">10.5. Man page
+ compression</a></span></dt>
<dt><span class="sect1"><a href=
"#using-PLIST_SRC">10.6. Changing PLIST source with
@@ -5814,6 +5818,9 @@
use <code xmlns=
"http://www.w3.org/TR/xhtml1/transitional"; class=
"filename">bsd.options.mk</code></a></span></dt>
+
+ <dt><span class="sect1"><a href="#option-names">13.3.
+ Option Names</a></span></dt>
</dl>
</dd>
@@ -7359,8 +7366,8 @@
Variable substitution in PLIST</a></span></dt>
<dt><span class="sect1"><a href=
- "#manpage-compression">10.5. Man
- page-compression</a></span></dt>
+ "#manpage-compression">10.5. Man page
+ compression</a></span></dt>
<dt><span class="sect1"><a href=
"#using-PLIST_SRC">10.6. Changing PLIST source with
@@ -7621,8 +7628,8 @@
<div>
<h2 class="title" style="clear: both"><a name=
"manpage-compression" id=
- "manpage-compression"></a>10.5. Man
- page-compression</h2>
+ "manpage-compression"></a>10.5. Man page
+ compression</h2>
</div>
</div>
</div>
@@ -9512,6 +9519,9 @@
use <code xmlns=
"http://www.w3.org/TR/xhtml1/transitional"; class=
"filename">bsd.options.mk</code></a></span></dt>
+
+ <dt><span class="sect1"><a href="#option-names">13.3.
+ Option Names</a></span></dt>
</dl>
</div>
@@ -9771,17 +9781,47 @@
.if !empty(PKG_OPTIONS:M<em class=
"replaceable"><code>option</code></em>)
</pre>
-
- <p>If another package already has an option with the same
- meaning, use the same name. For options applicable to
- multiple packages (like enabling support for a library),
- use short option names (like the name of the library).
- For options specific to this package, prefix the name
- with <code class="varname"><em class=
- "replaceable"><code>pkgname</code></em>-</code>. Document
- the option and its meaning in <code xmlns=
- "http://www.w3.org/TR/xhtml1/transitional"; class=
- "filename">mk/defaults/options.description</code>.</p>
+ </div>
+
+ <div class="sect1" lang="en" xml:lang="en">
+ <div class="titlepage">
+ <div>
+ <div>
+ <h2 class="title" style="clear: both"><a name=
+ "option-names" id=
+ "option-names"></a>13.3. Option Names</h2>
+ </div>
+ </div>
+ </div>
+
+ <p>Options that enable similar features in different
+ packages (like optional support for a library) should use
+ a common name in all packages that support it (like the
+ name of the library). If another package already has an
+ option with the same meaning, use the same name.</p>
+
+ <p>Options that enable features specific to one package,
+ where it's unlikely that another (unrelated) package has
+ the same (or a similar) optional feature, should use a
+ name prefixed with <code class="varname"><em class=
+ "replaceable"><code>pkgname</code></em>-</code>.</p>
+
+ <p>If a group of related packages share an optional
+ feature specific to that group, prefix it with the name
+ of the “<span class="quote">main</span>”
+ package (e. g. <code class=
+ "varname">djbware-errno-hack</code>).</p>
+
+ <p>For new options, add a line to <code xmlns=
+ "http://www.w3.org/TR/xhtml1/transitional"; class=
+ "filename">mk/defaults/options.description</code>. Lines
+ have two fields, separated by tab. The first field is the
+ option name, the second its description. The description
+ should be a whole sentence (starting with an uppercase
+ letter and ending with a period) that describes what
+ enabling the option does. E. g. “<span class=
+ "quote">Enable ispell support.</span>” The file is
+ sorted by option names.</p>
</div>
</div>
diff -r 68f655bc015e -r 229eec82c65e doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Wed Oct 05 14:02:09 2005 +0000
+++ b/doc/pkgsrc.txt Wed Oct 05 14:04:23 2005 +0000
@@ -12,9 +12,9 @@
The pkgsrc Developers
-Copyright (C) 1994-2004 The NetBSD Foundation, Inc
-
-$NetBSD: pkgsrc.xml,v 1.9 2005/06/08 13:59:30 dillo Exp $
+Copyright (C) 1994-2005 The NetBSD Foundation, Inc
+
+$NetBSD: pkgsrc.xml,v 1.10 2005/10/05 13:59:56 dillo Exp $
Abstract
@@ -146,7 +146,7 @@
10.2. Semi-automatic PLIST generation
10.3. Tweaking output of make print-PLIST
10.4. Variable substitution in PLIST
- 10.5. Man page-compression
+ 10.5. Man page compression
10.6. Changing PLIST source with PLIST_SRC
10.7. Platform-specific and differing PLISTs
10.8. Sharing directories between packages
@@ -191,6 +191,7 @@
13.1. Global default options
13.2. Converting packages to use bsd.options.mk
+ 13.3. Option Names
14. The build process
@@ -417,7 +418,7 @@
sufficient. We use a # for root's shell prompt, and a % for users' shell
prompt, assuming they use the C-shell or tcsh.
-The pkgsrc user's guide
+Part I. The pkgsrc user's guide
Table of Contents
@@ -2034,7 +2035,7 @@
"audit-packages" is installed, please read the package's message, which you can
get by running pkg_info -D audit-package.
-The pkgsrc developer's guide
+Part II. The pkgsrc developer's guide
Table of Contents
@@ -2068,7 +2069,7 @@
10.2. Semi-automatic PLIST generation
10.3. Tweaking output of make print-PLIST
10.4. Variable substitution in PLIST
- 10.5. Man page-compression
+ 10.5. Man page compression
10.6. Changing PLIST source with PLIST_SRC
10.7. Platform-specific and differing PLISTs
10.8. Sharing directories between packages
@@ -2113,6 +2114,7 @@
13.1. Global default options
13.2. Converting packages to use bsd.options.mk
+ 13.3. Option Names
14. The build process
@@ -2739,7 +2741,7 @@
10.2. Semi-automatic PLIST generation
10.3. Tweaking output of make print-PLIST
10.4. Variable substitution in PLIST
-10.5. Man page-compression
+10.5. Man page compression
10.6. Changing PLIST source with PLIST_SRC
10.7. Platform-specific and differing PLISTs
10.8. Sharing directories between packages
@@ -2836,7 +2838,7 @@
This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
-10.5. Man page-compression
+10.5. Man page compression
Man pages should be installed in compressed form if MANZ is set (in
bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
@@ -3568,6 +3570,7 @@
13.1. Global default options
13.2. Converting packages to use bsd.options.mk
+13.3. Option Names
Many packages have the ability to be built to support different sets of
features. bsd.options.mk is a framework in pkgsrc that provides generic
@@ -3697,11 +3700,26 @@
.if !empty(PKG_OPTIONS:Moption)
-If another package already has an option with the same meaning, use the same
-name. For options applicable to multiple packages (like enabling support for a
-library), use short option names (like the name of the library). For options
-specific to this package, prefix the name with pkgname-. Document the option
-and its meaning in mk/defaults/options.description.
+13.3. Option Names
+
+Options that enable similar features in different packages (like optional
+support for a library) should use a common name in all packages that support it
+(like the name of the library). If another package already has an option with
+the same meaning, use the same name.
+
+Options that enable features specific to one package, where it's unlikely that
+another (unrelated) package has the same (or a similar) optional feature,
+should use a name prefixed with pkgname-.
+
+If a group of related packages share an optional feature specific to that
+group, prefix it with the name of the "main" package (e. g.
+djbware-errno-hack).
+
+For new options, add a line to mk/defaults/options.description. Lines have two
+fields, separated by tab. The first field is the option name, the second its
+description. The description should be a whole sentence (starting with an
+uppercase letter and ending with a period) that describes what enabling the
+option does. E. g. "Enable ispell support." The file is sorted by option names.
Chapter 14. The build process
Home |
Main Index |
Thread Index |
Old Index