[pkgsrc/trunk]: pkgsrc/doc doc/pkgsrc.*: regen

[leot <leot%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/dfde181ae5fb
branches:  trunk
changeset: 317092:dfde181ae5fb
user:      leot <leot%pkgsrc.org@localhost>
date:      Sun Dec 30 23:26:35 2018 +0000

description:
doc/pkgsrc.*: regen

diffstat:

 doc/pkgsrc.html |  39 ++++++++++++++++++++++-----------------
 doc/pkgsrc.txt  |  16 ++++++++++------
 2 files changed, 32 insertions(+), 23 deletions(-)

diffs (207 lines):

diff -r a24afd8c703f -r dfde181ae5fb doc/pkgsrc.html
--- a/doc/pkgsrc.html   Sun Dec 30 23:24:19 2018 +0000
+++ b/doc/pkgsrc.html   Sun Dec 30 23:26:35 2018 +0000
@@ -927,7 +927,7 @@
        quarterly basis from the current branch and only gets modified
        for security updates. The names of the stable branches are built
        from the year and the quarter, for example
-       <code class="literal">2018Q3</code>.</p>
+       <code class="literal">2018Q4</code>.</p>
 <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
        want to download pkgsrc. You can get it as a tar file or via CVS.
        Both ways are described here.</p>
@@ -953,11 +953,11 @@
        respectively.
        </p>
 <p>You can fetch the same files using FTP.</p>
-<p>The tar file for the stable branch 2018Q3 is in the
-       directory <code class="filename">pkgsrc-2018Q3</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q3/pkgsrc.tar.gz"; target="_top"><code 
class="filename">pkgsrc.tar.gz</code></a>.</p>
+<p>The tar file for the stable branch 2018Q4 is in the
+       directory <code class="filename">pkgsrc-2018Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz"; target="_top"><code 
class="filename">pkgsrc.tar.gz</code></a>.</p>
 <p>To download the latest pkgsrc stable tarball, run:</p>
 <pre class="screen">
-<code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q3/pkgsrc.tar.gz</code></strong></pre>
+<code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz</code></strong></pre>
 <p>If you prefer, you can also fetch it using "wget", "curl",
        or your web browser.</p>
 <p>Then, extract it with:</p>
@@ -972,7 +972,7 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
 <p>To fetch a specific pkgsrc stable branch, run:</p>
-<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r pkgsrc-2018Q3 -P 
pkgsrc</code></strong>
+<pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r pkgsrc-2018Q4 -P 
pkgsrc</code></strong>
 </pre>
 <p>This will create the directory <code class="filename">pkgsrc/</code> 
        in your <code class="filename">/usr/</code> directory and all the package source 
@@ -1057,7 +1057,7 @@
        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
        back to the stable branch, add the
-       <span class="quote">&#8220;<span class="quote">-rpkgsrc-2018Q3</span>&#8221;</span> option.</p>
+       <span class="quote">&#8220;<span class="quote">-rpkgsrc-2018Q4</span>&#8221;</span> option.</p>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
@@ -3562,7 +3562,12 @@
   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, &#8220;<code class="filename">patches/*</code>&#8221;</a>).</p>
+  <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>). 
These checksums ensure that patches
+  are only applied intentionally and that they don't accidentally change,
+  e.g. when merging different changes together. They also make sure that
+  new patches are actually added to CVS and old ones are removed.
+  Too see whether the patches and the <code class="filename">distinfo</code> file
+  match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
 <p>To regenerate the <code class="filename">distinfo</code> file, use the
   <span class="command"><strong>make distinfo</strong></span> command.</p>
 <p>Some packages have different sets of distfiles depending on
@@ -8835,7 +8840,7 @@
        and if you still don't have the answer, ask on the
        <code class="literal">pkgsrc-users</code> mailing list.</p>
 <div class="qandaset">
-<a name="idm79184080"></a><dl>
+<a name="idm80162000"></a><dl>
 <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
        MAKEFLAGS, .MAKEFLAGS and
        MAKE_FLAGS?</a>
@@ -8880,7 +8885,7 @@
 <tbody>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.makeflags"></a><a name="idm79183696"></a><p><b>22.1.</b></p>
+<a name="devfaq.makeflags"></a><a name="idm80161616"></a><p><b>22.1.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
@@ -8896,7 +8901,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.make"></a><a name="idm79179600"></a><p><b>22.2.</b></p>
+<a name="devfaq.make"></a><a name="idm80157520"></a><p><b>22.2.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
@@ -8914,7 +8919,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.cc"></a><a name="idm79175248"></a><p><b>22.3.</b></p>
+<a name="devfaq.cc"></a><a name="idm80153168"></a><p><b>22.3.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
@@ -8932,7 +8937,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3flags"></a><a name="idm79171024"></a><p><b>22.4.</b></p>
+<a name="devfaq.bl3flags"></a><a name="idm80148944"></a><p><b>22.4.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
        <code class="varname">BUILDLINK_LDFLAGS</code>,
@@ -8945,7 +8950,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3prefix"></a><a name="idm79168848"></a><p><b>22.5.</b></p>
+<a name="devfaq.bl3prefix"></a><a name="idm80146768"></a><p><b>22.5.</b></p>
 </td>
 <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
@@ -8961,7 +8966,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.master_sites"></a><a name="idm79165776"></a><p><b>22.6.</b></p>
+<a name="devfaq.master_sites"></a><a name="idm80143568"></a><p><b>22.6.</b></p>
 </td>
 <td align="left" valign="top"><p>What does
        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
@@ -8985,7 +8990,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.mailinglists"></a><a name="idm79158864"></a><p><b>22.7.</b></p>
+<a name="devfaq.mailinglists"></a><a name="idm80136784"></a><p><b>22.7.</b></p>
 </td>
 <td align="left" valign="top"><p>Which mailing lists are there for package
        developers?</p></td>
@@ -9010,7 +9015,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.documentation"></a><a name="idm79155024"></a><p><b>22.8.</b></p>
+<a name="devfaq.documentation"></a><a name="idm80132944"></a><p><b>22.8.</b></p>
 </td>
 <td align="left" valign="top"><p>Where is the pkgsrc
        documentation?</p></td>
@@ -9058,7 +9063,7 @@
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.too-much-time"></a><a name="idm79148624"></a><p><b>22.9.</b></p>
+<a name="devfaq.too-much-time"></a><a name="idm80110032"></a><p><b>22.9.</b></p>
 </td>
 <td align="left" valign="top"><p>I have a little time to kill.  What shall I
 do?</p></td>
diff -r a24afd8c703f -r dfde181ae5fb doc/pkgsrc.txt
--- a/doc/pkgsrc.txt    Sun Dec 30 23:24:19 2018 +0000
+++ b/doc/pkgsrc.txt    Sun Dec 30 23:26:35 2018 +0000
@@ -799,7 +799,7 @@
 current branch or the stable branch. The latter is forked on a quarterly basis
 from the current branch and only gets modified for security updates. The names
 of the stable branches are built from the year and the quarter, for example
-2018Q3.
+2018Q4.
 
 The second step is to decide how you want to download pkgsrc. You can get it as
 a tar file or via CVS. Both ways are described here.
@@ -822,12 +822,12 @@
 
 You can fetch the same files using FTP.
 
-The tar file for the stable branch 2018Q3 is in the directory pkgsrc-2018Q3 and
+The tar file for the stable branch 2018Q4 is in the directory pkgsrc-2018Q4 and
 is also called pkgsrc.tar.gz.
 
 To download the latest pkgsrc stable tarball, run:
 
-$ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q3/pkgsrc.tar.gz
+$ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2018Q4/pkgsrc.tar.gz
 
 If you prefer, you can also fetch it using "wget", "curl", or your web browser.
 
@@ -846,7 +846,7 @@
 
 To fetch a specific pkgsrc stable branch, run:
 
-$ cd /usr && cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r pkgsrc-2018Q3 -P pkgsrc
+$ cd /usr && cvs -q -z2 -d anoncvs%anoncvs.NetBSD.org@localhost:/cvsroot checkout -r pkgsrc-2018Q4 -P pkgsrc
 
 This will create the directory pkgsrc/ in your /usr/ directory and all the
 package source will be stored under /usr/pkgsrc/.
@@ -928,7 +928,7 @@
 But if you, for whatever reason, want to switch from the stable branch to the
 current one, you can do it by adding the option "-A" after the "update"
 keyword. To switch from the current branch back to the stable branch, add the "
--rpkgsrc-2018Q3" option.
+-rpkgsrc-2018Q4" option.
 
 2.2.2.2. What happens to my changes when updating?
 
@@ -3056,7 +3056,11 @@
 SHA512), as well as the file size.
 
 The distinfo file also contains the checksums for all the patches found in the
-patches directory (see Section 11.3, "patches/*").
+patches directory (see Section 11.3, "patches/*"). These checksums ensure that
+patches are only applied intentionally and that they don't accidentally change,
+e.g. when merging different changes together. They also make sure that new
+patches are actually added to CVS and old ones are removed. Too see whether the
+patches and the distinfo file match, run pkglint after changing the patches.
 
 To regenerate the distinfo file, use the make distinfo command.