Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc doc/pkgsrc.*: regen
details: https://anonhg.NetBSD.org/pkgsrc/rev/7a893389f9cf
branches: trunk
changeset: 428627:7a893389f9cf
user: gutteridge <gutteridge%pkgsrc.org@localhost>
date: Wed Apr 29 23:58:57 2020 +0000
description:
doc/pkgsrc.*: regen
diffstat:
doc/pkgsrc.html | 1468 ++++++++++++++++++++++++------------------------------
doc/pkgsrc.txt | 782 ++++++++++++++---------------
2 files changed, 1041 insertions(+), 1209 deletions(-)
diffs (truncated from 3291 to 300 lines):
diff -r 452d950323c7 -r 7a893389f9cf doc/pkgsrc.html
--- a/doc/pkgsrc.html Wed Apr 29 23:54:10 2020 +0000
+++ b/doc/pkgsrc.html Wed Apr 29 23:58:57 2020 +0000
@@ -549,7 +549,7 @@
— That means, if a package contains bugs, it's better to find
them and to complain about them rather than to just install the package
and hope that it works. There are numerous checks in pkgsrc that try to
-find such bugs: Static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a>),
build-time checks (portability
+find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a>),
build-time checks (portability
of shell scripts), and post-installation checks (installed files,
references to shared libraries, script interpreters).</p></li>
<li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
@@ -2066,14 +2066,14 @@
<dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
</dl>
</div>
-<p>For a number of reasons you may want to build binary packages
-for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
+<p>For a number of reasons, you may want to build binary packages
+for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
For instance, when you have multiple machines that should run the same software,
it is wasted time if they all build their packages themselves from source.
Or you may want to build a list of packages you want and check them before
-deploying onto production system.
+deploying onto production systems.
There is a way of getting a set of binary packages:
-The bulk build system, or pbulk ("p" stands for "parallel").
+the bulk build system, or pbulk ("p" stands for "parallel").
This chapter describes how to set it up.</p>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -2081,10 +2081,10 @@
<p>First of all, you have to decide whether you build all packages
or a limited set of them. Full bulk builds usually consume a lot more resources,
both space and time, than builds for some practical sets of packages.
-There exists a number of particularly heavy packages that are not actually
-interesting to a wide audience.
-
-For a limited bulk builds you need to make a list of packages you want to build.
+A number of particularly heavy packages exist that are not actually
+interesting to a wide audience. (The approximate resource consumption for a
+full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, “Requirements of a full bulk build”</a>.)
+For limited bulk builds you need to make a list of packages you want to build.
Note that all their dependencies will be built, so you don't need to track them manually.
</p>
<p>During bulk builds various packages are installed and deinstalled
@@ -2213,7 +2213,7 @@
<p>If you wish to include a common set of files
(<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
etc.) on each CD in the collection, then you need to create a
- directory which contains these files. e.g.</p>
+ directory which contains these files, e.g.:</p>
<pre class="screen">
<code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
<code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
@@ -3155,7 +3155,9 @@
is built;
<code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
packages, i.e. packages for the architecture for which the package
-is built.
+is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
+to specify a dependency used only for testing the resulting package
+built, using the upstream project's included test suite.
Your package may then look like this:</p>
<pre class="programlisting">
[...]
@@ -3236,12 +3238,12 @@
<code class="filename">../../lang/python/extension.mk</code>.</p>
<p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
easy-setup/setuptools (<span class="quote">“<span class="quote">eggs</span>”</span>).
-if the packaged software is using setuptools, you only need
+If the packaged software is using setuptools, you only need
to include <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.
Otherwise, if the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, include
-<span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>.
+<span class="quote">“<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>”</span>,
so pkgsrc will use this framework.
-<span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
+<span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>;
if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
<code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
to the name of the script.</p>
@@ -7191,35 +7193,37 @@
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
-<p>Your package may depend on some other package being present
- - and there are various ways of expressing this dependency.
- pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
- <code class="varname">DEPENDS</code> and
- <code class="varname">TOOL_DEPENDS</code> definitions, the
+<p>Your package may depend on some other package being present,
+ and there are various ways of expressing this dependency.
+ pkgsrc supports the <code class="varname">DEPENDS</code>,
+ <code class="varname">BUILD_DEPENDS</code>,
+ <code class="varname">TOOL_DEPENDS</code>, and
+ <code class="varname">TEST_DEPENDS</code> definitions, the
<code class="varname">USE_TOOLS</code> definition, as well as dependencies
via <code class="filename">buildlink3.mk</code>, which is the preferred way
to handle dependencies, and which uses the variables named above.
See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
-<p>The basic difference between the two variables is as
- follows: The <code class="varname">DEPENDS</code> definition registers
- that pre-requisite in the binary package so it will be pulled in
- when the binary package is later installed, whilst the
- <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
- definitions does not, marking a dependency that is only needed for
- building the package.</p>
+<p>The basic difference is that the <code class="varname">DEPENDS</code>
+ definition registers that pre-requisite in the binary package so it
+ will be pulled in when the binary package is later installed, whilst
+ the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
+ and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
+ dependency that is only needed for building or testing the resulting
+ package. See also <a class="xref" href="#creating" title="Chapter 12. Creating a new pkgsrc package from scratch">Chapter 12, <i>Creating a new pkgsrc package from scratch</i></a> for more
information.</p>
<p>This means that if you only need a package present whilst
- you are building, it should be noted as a
- <code class="varname">TOOL_DEPENDS</code> or
- <code class="varname">BUILD_DEPENDS</code>. When cross-compiling,
+ you are building or testing, it should be noted as a
+ <code class="varname">TOOL_DEPENDS</code>,
+ <code class="varname">BUILD_DEPENDS</code>, or
+ <code class="varname">TEST_DEPENDS</code>. When cross-compiling,
<code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
packages, i.e. packages for the architecture where the package
is built;
<code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
- packages, i.e. packages for the architecture for which the package
+ packages, i.e., packages for the architecture for which the package
is built.</p>
-<p>The format for <code class="varname">BUILD_DEPENDS</code>,
- <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
- definition is:</p>
+<p>The format for a <code class="varname">DEPENDS</code>,
+ <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
+ and <code class="varname">TEST_DEPENDS</code> definition is:</p>
<pre class="programlisting">
<pre-req-package-name>:../../<category>/<pre-req-package>
</pre>
@@ -7274,6 +7278,10 @@
DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
</pre>
</li>
+<li class="listitem"><p>If your package includes a test suite that has extra
+ dependencies only required for this purpose (frequently this
+ can be run as a <span class="quote">“<span class="quote">make test</span>”</span> target), use the
+ <code class="varname">TEST_DEPENDS</code> variable.</p></li>
<li class="listitem">
<p>You can use wildcards in package dependencies. Note that
such wildcard dependencies are retained when creating binary
@@ -9127,10 +9135,10 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
<p>Renaming packages is not recommended.</p>
-<p>When renaming packages, be sure to fix any references to old name
+<p>When renaming packages, be sure to fix any references to the old name
in other Makefiles, options, buildlink files, etc.</p>
<p>
- Also when renaming a package, please add
+ Also, when renaming a package, please add
the package name and version pattern(s) of the previous package
to <code class="varname">SUPERSEDES</code>.
This may be repeated for multiple renames.
@@ -10714,78 +10722,70 @@
</tr>
<tr>
<td>ALL_ENV</td>
-<td>ALSA_PC</td>
-</tr>
-<tr>
<td>ALTERNATIVES_SRC</td>
+</tr>
+<tr>
<td>AMANDA_TMP</td>
-</tr>
-<tr>
<td>AMANDA_USER</td>
+</tr>
+<tr>
<td>AMANDA_VAR</td>
-</tr>
-<tr>
<td>APACHE_GROUP</td>
+</tr>
+<tr>
<td>APACHE_MODULE_NAME</td>
-</tr>
-<tr>
<td>APACHE_MODULE_SRC</td>
+</tr>
+<tr>
<td>APACHE_MODULE_SRCDIR</td>
-</tr>
-<tr>
<td>APACHE_PKG_PREFIX</td>
+</tr>
+<tr>
<td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
-</tr>
-<tr>
<td>APACHE_SUEXEC_DOCROOT</td>
+</tr>
+<tr>
<td>APACHE_USER</td>
-</tr>
-<tr>
<td>APPEND_ABI</td>
+</tr>
+<tr>
<td>APPEND_ELF</td>
-</tr>
-<tr>
<td>ARLA_CACHE</td>
+</tr>
+<tr>
<td>AUDIT_PACKAGES_FLAGS</td>
-</tr>
-<tr>
<td>AUTOCONF_REQD</td>
+</tr>
+<tr>
<td>AUTOMAKE_OVERRIDE</td>
-</tr>
-<tr>
<td>AUTOMAKE_REQD</td>
+</tr>
+<tr>
<td>AUTO_MKDIRS</td>
-</tr>
-<tr>
<td>BDB185_DEFAULT</td>
+</tr>
+<tr>
<td>BDBBASE</td>
-</tr>
-<tr>
<td>BDB_ACCEPTED</td>
+</tr>
+<tr>
<td>BDB_DEFAULT</td>
-</tr>
-<tr>
<td>BDB_LIBS</td>
+</tr>
+<tr>
<td>BDB_TYPE</td>
-</tr>
-<tr>
<td>BIND_DIR</td>
+</tr>
+<tr>
<td>BIND_GROUP</td>
-</tr>
-<tr>
<td>BIND_USER</td>
+</tr>
+<tr>
<td>BINPKG_SITES</td>
-</tr>
-<tr>
<td>BIN_INSTALL_FLAGS</td>
+</tr>
+<tr>
<td>BISON_PKGDATADIR</td>
-</tr>
-<tr>
-<td>BLAS_ACCEPTED</td>
-<td>BLAS_LIBS</td>
-</tr>
-<tr>
-<td>BLAS_TYPE</td>
<td>BOOTSTRAP_DEPENDS</td>
</tr>
<tr>
@@ -10898,95 +10898,83 @@
</tr>
<tr>
<td>CDROM_PKG_URL_HOST</td>
-<td>CHECKOUT_DATE</td>
-</tr>
-<tr>
<td>CHECK_FAKEHOME</td>
+</tr>
+<tr>
<td>CHECK_FILES</td>
-</tr>
-<tr>
<td>CHECK_FILES_SKIP</td>
+</tr>
+<tr>
<td>CHECK_FILES_STRICT</td>
-</tr>
-<tr>
<td>CHECK_HEADERS</td>
+</tr>
+<tr>
<td>CHECK_HEADERS_SKIP</td>
-</tr>
-<tr>
<td>CHECK_INTERPRETER</td>
Home |
Main Index |
Thread Index |
Old Index