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/04274864b80d
branches:  trunk
changeset: 457308:04274864b80d
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Sun Aug 22 16:28:53 2021 +0000

description:
doc/pkgsrc.*: regen

diffstat:

 doc/pkgsrc.html |  1628 +++++++++++++++++++++++++++++++-----------------------
 doc/pkgsrc.txt  |  1519 +++++++++++++++++++++++++++------------------------
 2 files changed, 1732 insertions(+), 1415 deletions(-)

diffs (truncated from 4165 to 300 lines):

diff -r 48c5328523a3 -r 04274864b80d doc/pkgsrc.html
--- a/doc/pkgsrc.html   Sun Aug 22 16:27:50 2021 +0000
+++ b/doc/pkgsrc.html   Sun Aug 22 16:28:53 2021 +0000
@@ -339,9 +339,10 @@
 <dd><dl>
 <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
 <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
-<dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
-<dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
-<dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
+<dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
+<dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
+<dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
+<dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 <dd><dl>
@@ -2206,7 +2207,12 @@
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>The <code class="filename">pbulk.sh</code> script supports running
-unprivileged bulk build and helps configuring distributed bulk builds.</p>
+unprivileged bulk build and helps configuring distributed bulk builds.
+Distributed bulk builds support either building in worker chroots
+(each node is a path to a different chroot)
+that replicate the target system, including the pbulk prefix,
+or remote machines (each node is
+an IP address that must be accessible over SSH without a password).</p>
 </div>
 </div>
 </div>
@@ -2218,8 +2224,8 @@
 remote filesystems (such as NFS) and some should be local. Some can be
 temporary filesystems, others must survive a sudden reboot.</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
-<li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
+<li class="listitem"><p>70 GB for the distfiles (read-write, remote, temporary)</p></li>
+<li class="listitem"><p>60 GB for the binary packages (read-write, remote, permanent)</p></li>
 <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
 <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
 <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
@@ -3279,9 +3285,10 @@
 <dd><dl>
 <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
 <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
-<dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
-<dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
-<dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
+<dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
+<dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
+<dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
+<dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 <dd><dl>
@@ -7276,9 +7283,10 @@
 <dd><dl>
 <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
 <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
-<dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
-<dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
-<dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
+<dt><span class="sect2"><a href="#go-programming-language">21.4.3. Go</a></span></dt>
+<dt><span class="sect2"><a href="#perl-scripts">21.4.4. Packages containing Perl scripts</a></span></dt>
+<dt><span class="sect2"><a href="#shell-scripts">21.4.5. Packages containing shell scripts</a></span></dt>
+<dt><span class="sect2"><a href="#other-programming-languages">21.4.6. Other programming languages</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 <dd><dl>
@@ -7765,8 +7773,34 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
 <p>When a vulnerability is found, this should be noted in
-    <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
-    and after committing that file, ask pkgsrc-security%NetBSD.org@localhost to
+    <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>.
+    Entries in that file consist of three parts:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>package version pattern</p></li>
+<li class="listitem"><p>type of vulnerability (please cut'n'paste an existing one where possible)</p></li>
+<li class="listitem"><p>URL providing additional information about the issue</p></li>
+</ul></div>
+<p>For the package version pattern please always use `&lt;' to
+    mark an upper bound (not `&lt;='!). This will avoid possible
+    problems due unrelated <code class="varname">PKGREVISION</code> bumps not
+    related to security fixes. Lower bounds can be added too, using
+    '&gt;' or '&gt;='. For example,
+    <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;'=1&lt;1.2</code></span>&#8221;</span> would mark
+    versions 1.0 (included) to 1.2 (excluded) of
+    <span class="quote">&#8220;<span class="quote"><code class="literal">foo</code></span>&#8221;</span> as affected by the security
+    issue.</p>
+<p>Entries should always be added at the bottom of the file.</p>
+<p>When fixing packages, please modify the upper bound of the
+    corresponding entry. To continue the previous example, if a fix
+    was backported to version 1.1nb2, change the previous pattern to
+    <span class="quote">&#8220;<span class="quote"><code class="literal">foo&gt;'=1&lt;1.1nb2</code></span>&#8221;</span>.</p>
+<p>To locally test a package version pattern against a
+    <code class="varname">PKGNAME</code> you can use the <span class="command"><strong>pkg_admin
+    pmatch</strong></span> command.</p>
+<p>The URL should be as permanent as possible and provide as
+    much information about the issue as possible.  CVE entries are
+    preferred.</p>
+<p>After committing that file, ask pkgsrc-security%NetBSD.org@localhost to
     update the file on ftp.NetBSD.org.</p>
 <p>After fixing the vulnerability by a patch, its
     <code class="varname">PKGREVISION</code> should be increased (this is of
@@ -7777,6 +7811,8 @@
     branch, be sure to submit a pullup request!</p>
 <p>Binary packages already on ftp.NetBSD.org will be handled
     semi-automatically by a weekly cron job.</p>
+<p>In case a security issue is disputed, please contact
+    pkgsrc-security%NetBSD.org@localhost.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
@@ -8459,7 +8495,31 @@
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="perl-scripts"></a>21.4.3. Packages containing Perl scripts</h3></div></div></div>
+<a name="go-programming-language"></a>21.4.3. Go</h3></div></div></div>
+<p>If a program is written in Go and has any dependencies on
+    other Go modules, have the package include
+    <code class="filename">../../lang/go/go-module.mk</code>.</p>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem"><p>Generate a list of those dependencies with
+      <span class="command"><strong>make clean &amp;&amp; make patch &amp;&amp; make show-go-modules &gt;
+      go-modules.mk</strong></span>.</p></li>
+<li class="listitem">
+<p>Prepend </p>
+<pre class="programlisting">.include
+      "go-modules.mk"</pre>
+<p> to any other
+      </p>
+<pre class="programlisting">.include</pre>
+<p>s.</p>
+</li>
+<li class="listitem"><p>Incorporate these modules in
+      <code class="filename">distinfo</code> with <span class="command"><strong>make
+      makesum</strong></span>.</p></li>
+</ol></div>
+</div>
+<div class="sect2">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="perl-scripts"></a>21.4.4. Packages containing Perl scripts</h3></div></div></div>
 <p>If your package contains interpreted Perl scripts, add
     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
@@ -8476,7 +8536,7 @@
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
+<a name="shell-scripts"></a>21.4.5. Packages containing shell scripts</h3></div></div></div>
 <p><code class="varname">REPLACE_SH</code>,
     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
@@ -8491,7 +8551,7 @@
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
+<a name="other-programming-languages"></a>21.4.6. Other programming languages</h3></div></div></div>
 <p>Currently, there is no special handling for other languages
     in pkgsrc.  If a compiler package provides a
     <code class="filename">buildlink3.mk</code> file, include that, otherwise
@@ -11069,23 +11129,27 @@
 <td>-lintl</td>
 </tr>
 <tr>
+<td>32bit</td>
 <td>64bit</td>
+</tr>
+<tr>
 <td>ABI</td>
-</tr>
-<tr>
 <td>ACCEPTABLE_LICENSES</td>
+</tr>
+<tr>
 <td>ACROREAD_FONTPATH</td>
-</tr>
-<tr>
 <td>ADDITIONAL</td>
+</tr>
+<tr>
 <td>AFAIK</td>
-</tr>
-<tr>
 <td>AIX</td>
+</tr>
+<tr>
 <td>ALLOW_VULNERABLE_PACKAGES</td>
-</tr>
-<tr>
 <td>ALL_ENV</td>
+</tr>
+<tr>
+<td>ALSA_PC</td>
 <td>ALTERNATIVES_SRC</td>
 </tr>
 <tr>
@@ -11157,7 +11221,15 @@
 <td>BISON_PKGDATADIR</td>
 </tr>
 <tr>
+<td>BLAS</td>
 <td>BLAS_ACCEPTED</td>
+</tr>
+<tr>
+<td>BLAS_C_INTERFACE</td>
+<td>BLAS_INCLUDES</td>
+</tr>
+<tr>
+<td>BLAS_INDEX64</td>
 <td>BLAS_LIBS</td>
 </tr>
 <tr>
@@ -11189,76 +11261,80 @@
 <td>BUILDLINK_CPPFLAGS</td>
 </tr>
 <tr>
+<td>BUILDLINK_DEPMETHOD</td>
 <td>BUILDLINK_FILES</td>
+</tr>
+<tr>
 <td>BUILDLINK_FILES_CMD</td>
-</tr>
-<tr>
 <td>BUILDLINK_FNAME_TRANSFORM</td>
+</tr>
+<tr>
 <td>BUILDLINK_LDFLAGS</td>
-</tr>
-<tr>
 <td>BUILDLINK_LIBS</td>
+</tr>
+<tr>
 <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
-</tr>
-<tr>
 <td>BUILDLINK_PKGNAME</td>
+</tr>
+<tr>
 <td>BUILDLINK_PREFIX</td>
-</tr>
-<tr>
 <td>BUILDLINK_RPATHDIRS</td>
+</tr>
+<tr>
 <td>BUILDLINK_TREE</td>
-</tr>
-<tr>
 <td>BUILD_DEFS</td>
+</tr>
+<tr>
 <td>BUILD_DEFS_EFFECTS</td>
-</tr>
-<tr>
 <td>BUILD_DEPENDS</td>
+</tr>
+<tr>
 <td>BUILD_DIRS</td>
-</tr>
-<tr>
 <td>BUILD_ENV_SHELL</td>
+</tr>
+<tr>
 <td>BUILD_MAKE_CMD</td>
-</tr>
-<tr>
 <td>BUILD_MAKE_FLAGS</td>
+</tr>
+<tr>
 <td>BUILD_TARGET</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_FILES</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_FILES_VAR</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_GREP</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_HEADERS</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_HEADERS_VAR</td>
+</tr>
+<tr>
 <td>BUILTIN_FIND_PKGCONFIG</td>
-</tr>
-<tr>
 <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
+</tr>
+<tr>
 <td>BUILTIN_PKG</td>
Home | Main Index | Thread Index | Old Index