Document where documentation should be installed.

1 files changed, 72 insertions, 41 deletions

diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html
index e113fa3f7ea..b85beaeb3a5 100644
--- a/doc/pkgsrc.html
+++ b/doc/pkgsrc.html
@@ -591,41 +591,45 @@ alink="#0000FF">
                     /etc/mk.conf</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#restricted-packages">13.1.2. Restricted
+                    "#where-to-install-documentation">13.1.2. Where
+                    to install documentation</a></span></dt>
+
+                    <dt><span class="sect2"><a href=
+                    "#restricted-packages">13.1.3. Restricted
                     packages</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#dependencies">13.1.3. Handling
+                    "#dependencies">13.1.4. Handling
                     dependencies</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#conflicts">13.1.4. Handling conflicts with
+                    "#conflicts">13.1.5. Handling conflicts with
                     other packages</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#not-building-packages">13.1.5. Packages that
+                    "#not-building-packages">13.1.6. Packages that
                     cannot or should not be built</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#undeletable-packages">13.1.6. Packages which
+                    "#undeletable-packages">13.1.7. Packages which
                     should not be deleted, once
                     installed</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#security-handling">13.1.7. Handling packages
+                    "#security-handling">13.1.8. Handling packages
                     with security problems</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#compiler-bugs">13.1.8. How to handle compiler
+                    "#compiler-bugs">13.1.9. How to handle compiler
                     bugs</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#bumping-pkgrevision">13.1.9. How to handle
+                    "#bumping-pkgrevision">13.1.10. How to handle
                     incrementing versions when fixing an existing
                     package</a></span></dt>
 
                     <dt><span class="sect2"><a href=
-                    "#portability-of-packages">13.1.10. Portability
+                    "#portability-of-packages">13.1.11. Portability
                     of packages</a></span></dt>
                   </dl>
                 </dd>
@@ -5117,41 +5121,45 @@ CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   /etc/mk.conf</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#restricted-packages">13.1.2. Restricted
+                  "#where-to-install-documentation">13.1.2. Where
+                  to install documentation</a></span></dt>
+
+                  <dt><span class="sect2"><a href=
+                  "#restricted-packages">13.1.3. Restricted
                   packages</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#dependencies">13.1.3. Handling
+                  "#dependencies">13.1.4. Handling
                   dependencies</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#conflicts">13.1.4. Handling conflicts with
+                  "#conflicts">13.1.5. Handling conflicts with
                   other packages</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#not-building-packages">13.1.5. Packages that
+                  "#not-building-packages">13.1.6. Packages that
                   cannot or should not be built</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#undeletable-packages">13.1.6. Packages which
+                  "#undeletable-packages">13.1.7. Packages which
                   should not be deleted, once
                   installed</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#security-handling">13.1.7. Handling packages
+                  "#security-handling">13.1.8. Handling packages
                   with security problems</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#compiler-bugs">13.1.8. How to handle compiler
+                  "#compiler-bugs">13.1.9. How to handle compiler
                   bugs</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#bumping-pkgrevision">13.1.9. How to handle
+                  "#bumping-pkgrevision">13.1.10. How to handle
                   incrementing versions when fixing an existing
                   package</a></span></dt>
 
                   <dt><span class="sect2"><a href=
-                  "#portability-of-packages">13.1.10. Portability
+                  "#portability-of-packages">13.1.11. Portability
                   of packages</a></span></dt>
                 </dl>
               </dd>
@@ -7507,8 +7515,8 @@ BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
             want to cause unneeded package deletions and rebuilds.
             In many cases, new versions of packages work just fine
             with older dependencies. See <a href="#dependencies"
-            title="13.1.3.&nbsp;Handling dependencies">Section
-            13.1.3, &#8220;Handling dependencies&#8221;</a> and
+            title="13.1.4.&nbsp;Handling dependencies">Section
+            13.1.4, &#8220;Handling dependencies&#8221;</a> and
             <a href="#buildlink" title=
             "Chapter&nbsp;10.&nbsp;Buildlink methodology">Chapter
             10, <i>Buildlink methodology</i></a> for more
@@ -8956,41 +8964,45 @@ make build
                 pull in variables from /etc/mk.conf</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#restricted-packages">13.1.2. Restricted
+                "#where-to-install-documentation">13.1.2. Where to
+                install documentation</a></span></dt>
+
+                <dt><span class="sect2"><a href=
+                "#restricted-packages">13.1.3. Restricted
                 packages</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#dependencies">13.1.3. Handling
+                "#dependencies">13.1.4. Handling
                 dependencies</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#conflicts">13.1.4. Handling conflicts with other
+                "#conflicts">13.1.5. Handling conflicts with other
                 packages</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#not-building-packages">13.1.5. Packages that
+                "#not-building-packages">13.1.6. Packages that
                 cannot or should not be built</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#undeletable-packages">13.1.6. Packages which
+                "#undeletable-packages">13.1.7. Packages which
                 should not be deleted, once
                 installed</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#security-handling">13.1.7. Handling packages with
+                "#security-handling">13.1.8. Handling packages with
                 security problems</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#compiler-bugs">13.1.8. How to handle compiler
+                "#compiler-bugs">13.1.9. How to handle compiler
                 bugs</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#bumping-pkgrevision">13.1.9. How to handle
+                "#bumping-pkgrevision">13.1.10. How to handle
                 incrementing versions when fixing an existing
                 package</a></span></dt>
 
                 <dt><span class="sect2"><a href=
-                "#portability-of-packages">13.1.10. Portability of
+                "#portability-of-packages">13.1.11. Portability of
                 packages</a></span></dt>
               </dl>
             </dd>
@@ -9209,9 +9221,28 @@ CFLAGS+=  -your -flags
             <div class="titlepage">
               <div>
                 <div>
+                  <h3 class="title"><a name=
+                  "where-to-install-documentation" id=
+                  "where-to-install-documentation"></a>13.1.2.&nbsp;Where
+                  to install documentation</h3>
+                </div>
+              </div>
+            </div>
+
+            <p>Documentation should be installed into <code class=
+            "filename">${PREFIX}/share/doc/${PKGBASE}</code> or
+            <code class=
+            "filename">${PREFIX}/share/doc/${PKGNAME}</code> (the
+            latter includes the version number of the package).</p>
+          </div>
+
+          <div class="sect2" lang="en" xml:lang="en">
+            <div class="titlepage">
+              <div>
+                <div>
                   <h3 class="title"><a name="restricted-packages"
                   id=
-                  "restricted-packages"></a>13.1.2.&nbsp;Restricted
+                  "restricted-packages"></a>13.1.3.&nbsp;Restricted
                   packages</h3>
                 </div>
               </div>
@@ -9290,7 +9321,7 @@ CFLAGS+=  -your -flags
               <div>
                 <div>
                   <h3 class="title"><a name="dependencies" id=
-                  "dependencies"></a>13.1.3.&nbsp;Handling
+                  "dependencies"></a>13.1.4.&nbsp;Handling
                   dependencies</h3>
                 </div>
               </div>
@@ -9443,8 +9474,8 @@ RECOMMENDED+=   tiff&gt;=3.6.1:../../graphics/tiff
                   vulnerabilities file as well as setting
                   <code class="varname">RECOMMENDED</code>, see
                   <a href="#security-handling" title=
-                  "13.1.7.&nbsp;Handling packages with security problems">
-                  Section 13.1.7, &#8220;Handling packages with
+                  "13.1.8.&nbsp;Handling packages with security problems">
+                  Section 13.1.8, &#8220;Handling packages with
                   security problems&#8221;</a> for more
                   information.</p>
                 </li>
@@ -9519,7 +9550,7 @@ pre-clean:
               <div>
                 <div>
                   <h3 class="title"><a name="conflicts" id=
-                  "conflicts"></a>13.1.4.&nbsp;Handling conflicts
+                  "conflicts"></a>13.1.5.&nbsp;Handling conflicts
                   with other packages</h3>
                 </div>
               </div>
@@ -9568,7 +9599,7 @@ CONFLICTS=      Xaw3d-[0-9]*
                 <div>
                   <h3 class="title"><a name="not-building-packages"
                   id=
-                  "not-building-packages"></a>13.1.5.&nbsp;Packages
+                  "not-building-packages"></a>13.1.6.&nbsp;Packages
                   that cannot or should not be built</h3>
                 </div>
               </div>
@@ -9601,7 +9632,7 @@ CONFLICTS=      Xaw3d-[0-9]*
                 <div>
                   <h3 class="title"><a name="undeletable-packages"
                   id=
-                  "undeletable-packages"></a>13.1.6.&nbsp;Packages
+                  "undeletable-packages"></a>13.1.7.&nbsp;Packages
                   which should not be deleted, once installed</h3>
                 </div>
               </div>
@@ -9626,7 +9657,7 @@ CONFLICTS=      Xaw3d-[0-9]*
               <div>
                 <div>
                   <h3 class="title"><a name="security-handling" id=
-                  "security-handling"></a>13.1.7.&nbsp;Handling
+                  "security-handling"></a>13.1.8.&nbsp;Handling
                   packages with security problems</h3>
                 </div>
               </div>
@@ -9665,7 +9696,7 @@ CONFLICTS=      Xaw3d-[0-9]*
               <div>
                 <div>
                   <h3 class="title"><a name="compiler-bugs" id=
-                  "compiler-bugs"></a>13.1.8.&nbsp;How to handle
+                  "compiler-bugs"></a>13.1.9.&nbsp;How to handle
                   compiler bugs</h3>
                 </div>
               </div>
@@ -9691,7 +9722,7 @@ CONFLICTS=      Xaw3d-[0-9]*
               <div>
                 <div>
                   <h3 class="title"><a name="bumping-pkgrevision"
-                  id="bumping-pkgrevision"></a>13.1.9.&nbsp;How to
+                  id="bumping-pkgrevision"></a>13.1.10.&nbsp;How to
                   handle incrementing versions when fixing an
                   existing package</h3>
                 </div>
@@ -9733,7 +9764,7 @@ DISTNAME=   foo-17.43
                 <div>
                   <h3 class="title"><a name=
                   "portability-of-packages" id=
-                  "portability-of-packages"></a>13.1.10.&nbsp;Portability
+                  "portability-of-packages"></a>13.1.11.&nbsp;Portability
                   of packages</h3>
                 </div>
               </div>
@@ -9750,7 +9781,7 @@ DISTNAME=   foo-17.43
                 <div>
                   <div>
                     <h4 class="title"><a name="install-scripts" id=
-                    "install-scripts"></a>13.1.10.1.&nbsp;${INSTALL},
+                    "install-scripts"></a>13.1.11.1.&nbsp;${INSTALL},
                     ${INSTALL_DATA_DIR}, ...</h4>
                   </div>
                 </div>