pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc re-generate
details: https://anonhg.NetBSD.org/pkgsrc/rev/3e70b6a145ab
branches: trunk
changeset: 497407:3e70b6a145ab
user: gdt <gdt%pkgsrc.org@localhost>
date: Wed Jul 27 14:42:30 2005 +0000
description:
re-generate
diffstat:
doc/pkgsrc.html | 122 +++++++++++++++++++++++++++++++++++--------------------
doc/pkgsrc.txt | 99 +++++++++++++++++++++++++++-----------------
2 files changed, 138 insertions(+), 83 deletions(-)
diffs (truncated from 320 to 300 lines):
diff -r cbd6f821a78e -r 3e70b6a145ab doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Jul 27 14:40:46 2005 +0000
+++ b/doc/pkgsrc.html Wed Jul 27 14:42:30 2005 +0000
@@ -3134,17 +3134,18 @@
<span><strong class="command">make
show-options</strong></span>, for example:</p>
<pre class="programlisting">
-The following options are supported by this package:
- ssl Enable SSL support.
-Exactly one of the following gecko options is required:
- firefox Use firefox as gecko rendering engine.
- mozilla Use mozilla as gecko rendering engine.
-At most one of the following database options may be selected:
- mysql Enable support for MySQL database.
- pgsql Enable support for PostgreSQL database.
-
-These options are enabled by default: firefox
-These options are currently enabled: mozilla ssl
+ The following options are supported by this package:
+ ssl Enable SSL support.
+ Exactly one of the following gecko options is required:
+ firefox Use firefox as gecko rendering engine.
+ mozilla Use mozilla as gecko rendering engine.
+ At most one of the following database options may be selected:
+ mysql Enable support for MySQL database.
+ pgsql Enable support for PostgreSQL database.
+
+ These options are enabled by default: firefox
+ These options are currently enabled: mozilla ssl
+
</pre>
<p>The following variables can be defined in <code class=
@@ -8869,6 +8870,21 @@
<li>
<p><code class=
+ "varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a
+ list of names of sets of options. At least one
+ option from each set must be selected. The options
+ in each set are listed in <code class=
+ "varname">PKG_OPTIONS_SET.<em class=
+ "replaceable"><code>setname</code></em></code>.
+ Options from the sets will be automatically added
+ to <code class=
+ "varname">PKG_SUPPORTED_OPTIONS</code>. Building
+ the package will fail if no option from the set is
+ selected.</p>
+ </li>
+
+ <li>
+ <p><code class=
"varname">PKG_SUGGESTED_OPTIONS</code> is a list of
build options which are enabled by default.</p>
</li>
@@ -11411,40 +11427,54 @@
</div>
</div>
- <p>A package may underly a license which the user has
- or has not agreed to accept. Usually, packages that
- underly well-known Open Source licenses (e.g. the GNU
- Public License, GPL) won't have any special license
- tags added in pkgsrc which require special action by
- the user of such packages, but there are quite a number
- of other licenses out there that pkgsrc users may not
- be able to follow, for whatever reasons. For these
- cases, pkgsrc contains a mechanism to note that a
- package underlies a certain license, and the user has
- to accept the license before the package can be
- installed.</p>
-
- <p>Placing a certain package under a certain license
- works by setting the <code class=
- "varname">LICENSE</code> variable to a string
- identifying the license, e.g. in <a xmlns=
+ <p>A package may be covered by a license which the user
+ has or has not agreed to accept. For these cases,
+ pkgsrc contains a mechanism to note that a package is
+ covered by a particular license, and the package cannot
+ be built unless the user has accepted the license.
+ (Installation of binary packages are not currently
+ subject to this mechanism.) Packages with licenses that
+ are either Open Source according to the Open Source
+ Initiative or Free according to the Free Software
+ Foundation will not be marked with a license tag.
+ Packages with licenses that have not been determined to
+ meet either definition will be marked with a license
+ tag referring to the license. This will prevent
+ building unless pkgsrc is informed that the license is
+ acceptable, and enables displaying the license.</p>
+
+ <p>The license tag mechanism is intended to address
+ copyright-related issues surrounding building,
+ installing and using a package, and not to address
+ redistribution issues (see <code class=
+ "varname">RESTRICTED</code> and <code class=
+ "varname">NO_SRC_ON_FTP</code>, etc.). However, the
+ above definition of licenses for which tags are not
+ needed implies that packages with redistribution
+ restrictions should have tags.</p>
+
+ <p>Denoting that a package is covered by a particular
+ license is done by placing the license in <code class=
+ "filename">pkgsrc/licenses</code> and setting the
+ <code class="varname">LICENSE</code> variable to a
+ string identifying the license, e.g. in <a xmlns=
"http://www.w3.org/TR/xhtml1/transitional"; href=
- "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/graphics/graphviz/README.html";
- class="pkgname">graphics/graphviz</a>:</p>
+ "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/graphics/xv/README.html";
+ class="pkgname">graphics/xv</a>:</p>
<pre class="programlisting">
-LICENSE= graphviz-license
+LICENSE= xv-license
</pre>
<p>When trying to build, the user will get a notice
- that the package underlies a license which he hasn't
- accepted (yet):</p>
+ that the package is covered by a license which has not
+ been accepted:</p>
<pre class="programlisting">
<code class="prompt">%</code> <strong class=
"userinput"><code>make</code></strong>
-===> graphviz-1.12 has an unacceptable license: graphviz-license.
-===> To build this package, add this line to your /etc/mk.conf:
-===> ACCEPTABLE_LICENSES+=graphviz-license
+===> xv-3.10anb9 has an unacceptable license: xv-license.
===> To view the license, enter "/usr/bin/make show-license".
+===> To indicate acceptance, add this line to your /etc/mk.conf:
+===> ACCEPTABLE_LICENSES+=xv-license
*** Error code 1
</pre>
@@ -11454,7 +11484,7 @@
be added to <code class="filename">/etc/mk.conf</code>
to indicate acceptance of the particular license:</p>
<pre class="programlisting">
-ACCEPTABLE_LICENSES+=graphviz-license
+ACCEPTABLE_LICENSES+=xv-license
</pre>
<p>When adding a package with a new license, the
@@ -11466,13 +11496,17 @@
variable settings in <code class=
"filename">pkgsrc/mk/defaults/mk.conf</code>.</p>
- <p>If there is a <span class=
- "emphasis"><em>really</em></span> pressing need to
- accept all licenses at once, like when trying to
- download or mirror all distfiles or doing a bulk build
- to test if all packages in pkgsrc build, this can be
- done by setting <code class=
- "varname">_ACCEPTABLE=yes</code>.</p>
+ <p>The use of <code class=
+ "varname">LICENSE=shareware</code>, <code class=
+ "varname">LICENSE=no-commercial-use</code>, and similar
+ language is deprecated because it does not crisply
+ refer to a particular license text. Another problem
+ with such usage is that it does not enable a user to
+ denote acceptance of the license for a single package
+ without accepting the same license text for another
+ package. In particular, this can be inappropriate when
+ e.g. one accepts a particular license to indicate to
+ pkgsrc that a fee has been paid.</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
diff -r cbd6f821a78e -r 3e70b6a145ab doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Wed Jul 27 14:40:46 2005 +0000
+++ b/doc/pkgsrc.txt Wed Jul 27 14:42:30 2005 +0000
@@ -1185,17 +1185,18 @@
To see which options, if any, a package supports, and which options are
mutually exclusive, run make show-options, for example:
-The following options are supported by this package:
- ssl Enable SSL support.
-Exactly one of the following gecko options is required:
- firefox Use firefox as gecko rendering engine.
- mozilla Use mozilla as gecko rendering engine.
-At most one of the following database options may be selected:
- mysql Enable support for MySQL database.
- pgsql Enable support for PostgreSQL database.
-
-These options are enabled by default: firefox
-These options are currently enabled: mozilla ssl
+ The following options are supported by this package:
+ ssl Enable SSL support.
+ Exactly one of the following gecko options is required:
+ firefox Use firefox as gecko rendering engine.
+ mozilla Use mozilla as gecko rendering engine.
+ At most one of the following database options may be selected:
+ mysql Enable support for MySQL database.
+ pgsql Enable support for PostgreSQL database.
+
+ These options are enabled by default: firefox
+ These options are currently enabled: mozilla ssl
+
The following variables can be defined in /etc/mk.conf to select which options
to enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
@@ -3533,24 +3534,30 @@
4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
building the packages will fail if no option from the group is selected.
- 5. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
+ 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
+ one option from each set must be selected. The options in each set are
+ listed in PKG_OPTIONS_SET.setname. Options from the sets will be
+ automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
+ fail if no option from the set is selected.
+
+ 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
default.
- 6. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE: option" pairs that map
+ 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE: option" pairs that map
legacy /etc/mk.conf variables to their option counterparts. Pairs should be
added with "+=" to keep the listing of global legacy variables. A warning
will be issued if the user uses a legacy variable.
- 7. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option: new-option" pairs that
+ 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option: new-option" pairs that
map options that have been renamed to their new counterparts. Pairs should
be added with "+=" to keep the listing of global legacy options. A warning
will be issued if the user uses a legacy option.
- 8. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
+ 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
- 9. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
+10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
variables or options used, and what to use instead.
A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
@@ -4638,44 +4645,58 @@
15.5.2. Handling licenses
-A package may underly a license which the user has or has not agreed to accept.
-Usually, packages that underly well-known Open Source licenses (e.g. the GNU
-Public License, GPL) won't have any special license tags added in pkgsrc which
-require special action by the user of such packages, but there are quite a
-number of other licenses out there that pkgsrc users may not be able to follow,
-for whatever reasons. For these cases, pkgsrc contains a mechanism to note that
-a package underlies a certain license, and the user has to accept the license
-before the package can be installed.
-
-Placing a certain package under a certain license works by setting the LICENSE
-variable to a string identifying the license, e.g. in graphics/graphviz:
-
-LICENSE= graphviz-license
-
-When trying to build, the user will get a notice that the package underlies a
-license which he hasn't accepted (yet):
+A package may be covered by a license which the user has or has not agreed to
+accept. For these cases, pkgsrc contains a mechanism to note that a package is
+covered by a particular license, and the package cannot be built unless the
+user has accepted the license. (Installation of binary packages are not
+currently subject to this mechanism.) Packages with licenses that are either
+Open Source according to the Open Source Initiative or Free according to the
+Free Software Foundation will not be marked with a license tag. Packages with
+licenses that have not been determined to meet either definition will be marked
+with a license tag referring to the license. This will prevent building unless
+pkgsrc is informed that the license is acceptable, and enables displaying the
+license.
+
+The license tag mechanism is intended to address copyright-related issues
+surrounding building, installing and using a package, and not to address
+redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). However, the
+above definition of licenses for which tags are not needed implies that
+packages with redistribution restrictions should have tags.
+
+Denoting that a package is covered by a particular license is done by placing
+the license in pkgsrc/licenses and setting the LICENSE variable to a string
+identifying the license, e.g. in graphics/xv:
+
+LICENSE= xv-license
+
+When trying to build, the user will get a notice that the package is covered by
+a license which has not been accepted:
% make
-===> graphviz-1.12 has an unacceptable license: graphviz-license.
-===> To build this package, add this line to your /etc/mk.conf:
-===> ACCEPTABLE_LICENSES+=graphviz-license
+===> xv-3.10anb9 has an unacceptable license: xv-license.
===> To view the license, enter "/usr/bin/make show-license".
+===> To indicate acceptance, add this line to your /etc/mk.conf:
+===> ACCEPTABLE_LICENSES+=xv-license
*** Error code 1
The license can be viewed with make show-license, and if it is considered
appropriate, the line printed above can be added to /etc/mk.conf to indicate
acceptance of the particular license:
-ACCEPTABLE_LICENSES+=graphviz-license
Home |
Main Index |
Thread Index |
Old Index