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/dd1d1aa8f289
branches:  trunk
changeset: 635125:dd1d1aa8f289
user:      asau <asau%pkgsrc.org@localhost>
date:      Sat May 31 21:10:04 2014 +0000

description:
regen

diffstat:

 doc/pkgsrc.html |  637 ++++++++++---------------------------------------------
 doc/pkgsrc.txt  |  575 +++++++++-----------------------------------------
 2 files changed, 218 insertions(+), 994 deletions(-)

diffs (truncated from 1759 to 300 lines):

diff -r 5355c8c8f557 -r dd1d1aa8f289 doc/pkgsrc.html
--- a/doc/pkgsrc.html   Sat May 31 21:08:50 2014 +0000
+++ b/doc/pkgsrc.html   Sat May 31 21:10:04 2014 +0000
@@ -135,24 +135,13 @@
 <dd><dl>
 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
-<dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
-<dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
-<dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
-<dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
-<dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
-<dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
-<dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
-<dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
-<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
-<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
+<dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
+<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
+<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
 </dl></dd>
 <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
 <dd><dl>
@@ -189,7 +178,7 @@
 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
-<dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
+<dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
@@ -877,24 +866,13 @@
 <dd><dl>
 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
-<dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
-<dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
-<dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
-<dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
-<dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
-<dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
-<dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
-<dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
-<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
-<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
+<dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
+<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
+<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
 </dl></dd>
 <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
 <dd><dl>
@@ -2249,7 +2227,7 @@
 <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
            By default, dependencies are only installed, and no binary
            package is created for them. You can set this variable to
-           <code class="literal">package</code> to automatically create binary
+           <code class="literal">package-install</code> to automatically create binary
            packages after installing dependencies.</p></li>
 </ul></div>
 </div>
@@ -2271,14 +2249,6 @@
     you can set
     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
     so it's preferable to convert a package to DESTDIR instead.</p>
-<p>DESTDIR support changes the behaviour of various targets
-    slightly. To install a package after building it, use
-    <code class="literal">package-install</code>. <code class="literal">package</code> and
-    <code class="literal">install</code> don't do that any
-    longer. <code class="literal">package-install</code> can be used as
-    <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
-    will ask for the root password to install the package and fail,
-    <code class="literal">package-install</code> will ask again.</p>
 <p>With basic DESTDIR support, <strong class="userinput"><code>make
     clean</code></strong> needs to be run as root.</p>
 <p>Considering the <code class="filename">foo/bar</code> package,
@@ -2298,7 +2268,7 @@
 
 </p>
 <pre class="programlisting">
-<code class="prompt">$</code> make USE_DESTDIR=yes install
+<code class="prompt">$</code> make stage-install
 </pre>
 <p>
 
@@ -2306,7 +2276,7 @@
 
 </p>
 <pre class="programlisting">
-<code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
+<code class="prompt">$</code> make PACKAGES=$HOME/packages package
 </pre>
 <p>
 
@@ -2315,7 +2285,7 @@
 
 </p>
 <pre class="programlisting">
-<code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
+<code class="prompt">$</code> make PACKAGES=$HOME/packages install
 </pre>
 <p>
 
@@ -2344,18 +2314,32 @@
          compilers to invoke when building packages.  Valid values
          are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem"><p><code class="varname">distcc</code>:
-           distributed C/C++ (chainable)</p></li>
+<li class="listitem"><p><code class="varname">ccc</code>:
+           Compaq C Compilers (Tru64)</p></li>
 <li class="listitem"><p><code class="varname">ccache</code>:
            compiler cache (chainable)</p></li>
+<li class="listitem"><p><code class="varname">clang</code>:
+           Clang C and Objective-C compiler</p></li>
+<li class="listitem"><p><code class="varname">distcc</code>:
+           distributed C/C++ (chainable)</p></li>
+<li class="listitem"><p><code class="varname">f2c</code>:
+           Fortran 77 to C compiler (chainable)</p></li>
+<li class="listitem"><p><code class="varname">icc</code>:
+           Intel C++ Compiler (Linux)</p></li>
+<li class="listitem"><p><code class="varname">ido</code>:
+           SGI IRIS Development Option cc (IRIX 5)</p></li>
 <li class="listitem"><p><code class="varname">gcc</code>:
            GNU C/C++ Compiler</p></li>
+<li class="listitem"><p><code class="varname">hp</code>:
+           HP-UX C/aC++ compilers</p></li>
 <li class="listitem"><p><code class="varname">mipspro</code>:
            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
-<li class="listitem"><p><code class="varname">mipspro</code>:
+<li class="listitem"><p><code class="varname">mipspro-ucode</code>:
            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
 <li class="listitem"><p><code class="varname">sunpro</code>:
            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
+<li class="listitem"><p><code class="varname">xlc</code>:
+           IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
 </ul></div>
 <p>The default is
          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
@@ -2563,31 +2547,20 @@
 <dl>
 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
-<dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
-<dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
-<dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
-<dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
-<dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
-<dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
-<dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
-<dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
-<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
-<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
+<dt><span class="sect1"><a href="#bulk.pbulk">7.3. Running a pbulk-style bulk build</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.3.1. Preparation</a></span></dt>
+<dt><span class="sect2"><a href="#bulk.pbulk.conf">7.3.2. Configuration</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
+<dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
 </dl>
 </div>
 <p>When you have multiple machines that should run the same packages,
 it is wasted time if they all build their packages themselves from
-source. There are two ways of getting a set of binary packages: The old
-bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
-system. This chapter describes how to set them up so that the packages
+source. There is a ways of getting a set of binary packages:
+The bulk build system, or pbulk ("p" stands for "parallel).
+This chapter describes how to set it up so that the packages
 are most likely to be usable later.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -2643,404 +2616,7 @@
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
-<h3 class="title">Note</h3>
-<p>There are two ways of doing a bulk build. The old-style
-one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
-way.</p>
-</div>
-<div class="sect2">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
-<div class="sect3">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
-</h4></div></div></div>
-<p>The <code class="filename">build.conf</code> file is the main
-       configuration file for bulk builds. You can configure how your
-       copy of pkgsrc is kept up to date, how the distfiles are
-       downloaded, how the packages are built and how the report is
-       generated. You can find an annotated example file in
-       <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
-       it, copy <code class="filename">build.conf-example</code> to
-       <code class="filename">build.conf</code> and edit it, following the
-       comments in that file.</p>
-</div>
-<div class="sect3">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
-</h4></div></div></div>
-<p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
-       Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
-       details of the default settings. You will want to ensure that
-       <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
-       As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
-       completely bypasses the license check.</p>
-<pre class="programlisting">
-PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
-WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
-BSDSRCDIR=      /usr/src
-BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
-OBJHOSTNAME?=   yes               # use work.`hostname`
-FAILOVER_FETCH= yes               # insist on the correct checksum
-PKG_DEVELOPER?= yes
-SKIP_LICENSE_CHECK=    yes
-</pre>
-<p>Some options that are especially useful for bulk builds
-       can be found at the top lines of the file
-       <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
-       options of these are briefly described here.</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem"><p>If you are on a slow machine, you may want to
-         set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
-         <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
-<li class="listitem"><p>If you are doing bulk builds from a read-only
-         copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
-         to the directory where all log files are created. Otherwise the
-         log files are created in the pkgsrc directory.</p></li>
-<li class="listitem"><p>Another important variable is
-         <code class="varname">BULK_PREREQ</code>, which is a list of packages that
-         should be always available while building other
-         packages.</p></li>
-</ul></div>
-<p>Some other options are scattered in the pkgsrc
-       infrastructure:</p>
-<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
-<li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
-         should be set to <code class="literal">yes</code>. The purpose of the
-         bulk builds is creating binary packages, no matter if they
-         are vulnerable or not. Leaving this variable unset would
-         prevent the bulk build system from even trying to build
-         them, so possible building errors would not show
-         up.</p></li>
-<li class="listitem"><p><code class="varname">CHECK_FILES</code>
-         (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
-         <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
-         matches the <code class="filename">PLIST</code>.</p></li>
-<li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
-         (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
-         <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
-         <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
-         interpreter.</p></li>
-<li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
-         set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
-         package's self-test before installing it. Note that some
-         packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
-         numbers, so you need to assure that the machine on which you
-         are doing the bulk builds is not completely idle. Otherwise
-         some test programs will seem to hang, while they are just
-         waiting for new random data to be
-         available.</p></li>
-</ul></div>
-</div>



Home | Main Index | Thread Index | Old Index