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/2a426397b712
branches:  trunk
changeset: 449319:2a426397b712
user:      gdt <gdt%pkgsrc.org@localhost>
date:      Fri Mar 26 17:40:36 2021 +0000

description:
doc/pkgsrc.*: regen

diffstat:

 doc/pkgsrc.html |  2193 +++++++++++++++++++++++++++---------------------------
 doc/pkgsrc.txt  |  1501 +++++++++++++++++++------------------
 2 files changed, 1874 insertions(+), 1820 deletions(-)

diffs (truncated from 4878 to 300 lines):

diff -r 5f10f6034593 -r 2a426397b712 doc/pkgsrc.html
--- a/doc/pkgsrc.html   Fri Mar 26 13:15:05 2021 +0000
+++ b/doc/pkgsrc.html   Fri Mar 26 17:40:36 2021 +0000
@@ -1765,7 +1765,7 @@
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
                 By default, binary packages of built packages are
                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
                this variable to "no" prevents this.</p></li></ul></div>
@@ -3876,10 +3876,29 @@
 <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
 <dd>
 <p>This file is displayed after installation of the package.
-           Useful for things like legal notices on almost-free
-           software and hints for updating config files after
-           installing modules for apache, PHP etc.
-           Please note that you can modify variables in it easily by using
+           While this was used often in the past, it has two
+           problems: the display will be missed if many packages are
+           intalled at once, and the person installing the package
+           and the one using or configuring it may be different.  It
+           should therefore be used only in exceptional circumstances
+           where lasting negative consequences would result from
+           someone not reading it.</p>
+<p>MESSAGE should not be used for:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>exhortations to read the documentation</p></li>
+<li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
+<li class="listitem"><p>anything that should be explained in the
+             installation/configuration documentation that should
+             come with the package</p></li>
+</ul></div>
+<p>If the documentation provided by upstream needs
+           enhancing, create e.g. files/README.pkgsrc and install it.        
+           </p>
+<p>Note that MESSAGE is shown for all operating
+           systems and all init systems.  If a MESSAGE is necessary,
+           it sbould be narrowed to only those operating systems and
+           init systems to which it applies.</p>
+<p>Note that you can modify variables in it easily by using
            <code class="varname">MESSAGE_SUBST</code> in the package's
            <code class="filename">Makefile</code>:</p>
 <pre class="programlisting">
@@ -11211,6 +11230,10 @@
 <td>BDB_TYPE</td>
 </tr>
 <tr>
+<td>BINCIMAP_GROUP</td>
+<td>BINCIMAP_USER</td>
+</tr>
+<tr>
 <td>BIND_DIR</td>
 <td>BIND_GROUP</td>
 </tr>
@@ -11819,1092 +11842,1096 @@
 <td>GEM_PATH</td>
 </tr>
 <tr>
+<td>GEM_PLUGINSDIR</td>
 <td>GEM_SPECFILE</td>
+</tr>
+<tr>
 <td>GENERATE_PLIST</td>
-</tr>
-<tr>
 <td>GHOSTSCRIPT_REQD</td>
+</tr>
+<tr>
 <td>GITHUB_PROJECT</td>
-</tr>
-<tr>
 <td>GITHUB_RELEASE</td>
+</tr>
+<tr>
 <td>GITHUB_TAG</td>
-</tr>
-<tr>
 <td>GITHUB_TYPE</td>
+</tr>
+<tr>
 <td>GITLAB_PROJECT</td>
-</tr>
-<tr>
 <td>GITLAB_TAG</td>
+</tr>
+<tr>
 <td>GITLAB_TYPE</td>
-</tr>
-<tr>
 <td>GIT_BRANCH</td>
+</tr>
+<tr>
 <td>GIT_ENV</td>
-</tr>
-<tr>
 <td>GIT_EXTRACTDIR</td>
+</tr>
+<tr>
 <td>GIT_REPO</td>
-</tr>
-<tr>
 <td>GIT_REPOSITORIES</td>
+</tr>
+<tr>
 <td>GIT_REVISION</td>
-</tr>
-<tr>
 <td>GIT_TAG</td>
+</tr>
+<tr>
 <td>GNU</td>
-</tr>
-<tr>
 <td>GNU_CONFIGURE</td>
+</tr>
+<tr>
 <td>GNU_CONFIGURE_INFODIR</td>
-</tr>
-<tr>
 <td>GNU_CONFIGURE_MANDIR</td>
+</tr>
+<tr>
 <td>GNU_CONFIGURE_QUIET</td>
-</tr>
-<tr>
 <td>GNU_CONFIGURE_STRICT</td>
+</tr>
+<tr>
 <td>GODEP_REDIRECTS</td>
-</tr>
-<tr>
 <td>GO_BUILD_PATTERN</td>
+</tr>
+<tr>
 <td>GO_DEPS</td>
-</tr>
-<tr>
 <td>GO_DIST_BASE</td>
+</tr>
+<tr>
 <td>GO_MODULE_FILES</td>
-</tr>
-<tr>
 <td>GO_SRCPATH</td>
+</tr>
+<tr>
 <td>GO_VERSION_DEFAULT</td>
-</tr>
-<tr>
 <td>GROUP_SPECIFIC_PKGS</td>
+</tr>
+<tr>
 <td>GRUB_NETWORK_CARDS</td>
-</tr>
-<tr>
 <td>GRUB_PRESET_COMMAND</td>
+</tr>
+<tr>
 <td>GRUB_SCAN_ARGS</td>
-</tr>
-<tr>
 <td>GZIP</td>
+</tr>
+<tr>
 <td>HASKELL_COMPILER</td>
-</tr>
-<tr>
 <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
+</tr>
+<tr>
 <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
-</tr>
-<tr>
 <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
+</tr>
+<tr>
 <td>HASKELL_OPTIMIZATION_LEVEL</td>
-</tr>
-<tr>
 <td>HAS_CONFIGURE</td>
+</tr>
+<tr>
 <td>HEADER_TEMPLATES</td>
-</tr>
-<tr>
 <td>HG_REPO</td>
+</tr>
+<tr>
 <td>HG_REPOSITORIES</td>
-</tr>
-<tr>
 <td>HG_TAG</td>
+</tr>
+<tr>
 <td>HOMEPAGE</td>
-</tr>
-<tr>
 <td>HOST_PKGTOOLS_ARGS</td>
+</tr>
+<tr>
 <td>HOST_SPECIFIC_PKGS</td>
-</tr>
-<tr>
 <td>HOWL_GROUP</td>
+</tr>
+<tr>
 <td>HOWL_USER</td>
-</tr>
-<tr>
 <td>ICCBASE</td>
+</tr>
+<tr>
 <td>ICECAST_CHROOTDIR</td>
-</tr>
-<tr>
 <td>ICON_THEMES</td>
+</tr>
+<tr>
 <td>IDOBASE</td>
-</tr>
-<tr>
 <td>IGNORE_CCACHE</td>
+</tr>
+<tr>
 <td>IGNORE_INFO_DIRS</td>
-</tr>
-<tr>
 <td>IGNORE_INTERACTIVE_FETCH</td>
+</tr>
+<tr>
 <td>IMAKE</td>
-</tr>
-<tr>
 <td>IMAKEOPTS</td>
+</tr>
+<tr>
 <td>IMAKE_MAKE</td>
-</tr>
-<tr>
 <td>IMAKE_MANINSTALL</td>
+</tr>
+<tr>
 <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
-</tr>
-<tr>
 <td>IMDICTDIR</td>
+</tr>
+<tr>
 <td>INCOMPAT_CURSES</td>
-</tr>
-<tr>
 <td>INFO_DIR</td>
+</tr>
+<tr>
 <td>INFO_FILES</td>
-</tr>
-<tr>
 <td>INFO_FILES_VERBOSE</td>
+</tr>
+<tr>
 <td>INFO_MSG</td>
-</tr>
-<tr>
 <td>INIT_SYSTEM</td>
+</tr>
+<tr>
 <td>INN_DATA_DIR</td>
-</tr>
-<tr>
 <td>INN_GROUP</td>
+</tr>
+<tr>
 <td>INN_USER</td>
-</tr>
-<tr>
 <td>INSTALLATION_DIRS</td>
+</tr>
+<tr>
 <td>INSTALLATION_DIRS_FROM_PLIST</td>
-</tr>
-<tr>
 <td>INSTALL_ENV</td>
+</tr>
+<tr>
 <td>INSTALL_SH_OVERRIDE</td>
-</tr>
-<tr>
 <td>INSTALL_SRC</td>
+</tr>
+<tr>
 <td>INSTALL_TEMPLATES</td>
-</tr>
-<tr>
 <td>INSTALL_UNSTRIPPED</td>
+</tr>
+<tr>
 <td>IRCD_HYBRID_IRC_GROUP</td>



Home | Main Index | Thread Index | Old Index