pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc regen
details: https://anonhg.NetBSD.org/pkgsrc/rev/fec4b8a6b2f0
branches: trunk
changeset: 348285:fec4b8a6b2f0
user: rillig <rillig%pkgsrc.org@localhost>
date: Sat Jun 11 15:00:45 2016 +0000
description:
regen
diffstat:
doc/pkgsrc.html | 325 ++++++++++++++++++-------------------------------------
doc/pkgsrc.txt | 230 ++++++++++++---------------------------
2 files changed, 179 insertions(+), 376 deletions(-)
diffs (truncated from 1149 to 300 lines):
diff -r d661bbc031ba -r fec4b8a6b2f0 doc/pkgsrc.html
--- a/doc/pkgsrc.html Sat Jun 11 14:58:26 2016 +0000
+++ b/doc/pkgsrc.html Sat Jun 11 15:00:45 2016 +0000
@@ -102,7 +102,6 @@
<dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
<dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
<dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
-<dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
<dd><dl>
@@ -184,7 +183,7 @@
<dd><dl>
<dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
<dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
-<dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
+<dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
<dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
@@ -210,10 +209,8 @@
<dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
-<dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
-<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
-<dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
-<dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
+<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
+<dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
@@ -420,19 +417,15 @@
</dl></dd>
<dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
<dd><dl>
-<dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
-<dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
-<dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
-<dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
+<dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
+<dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
+<dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
-<dd><dl>
-<dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
-<dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
-</dl></dd>
+<dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
</dl></dd>
<dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
<dd><dl>
@@ -517,7 +510,7 @@
<li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html"; target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
Desktop Environment</p></li>
</ul></div>
-<p>...just to name a few.</p>
+<p>… just to name a few.</p>
<p>pkgsrc has built-in support for handling varying dependencies,
such as pthreads and X11, and extended features such as IPv6 support on
a range of platforms.</p>
@@ -858,7 +851,6 @@
<dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
<dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
<dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
-<dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
<dd><dl>
@@ -1188,7 +1180,6 @@
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
-<p>Here are some platform-specific notes you should be aware of.</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
@@ -1702,7 +1693,6 @@
<dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
<dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
<dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
-<dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
<dd><dl>
@@ -1899,21 +1889,6 @@
<p>The <span class="command"><strong>pkg_admin</strong></span> executes various
administrative functions on the package system.</p>
</div>
-<div class="sect2">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
-<p>Please pay very careful attention to the warnings
- expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386";><span class="citerefentry"><span
class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
- inherent dangers of installing binary packages which you did
- not create yourself, and the security holes that can be
- introduced onto your system by indiscriminate adding of such
- files.</p>
-<p>The same warning of course applies to every package you
- install from source when you haven't completely read and
- understood the source code of the package, the compiler that
- is used to build the package and all the other tools that are
- involved.</p>
-</div>
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -2215,7 +2190,7 @@
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
-<p>XXX
+<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
@@ -2235,7 +2210,7 @@
pkgsrc tree instances.)</p></li>
<li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
Directory for local patches that aren't part of pkgsrc.
- See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
+ See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a> for more
information.</p></li>
<li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
@@ -3016,23 +2991,14 @@
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
-<p>If you want to use pkgsrc as non-root user, you can set some
-variables to make pkgsrc work under these conditions. At the very least,
-you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
-will turn on unprivileged mode and set multiple related variables to allow
-installation of packages as non-root.</p>
-<p>In case the defaults are not enough, you may want to tune some other
-variables used. For example, if the automatic user/group detection leads
-to incorrect values (or not the ones you would like to use), you can change
-them by setting <code class="varname">UNPRIVILEGED_USER</code> and
-<code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
-<p>As regards bootstrapping, please note that the
-<span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
-given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
-use multiple default directories under <code class="filename">~/pkg</code> as the
-installation targets. These directories can be overridden by the
-<span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
-that allow finer tuning of the tree layout.</p>
+<p>To install packages from source as a non-root user, download
+pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>,
cd into that
+directory and run the command <span class="command"><strong>./bootstrap/bootstrap
+--unprivileged</strong></span>.</p>
+<p>This will install the binary part of pkgsrc to
+<code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
+into <code class="filename">~/pkg/etc</code>.</p>
+<p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -3342,7 +3308,7 @@
<dd><dl>
<dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
<dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
-<dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
+<dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
<dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
@@ -3368,10 +3334,8 @@
<dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
-<dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
-<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
-<dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
-<dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
+<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
+<dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
@@ -3963,7 +3927,7 @@
<dl class="toc">
<dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
<dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
-<dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
+<dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
<dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
@@ -4135,15 +4099,14 @@
digest, or checksum, of each distfile needed for the package. This
ensures that the distfiles retrieved from the Internet have not been
corrupted during transfer or altered by a malign force to introduce
- a security hole. Due to recent rumor about weaknesses of digest
- algorithms, all distfiles are protected using both SHA1 and RMD160
- message digests, as well as the file size.</p>
+ a security hole. To provide maximum security, all distfiles are
+ protected using three different message digest algorithms (SHA1,
+ RMD160, SHA512), as well as the file size.</p>
<p>The <code class="filename">distinfo</code> file also contains the
checksums for all the patches found in the
- <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
+ <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “<code class="filename">patches/*</code>”</a>).</p>
<p>To regenerate the <code class="filename">distinfo</code> file, use the
- <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
- command.</p>
+ <span class="command"><strong>make distinfo</strong></span> command.</p>
<p>Some packages have different sets of distfiles depending on
the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html"; target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the
same
<code class="filename">distinfo</code> file and care should be taken when
@@ -4152,15 +4115,15 @@
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
-<p>Many packages still don't work out-of-the box on the various
- platforms that are supported by pkgsrc. Therefore, a number of custom
- patch files are needed to make the package work. These patch files are
+<a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
+</h2></div></div></div>
+<p>Some packages don't work out-of-the box on the various
+ platforms that are supported by pkgsrc. These packages need
+ to be patched to make them work. The patch files can be
found in the <code class="filename">patches/</code> directory.</p>
<p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
applied to the files in <code class="varname">WRKSRC</code> directory after
- extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03"; target="_top">alphabetic
- order</a>.</p>
+ extracting them, in alphabetic order.</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
@@ -4183,7 +4146,7 @@
platform and other environment (for example, the compiler) that the
patch is needed for.</p></li>
</ul></div>
-<p>In all, the patch should be commented so that any
+<p>The patch should be commented so that any
developer who knows the code of the application can make some use of
the patch. Special care should be taken for the upstream developers,
since we generally want that they accept our patches, so we have less
@@ -4574,10 +4537,8 @@
<dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
-<dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
-<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
-<dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
-<dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
+<dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
+<dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
</dl></dd>
</dl>
</div>
@@ -4646,24 +4607,14 @@
passed as is. In a variable assignment, any hash character that is
not preceded by a backslash starts a comment that continues upto the
end of the logical line.</p>
-<p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
- the only way to create a variable consisting of a single backslash
- is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
-<p>So far for defining variables. The other thing you can do with
- variables is evaluating them. A variable is evaluated when it is
- part of the right side of the ``:='' or the ``!='' operator, or
- directly before executing a shell command which the variable is part
- of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386";><span class="citerefentry"><span
class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
- is, variables are not evaluated until there's no other way. The
- ``modifiers'' mentioned in the man page also evaluate the
- variable.</p>
+<p>The evaluation of variables either happens immediately or lazy.
+ It happens immediately when the variable occurs
+ on the right-hand side of the ``:='' or the ``!='' operator, in a
+ <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
+ In the other cases, it is evaluated lazily.</p>
<p>Some of the modifiers split the string into words and then
operate on the words, others operate on the string as a whole. When
- a string is split into words, it is split as you would expect
- it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386";><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
-<p>No rule without exception—the <span class="command"><strong>.for</strong></span>
- loop does not follow the shell quoting rules but splits at sequences
- of whitespace.</p>
+ a string is split into words, it is split like in <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386";><span class="citerefentry"><span
class="refentrytitle">sh</span>(1)</span></a>.</p>
<p>There are several types of variables that should be handled
differently. Strings and two types of lists.</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
@@ -4732,66 +4683,32 @@
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
-<a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
-<pre class="programlisting">
-EXT_LIST= # empty
-.for i in ${INT_LIST}
-EXT_LIST+= ${i:Q}""
Home |
Main Index |
Thread Index |
Old Index