pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc re-generated.
details: https://anonhg.NetBSD.org/pkgsrc/rev/d24782982d4b
branches: trunk
changeset: 516747:d24782982d4b
user: rillig <rillig%pkgsrc.org@localhost>
date: Thu Jul 27 06:48:36 2006 +0000
description:
re-generated.
diffstat:
doc/pkgsrc.html | 543 +++++++++++++++++++++++++++++++++++++------------------
doc/pkgsrc.txt | 407 ++++++++++++++++++++++++++++-------------
2 files changed, 641 insertions(+), 309 deletions(-)
diffs (truncated from 1348 to 300 lines):
diff -r e6b4524e16bc -r d24782982d4b doc/pkgsrc.html
--- a/doc/pkgsrc.html Thu Jul 27 06:40:05 2006 +0000
+++ b/doc/pkgsrc.html Thu Jul 27 06:48:36 2006 +0000
@@ -247,6 +247,10 @@
<dt><span class="sect1"><a href="#build.builddirs">15.3. Directories used during the build process</a></span></dt>
<dt><span class="sect1"><a href="#build.running">15.4. Running a phase</a></span></dt>
<dt><span class="sect1"><a href="#build.fetch">15.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#build.fetch.what">15.5.1. What to fetch and where to get it from</a></span></dt>
+<dt><span class="sect2"><a href="#build.fetch.how">15.5.2. How are the files fetched?</a></span></dt>
+</dl></dd>
<dt><span class="sect1"><a href="#build.checksum">15.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.extract">15.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.patch">15.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
@@ -337,16 +341,23 @@
<dd><dl>
<dt><span class="chapter"><a href="#infr.design">21. Design of the pkgsrc infrastructure</a></span></dt>
<dd><dl>
-<dt><span class="sect1"><a href="#infr.var">21.1. Variable evaluation</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#infr.var.load">21.1.1. At load time</a></span></dt>
-<dt><span class="sect2"><a href="#infr.var.run">21.1.2. At runtime</a></span></dt>
-</dl></dd>
-<dt><span class="sect1"><a href="#infr.varspec">21.2. How can variables be specified?</a></span></dt>
-<dt><span class="sect1"><a href="#infr.design.intf">21.3. Designing interfaces for Makefile fragments</a></span></dt>
-<dd><dl>
-<dt><span class="sect2"><a href="#infr.design.intf.proc">21.3.1. Procedures with parameters</a></span></dt>
-<dt><span class="sect2"><a href="#infr.design.intf.action">21.3.2. Actions taken on behalf of parameters</a></span></dt>
+<dt><span class="sect1"><a href="#infr.vardef">21.1. The meaning of variable definitions</a></span></dt>
+<dt><span class="sect1"><a href="#infr.vardef.problems">21.2. Avoiding problems before they arise</a></span></dt>
+<dt><span class="sect1"><a href="#infr.var">21.3. Variable evaluation</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#infr.var.load">21.3.1. At load time</a></span></dt>
+<dt><span class="sect2"><a href="#infr.var.run">21.3.2. At runtime</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#infr.varspec">21.4. How can variables be specified?</a></span></dt>
+<dt><span class="sect1"><a href="#infr.design.intf">21.5. Designing interfaces for Makefile fragments</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#infr.design.intf.proc">21.5.1. Procedures with parameters</a></span></dt>
+<dt><span class="sect2"><a href="#infr.design.intf.action">21.5.2. Actions taken on behalf of parameters</a></span></dt>
+</dl></dd>
+<dt><span class="sect1"><a href="#infr.order">21.6. The order in which files are loaded</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#infr.order.prefs">21.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
+<dt><span class="sect2"><a href="#infr.order.pkg">21.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
</dl></dd>
</dl></dd>
<dt><span class="chapter"><a href="#regression">22. Regression tests</a></span></dt>
@@ -1502,16 +1513,8 @@
<p>To install binary packages, you first need to know from
where to get them. You can get them on CD-ROMs, DVDs, or via FTP
or HTTP.</p>
-<p>For NetBSD, the binary packages are made available on
- <code class="filename">ftp.NetBSD.org</code> and its mirrors, in the
- directory
- <code class="filename">/pub/NetBSD/packages/<em class="replaceable"><code>OSVERSION</code></em>/<em class="replaceable"><code>ARCH</code></em>/</code>.
- For <em class="replaceable"><code>OSVERSION</code></em>, you should insert the
- output of <span><strong class="command">uname -r</strong></span>, and for
- <em class="replaceable"><code>ARCH</code></em> the output of <span><strong class="command">uname
- -p</strong></span>.</p>
-<p>For some other platforms, binary packages can be found at
- the following locations:</p>
+<p>The binary packages can be found at the following
+ locations.</p>
<div class="informaltable">
<a name="binary-packages"></a><table border="1">
<colgroup>
@@ -1524,6 +1527,10 @@
</tr></thead>
<tbody>
<tr>
+<td>NetBSD</td>
+<td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
+</tr>
+<tr>
<td>Solaris 9</td>
<td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
</tr>
@@ -1534,8 +1541,8 @@
</tbody>
</table>
</div>
-<p>Most of these directories contain the pkgsrc distribution
- for multiple platforms. Select the appropriate subdirectories,
+<p>Most of these directories contain binary packages for
+ multiple platforms. Select the appropriate subdirectories,
according to your machine architecture and operating system,
until you find a directory called <code class="filename">All</code>. This
directory contains all the binary packages. Further, there are
@@ -1909,20 +1916,6 @@
the shell commands before their invocation, and their
actual execution progress with <span><strong class="command">set -x</strong></span>
will be displayed.</p></li>
-<li><p><code class="varname">ALLOW_VULNERABILITIES.<em class="replaceable"><code>pkgbase</code></em></code>:
- A space separated list of vulnerability IDs that may be ignored when
- performing the automated security checks. These IDs are listed in the
- pkg-vulnerabilities file and are displayed by
- <span><strong class="command">audit-packages</strong></span> when
- it finds a vulnerable package.
- </p></li>
-<li><p><code class="varname">SKIP_AUDIT_PACKAGES</code>:
- If this is set to “<span class="quote">yes</span>”, the automated security checks
- (which use the <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a>
- package) will be <span class="strong"><strong>entirely</strong></span> skipped
- for <span class="strong"><strong>all</strong></span> packages built. Normally
- you'll want to use ALLOW_VULNERABILITIES instead of this.
- </p></li>
</ul></div>
<p>
</p>
@@ -3063,6 +3056,10 @@
<dt><span class="sect1"><a href="#build.builddirs">15.3. Directories used during the build process</a></span></dt>
<dt><span class="sect1"><a href="#build.running">15.4. Running a phase</a></span></dt>
<dt><span class="sect1"><a href="#build.fetch">15.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#build.fetch.what">15.5.1. What to fetch and where to get it from</a></span></dt>
+<dt><span class="sect2"><a href="#build.fetch.how">15.5.2. How are the files fetched?</a></span></dt>
+</dl></dd>
<dt><span class="sect1"><a href="#build.checksum">15.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.extract">15.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.patch">15.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
@@ -3270,8 +3267,9 @@
<p>A package <code class="filename">Makefile</code> contains several
sections that describe the package.</p>
<p>In the first section there are the following variables, which
- should appear exactly in the order given here.
- </p>
+ should appear exactly in the order given here. The ordering and
+ grouping of variables is mostly historical and has no further
+ meaning.</p>
<div class="itemizedlist"><ul type="disc">
<li><p><code class="varname">DISTNAME</code> is the basename of the
distribution file to be downloaded from the package's
@@ -3301,76 +3299,12 @@
converters games mbone print x11
</pre>
</li>
-<li>
-<p><code class="varname">MASTER_SITES</code> is a list of URLs where
- the distribution files can be downloaded. Each URL must end with a
- slash.</p>
-<p>The <code class="varname">MASTER_SITES</code> may make use of
- the following predefined sites:</p>
-<pre class="programlisting">
- ${MASTER_SITE_APACHE}
- ${MASTER_SITE_BACKUP}
- ${MASTER_SITE_CYGWIN}
- ${MASTER_SITE_DEBIAN}
- ${MASTER_SITE_FREEBSD}
- ${MASTER_SITE_FREEBSD_LOCAL}
- ${MASTER_SITE_GNOME}
- ${MASTER_SITE_GNU}
- ${MASTER_SITE_GNUSTEP}
- ${MASTER_SITE_IFARCHIVE}
- ${MASTER_SITE_MOZILLA}
- ${MASTER_SITE_OPENOFFICE}
- ${MASTER_SITE_PERL_CPAN}
- ${MASTER_SITE_R_CRAN}
- ${MASTER_SITE_SOURCEFORGE}
- ${MASTER_SITE_SUNSITE}
- ${MASTER_SITE_SUSE}
- ${MASTER_SITE_TEX_CTAN}
- ${MASTER_SITE_XCONTRIB}
- ${MASTER_SITE_XEMACS}
-</pre>
-<p>If one of these predefined sites is chosen, you may
- want to specify a subdirectory of that
- site. Since these macros may expand to more than one
- actual site, you <span class="emphasis"><em>must</em></span> use the
- following construct to specify a subdirectory:</p>
-<pre class="programlisting">
- ${MASTER_SITE_GNU:=subdirectory/name/}
- ${MASTER_SITE_SOURCEFORGE:=project_name/}
-</pre>
-<p>Note the trailing slash after the subdirectory name.</p>
-<p>If the package has multiple
- <code class="varname">DISTFILES</code> or multiple
- <code class="varname">PATCHFILES</code> from different
- sites, set <code class="varname">SITES.foo</code> to a list of URIs
- where file “<span class="quote">foo</span>” may be
- found. “<span class="quote">foo</span>” includes the suffix, e.g.:</p>
-<pre class="programlisting">
- DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
- DISTFILES+= foo-file.tar.gz
- SITES.foo-file.tar.gz= \
- http://www.somewhere.com/somehow/ \
- http://www.somewhereelse.com/mirror/somehow/
-</pre>
-</li>
-<li>
-<p><code class="varname">DISTFILES</code>: Name(s)
- of archive file(s) containing distribution. The default is
- <code class="filename">${DISTNAME}${EXTRACT_SUFX}</code>. Should only
- be set if you have more than one distfile.</p>
-<p>Note that the normal default setting of
- <code class="varname">DISTFILES</code> must be made explicit if you
- want to add to it (rather than replace it), as you usually
- would.</p>
-</li>
-<li><p><code class="varname">EXTRACT_SUFX</code>: Suffix of the
- distribution file, will be appended to
- <code class="varname">DISTNAME</code>. Defaults to
- <code class="filename">.tar.gz</code>.
- </p></li>
+<li><p><code class="varname">MASTER_SITES</code>,
+ <code class="varname">DYNAMIC_MASTER_SITES</code>,
+ <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
+ and <code class="varname">DISTFILES</code> are discussed in detail in
+ <a href="#build.fetch" title="15.5. The fetch phase">Section 15.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
</ul></div>
-<p>
- </p>
<p>The second section contains information about separately
downloaded patches, if any.
</p>
@@ -5245,6 +5179,10 @@
<dt><span class="sect1"><a href="#build.builddirs">15.3. Directories used during the build process</a></span></dt>
<dt><span class="sect1"><a href="#build.running">15.4. Running a phase</a></span></dt>
<dt><span class="sect1"><a href="#build.fetch">15.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
+<dd><dl>
+<dt><span class="sect2"><a href="#build.fetch.what">15.5.1. What to fetch and where to get it from</a></span></dt>
+<dt><span class="sect2"><a href="#build.fetch.how">15.5.2. How are the files fetched?</a></span></dt>
+</dl></dd>
<dt><span class="sect1"><a href="#build.checksum">15.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.extract">15.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
<dt><span class="sect1"><a href="#build.patch">15.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
@@ -5418,24 +5356,123 @@
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="build.fetch"></a>15.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
-<p>This will check if the file(s) given in the variables
- <code class="varname">DISTFILES</code> and <code class="varname">PATCHFILES</code> (as
- defined in the package's Makefile) are present on the
- local system in <code class="filename">/usr/pkgsrc/distfiles</code>. If they
- are not present, an attempt will be made to fetch them using commands
- of the form:</p>
+<p>The first step in building a package is to fetch the
+ distribution files (distfiles) from the sites that are providing
+ them. This is the task of the <span class="emphasis"><em>fetch</em></span>
+ phase.</p>
+<div class="sect2" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="build.fetch.what"></a>15.5.1. What to fetch and where to get it from</h3></div></div></div>
+<p>In simple cases, <code class="varname">MASTER_SITES</code> defines
+ all URLs from where the distfile, whose name is derived from the
+ <code class="varname">DISTNAME</code> variable, is fetched. The more
+ complicated cases are described below.</p>
+<p>The variable <code class="varname">DISTFILES</code> specifies the
+ list of distfiles that have to be fetched. Its value defaults to
+ <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>, so that most
+ packages don't need to define it at all.
+ <code class="varname">EXTRACT_SUFX</code> is <code class="literal">.tar.gz</code> by
+ default, but can be changed freely. Note that if your package
+ requires additional distfiles to the default one, you cannot
+ just append the additional filenames using the
+ <code class="literal">+=</code> operator, but you have write for
+ example:</p>
+<pre class="programlisting">
+ DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
+</pre>
+<p>Each of the distfiles is fetched from a list of sites,
+ usually <code class="varname">MASTER_SITES</code>. If the package has
+ multiple <code class="varname">DISTFILES</code> or multiple
+ <code class="varname">PATCHFILES</code> from different sites, you can set
+ <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code> to
+ the list of URLs where the file
+ <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
+ (including the suffix) can be found.</p>
+<pre class="programlisting">
+ DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
+ DISTFILES+= foo-file.tar.gz
+ SITES.foo-file.tar.gz= \
+ http://www.somewhere.com/somehow/ \
+ http://www.somewhereelse.com/mirror/somehow/
+</pre>
+<p>When actually fetching the distfiles, each item from
+ <code class="varname">MASTER_SITES</code> or <code class="varname">SITES.*</code>
+ gets the name of each distfile appended to it, without an
+ intermediate slash. Therefore, all site values have to end with
+ a slash or other separator character. This allows for example to
+ set <code class="varname">MASTER_SITES</code> to a URL of a CGI script
+ that gets the name of the distfile as a parameter. In this case,
+ the definition would look like:</p>
+<pre class="programlisting">
+ MASTER_SITES= http://www.example.com/download.cgi?file=
+</pre>
+<p>There are some predefined values for
+ <code class="varname">MASTER_SITES</code>, which can be used in packages.
+ The names of the variables should speak for themselves.</p>
+<pre class="programlisting">
+ ${MASTER_SITE_APACHE}
+ ${MASTER_SITE_BACKUP}
+ ${MASTER_SITE_CYGWIN}
+ ${MASTER_SITE_DEBIAN}
+ ${MASTER_SITE_FREEBSD}
+ ${MASTER_SITE_FREEBSD_LOCAL}
+ ${MASTER_SITE_GNOME}
+ ${MASTER_SITE_GNU}
+ ${MASTER_SITE_GNUSTEP}
+ ${MASTER_SITE_IFARCHIVE}
Home |
Main Index |
Thread Index |
Old Index