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/c9dbebcb789f
branches: trunk
changeset: 373830:c9dbebcb789f
user: nia <nia%pkgsrc.org@localhost>
date: Sun Feb 13 11:16:54 2022 +0000
description:
doc/pkgsrc.*: regen
diffstat:
doc/pkgsrc.html | 149 +++++++++++++++++++++++++------------------------------
doc/pkgsrc.txt | 145 ++++++++++++++++++++++++-----------------------------
2 files changed, 134 insertions(+), 160 deletions(-)
diffs (truncated from 496 to 300 lines):
diff -r 53fd1de9ac98 -r c9dbebcb789f doc/pkgsrc.html
--- a/doc/pkgsrc.html Sun Feb 13 11:16:35 2022 +0000
+++ b/doc/pkgsrc.html Sun Feb 13 11:16:54 2022 +0000
@@ -221,10 +221,9 @@
<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.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>
+<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>
</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>
@@ -3189,10 +3188,9 @@
<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.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>
+<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>
</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>
@@ -5066,10 +5064,9 @@
<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.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>
+<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>
</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>
@@ -5093,20 +5090,16 @@
<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>). 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>
+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>
</li>
<li class="step">
-<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>
+<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>
<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">
@@ -5120,7 +5113,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 package, add a
+<p>If you just need binaries from a dependent 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
@@ -5130,13 +5123,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 architecture where the package
-is built;
+packages, i.e. packages for the platform 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
-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.
+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.
Your package may then look like this:</p>
<pre class="programlisting">
[...]
@@ -5162,18 +5155,19 @@
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 has been saved in the working
-directory, which may become wrong after you edited the
+files and other system information have been saved in the working
+directory, which may have become outdated 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>make</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>bmake</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>make mps</code></strong>
-<code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
+<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>
</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
@@ -5192,12 +5186,11 @@
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">
@@ -5205,13 +5198,7 @@
<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.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>
+<a name="creating.python-module"></a>14.1.1. 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>
@@ -5266,7 +5253,7 @@
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
+<a name="creating.R-package"></a>14.1.2. 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>.
@@ -5281,7 +5268,7 @@
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
+<a name="creating.TeX-package"></a>14.1.3. 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
@@ -11035,6 +11022,37 @@
<code class="varname">PKGSRC_MKPIE</code> was enabled by default after the pkgsrc-2021Q3 branch.
</p>
</div>
+<div class="sect3">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="hardening.mechanisms.enabled.relro"></a>B.1.1.4. PKGSRC_USE_RELRO</h4></div></div></div>
+<p>
+This also makes the exploitation of some security vulnerabilities more
+difficult in some cases.
+</p>
+<p>Two different mitigation levels are available:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>
+partial (the default): the ELF sections are reordered so that internal data sections
+precede the program's own data sections, and non-PLT GOT is read-only;
+</p></li>
+<li class="listitem"><p>
+full: in addition to partial RELRO, every relocation is performed immediately
+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>
+This is currently supported by GCC. Many software distributions now enable this
+feature by default, at the "partial" level. However, it cannot yet be enforced
+globally in pkgsrc through cwrappers.
+</p>
+<p>
+More details can be found here:
+</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
+<a class="ulink" href="https://www.redhat.com/en/blog/hardening-elf-binaries-using-relocation-read-only-relro"; target="_top">Hardening ELF binaries using Relocation Read-Only (RELRO)</a>
+</p></li></ul></div>
+</div>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
@@ -11061,38 +11079,7 @@
</div>
<div class="sect3">
<div class="titlepage"><div><div><h4 class="title">
-<a name="hardening.mechanisms.enabled.relro"></a>B.1.2.2. PKGSRC_USE_RELRO</h4></div></div></div>
-<p>
-This also makes the exploitation of some security vulnerabilities more
-difficult in some cases.
-</p>
-<p>Two different mitigation levels are available:</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem"><p>
-partial: the ELF sections are reordered so that internal data sections
-precede the program's own data sections, and non-PLT GOT is read-only;
-</p></li>
-<li class="listitem"><p>
-full: in addition to partial RELRO, every relocation is performed immediately
-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>
-This is currently supported by GCC. Many software distributions now enable this
-feature by default, at the "partial" level. However, it cannot yet be enforced
-globally in pkgsrc through cwrappers.
-</p>
-<p>
-More details can be found here:
-</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
-<a class="ulink" href="https://www.redhat.com/en/blog/hardening-elf-binaries-using-relocation-read-only-relro"; target="_top">Hardening ELF binaries using Relocation Read-Only (RELRO)</a>
-</p></li></ul></div>
-</div>
-<div class="sect3">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.3. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
+<a name="hardening.mechanisms.disabled.stackcheck"></a>B.1.2.2. PKGSRC_USE_STACK_CHECK</h4></div></div></div>
<p>
This uses <code class="literal">-fstack-check</code> with GCC for
another stack protection mitigation.
diff -r 53fd1de9ac98 -r c9dbebcb789f doc/pkgsrc.txt
--- a/doc/pkgsrc.txt Sun Feb 13 11:16:35 2022 +0000
+++ b/doc/pkgsrc.txt Sun Feb 13 11:16:54 2022 +0000
@@ -205,10 +205,9 @@
14.1. Common types of packages
- 14.1.1. Perl modules
- 14.1.2. Python modules and programs
- 14.1.3. R packages
- 14.1.4. TeXlive packages
+ 14.1.1. Python modules and programs
+ 14.1.2. R packages
+ 14.1.3. TeXlive packages
14.2. Examples
@@ -2731,10 +2730,9 @@
14.1. Common types of packages
- 14.1.1. Perl modules
- 14.1.2. Python modules and programs
- 14.1.3. R packages
- 14.1.4. TeXlive packages
+ 14.1.1. Python modules and programs
+ 14.1.2. R packages
+ 14.1.3. TeXlive packages
14.2. Examples
@@ -4215,10 +4213,9 @@
14.1. Common types of packages
- 14.1.1. Perl modules
- 14.1.2. Python modules and programs
- 14.1.3. R packages
- 14.1.4. TeXlive packages
+ 14.1.1. Python modules and programs
+ 14.1.2. R packages
+ 14.1.3. TeXlive packages
14.2. Examples
Home |
Main Index |
Thread Index |
Old Index