pkgsrc-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/aa26876afec1
branches: trunk
changeset: 373309:aa26876afec1
user: nia <nia%pkgsrc.org@localhost>
date: Fri Feb 11 08:06:21 2022 +0000
description:
doc/pkgsrc.*: regen
diffstat:
doc/pkgsrc.html | 1323 ++++++++++++++++++++++++++++--------------------------
doc/pkgsrc.txt | 725 +++++++++++++++--------------
2 files changed, 1071 insertions(+), 977 deletions(-)
diffs (truncated from 2941 to 300 lines):
diff -r 1bc7d530cb3a -r aa26876afec1 doc/pkgsrc.html
--- a/doc/pkgsrc.html Fri Feb 11 08:02:05 2022 +0000
+++ b/doc/pkgsrc.html Fri Feb 11 08:06:21 2022 +0000
@@ -221,9 +221,10 @@
<dd><dl>
<dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
<dd><dl>
-<dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
-<dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
-<dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
+<dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -3188,9 +3189,10 @@
<dd><dl>
<dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
<dd><dl>
-<dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
-<dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
-<dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
+<dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -5064,9 +5066,10 @@
<dl class="toc">
<dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
<dd><dl>
-<dt><span class="sect2"><a href="#creating.python-module">14.1.1. Python modules and programs</a></span></dt>
-<dt><span class="sect2"><a href="#creating.R-package">14.1.2. R packages</a></span></dt>
-<dt><span class="sect2"><a href="#creating.TeX-package">14.1.3. TeXlive packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
+<dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
+<dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
+<dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
@@ -5090,16 +5093,20 @@
<li class="step">
<p>Choose one of the top-level directories as the category in
which you want to place your package. You can also create a directory of
-your own (maybe called <code class="filename">local</code>). Change into that
-category directory:</p>
-<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em></code></strong></pre>
+your own (maybe called <code class="filename">local</code>). In that category
+directory, create another directory for your package and change into
+it:</p>
+<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>mkdir <em class="replaceable"><code>category</code></em>/<em
class="replaceable"><code>package</code></em></code></strong>
+<code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em></code></strong></pre>
</li>
<li class="step">
-<p>Run the program <span class="command"><strong>url2pkg</strong></span>, passing as
-argument the URL of the distribution file (in most cases a
-<code class="filename">.tar.gz</code> file). This will download the distribution
-file and create the necessary files of the package, based on what's in
-the distribution file:</p>
+<p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
+you for a URL. Enter the URL of the distribution file (in most cases a
+<code class="filename">.tar.gz</code> file) and watch how the basic ingredients
+of your package are created automatically. The distribution file is
+extracted automatically to fill in some details in the
+<code class="filename">Makefile</code> that would otherwise have to be done
+manually:</p>
<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>url2pkg <em
class="replaceable"><code>https://www.example.org/packages/package-1.0.tar.gz</code></em></code></strong></pre>
</li>
<li class="step">
@@ -5113,7 +5120,7 @@
<code class="filename">buildlink3.mk</code> file does not exist, it must be
created first. The <code class="filename">buildlink3.mk</code> file makes sure
that the package's include files and libraries are provided.</p>
-<p>If you just need binaries from a dependent package, add a
+<p>If you just need binaries from a package, add a
<code class="varname">DEPENDS</code> line to the Makefile, which specifies the
version of the dependency and where it can be found in pkgsrc. This line
should be placed in the third paragraph. If the dependency is only
@@ -5123,13 +5130,13 @@
The difference between <code class="varname">TOOL_DEPENDS</code> and
<code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
<code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
-packages, i.e. packages for the platform where the package is built;
+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 platform for which the package
-is built. There is also <code class="varname">TEST_DEPENDS</code>, which
-specifies a dependency used only for testing the resulting package
-built, using the upstream project's included test suite, on the native
-platform.
+packages, i.e. packages for the architecture for which the package
+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">
[...]
@@ -5155,19 +5162,18 @@
over there, you can hopefully continue here.</p></li>
<li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
directory from the extracted files. Besides these files, a lot of cache
-files and other system information have been saved in the working
-directory, which may have become outdated after you edited the
+files and other system information has been saved in the working
+directory, which may become wrong after you edited the
<code class="filename">Makefile</code>.</p></li>
<li class="step">
<p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p>
-<p>If the extracted files from the package need to be fixed, run
-multiple rounds of these commands:</p>
-<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>bmake</code></strong>
+<p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
+<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
<code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
<code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
-<code class="prompt">$</code> <strong class="userinput"><code>bmake mps</code></strong>
-<code class="prompt">$</code> <strong class="userinput"><code>bmake clean</code></strong></pre>
+<code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
+<code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
</li>
<li class="step"><p>When the package builds fine, the next step is to install
the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
@@ -5186,11 +5192,12 @@
and <span class="command"><strong>bmake install</strong></span> again. Now the package is
registered with the list of files from
<code class="filename">PLIST</code>.</p></li>
+<li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
+package from the set of installed files.</p></li>
<li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
from above again in a single step, making sure that the PLIST is correct
and the whole package is created as intended.</p></li>
-<li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything
-left to do.</p></li>
+<li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
<li class="step"><p>Commit the package to pkgsrc-wip or main pkgsrc; see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and
Committing</i></a>.</p></li>
</ol></div>
<div class="sect1">
@@ -5198,7 +5205,13 @@
<a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="creating.python-module"></a>14.1.1. Python modules and programs</h3></div></div></div>
+<a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
+<p>Simple Perl modules are handled automatically by
+<span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
+</div>
+<div class="sect2">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
<p>Python modules and programs packages are easily created using a
set of predefined variables.</p>
<p>
@@ -5253,7 +5266,7 @@
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="creating.R-package"></a>14.1.2. R packages</h3></div></div></div>
+<a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
<p>Simple R packages from <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html"; target="_top">CRAN</a>
are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/index.html"; target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
@@ -5268,7 +5281,7 @@
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="creating.TeX-package"></a>14.1.3. TeXlive packages</h3></div></div></div>
+<a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
<p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/"; target="_top">CTAN</a> are handled automatically by
<span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/index.html"; target="_top"><code
class="filename">pkgtools/texlive2pkg</code></a>.</p>
<p>If the TeXlive package name is not known, it may be useful to
@@ -9718,11 +9731,15 @@
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
-<p>First, check that your package is complete, compiles and
+<p>Firstly, you can import new packages into
+ pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
+ homepage at <a class="ulink" href="https://pkgsrc.org/wip/"; target="_top">https://pkgsrc.org/wip/</a>
+ for details.</p>
+<p>Next, check that your package is complete, compiles and
runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest
of this
- document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/tar.1";><span class="citerefentry"><span
class="refentrytitle">tar</span>(1)</span></a>
- archive that contains all files that make up the package.
- Finally, send this package to the pkgsrc bug tracking system,
+ document. Run the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/index.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a>
+ tool and fix any errors that appear.</p>
+<p>Finally, send a report to the pkgsrc bug tracking system,
either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.2/i386/send-pr.1";><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or
if you don't have
that, go to the web page
<a class="ulink" href="https://www.NetBSD.org/support/send-pr.html"; target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
@@ -9735,15 +9752,7 @@
<span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
and version number, and the description field should contain a
short description of your package (contents of the COMMENT
- variable or DESCR file are OK). The uuencoded package data should
- go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
-<p>If you want to submit several packages, please send a
- separate PR for each one, it's easier for us to track things
- that way.</p>
-<p>Alternatively, you can also import new packages into
- pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
- homepage at <a class="ulink" href="https://pkgsrc.org/wip/"; target="_top">https://pkgsrc.org/wip/</a>
- for details.</p>
+ variable or DESCR file are OK).</p>
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -11065,8 +11074,8 @@
</p></li>
<li class="listitem"><p>
full: in addition to partial RELRO, every relocation is performed immediately
-when starting the program (with a slight performance impact), allowing the
-entire GOT to be read-only.
+when starting the program, allowing the entire GOT to be read-only. This
+can greatly slow down startup of large programs.
</p></li>
</ul></div>
<p>
@@ -12209,6 +12218,10 @@
<td>DOWNLOADED_DISTFILE</td>
</tr>
<tr>
+<td>DQCACHE_GROUP</td>
+<td>DQCACHE_USER</td>
+</tr>
+<tr>
<td>DT_LAYOUT</td>
<td>DYNAMIC_SITES_CMD</td>
</tr>
@@ -12329,14 +12342,6 @@
<td>FIX_SYSTEM_HEADERS</td>
</tr>
<tr>
-<td>FLUXBOX_USE_GNOME</td>
-<td>FLUXBOX_USE_KDE</td>
-</tr>
-<tr>
-<td>FLUXBOX_USE_XFT</td>
-<td>FLUXBOX_USE_XINERAMA</td>
-</tr>
-<tr>
<td>FONTDIR</td>
<td>FONTS_DIRS</td>
</tr>
@@ -12602,107 +12607,135 @@
</tr>
<tr>
<td>JABBERD_USER</td>
-<td>JAKARTA_HOME</td>
-</tr>
-<tr>
<td>JAVA_APP_PATH</td>
+</tr>
+<tr>
<td>JAVA_APP_TARGETS</td>
-</tr>
-<tr>
<td>JAVA_BINPREFIX</td>
+</tr>
+<tr>
<td>JAVA_CLASSPATH</td>
-</tr>
-<tr>
<td>JAVA_HOME</td>
+</tr>
+<tr>
<td>JAVA_LD_LIBRARY_PATH</td>
-</tr>
-<tr>
<td>JAVA_NAME</td>
+</tr>
+<tr>
<td>JAVA_UNLIMIT</td>
-</tr>
-<tr>
<td>JAVA_WRAPPERS</td>
+</tr>
+<tr>
<td>JPEG_ACCEPTED</td>
-</tr>
-<tr>
<td>JPEG_DEFAULT</td>
+</tr>
+<tr>
<td>KERBEROS</td>
-</tr>
-<tr>
<td>KERMIT_SUID_UUCP</td>
+</tr>
+<tr>
<td>KJS_USE_PCRE</td>
-</tr>
-<tr>
Home |
Main Index |
Thread Index |
Old Index