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/b94960df9ed4
branches: trunk
changeset: 523662:b94960df9ed4
user: rillig <rillig%pkgsrc.org@localhost>
date: Thu Jan 11 03:48:18 2007 +0000
description:
regen
diffstat:
doc/pkgsrc.html | 362 +++++++++++++++++++++++++++++++++----------------------
doc/pkgsrc.txt | 269 +++++++++++++++++++++++-----------------
2 files changed, 369 insertions(+), 262 deletions(-)
diffs (truncated from 1747 to 300 lines):
diff -r 370b7830b6fe -r b94960df9ed4 doc/pkgsrc.html
--- a/doc/pkgsrc.html Thu Jan 11 03:39:59 2007 +0000
+++ b/doc/pkgsrc.html Thu Jan 11 03:48:18 2007 +0000
@@ -186,8 +186,11 @@
<dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
<dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
<dd><dl>
-<dt><span class="sect2"><a href="#components.patches.guidelines">10.3.1. Patching guidelines</a></span></dt>
-<dt><span class="sect2"><a href="#components.patches.feedback">10.3.2. Feedback to the author</a></span></dt>
+<dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
+<dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
+<dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
+<dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
+<dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
<dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
@@ -444,7 +447,7 @@
<dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
<dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages*</code>: Binary packages</a></span></dt>
<dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
-<code class="filename">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
+<code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
source packages</a></span></dt>
</dl></dd>
<dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
@@ -649,7 +652,7 @@
<a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
describes how one can use one of the packages in the Package
Collection, either by installing a precompiled binary package,
- or by building one's own copy using the NetBSD package system.
+ or by building one's own copy using the NetBSD package system.
The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
package so it can be easily built by other NetBSD users without
knowing about the package's building details. The third part,
@@ -898,7 +901,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">2006Q1</code>.</p>
+ <code class="literal">2006Q3</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, via SUP,
or via CVS. All three ways are described here.</p>
@@ -912,8 +915,8 @@
<p>The tar file for the current branch is in the directory
<code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz"; target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
It is autogenerated daily.</p>
-<p>The tar file for the stable branch 2006Q1 is in the
- directory <code class="filename">2006Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/2006Q1/pkgsrc.tar.gz"; target="_top"><code
class="filename">pkgsrc.tar.gz</code></a>.</p>
+<p>The tar file for the stable branch 2006Q3 is in the
+ directory <code class="filename">pkgsrc-2006Q3</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2006Q3/pkgsrc-2006Q3.tar.gz"; target="_top"><code
class="filename">pkgsrc-2006Q3.tar.gz</code></a>.</p>
<p>After downloading the tar file, change to the directory
where you want to have pkgsrc. This is usually
<code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
@@ -960,7 +963,7 @@
<code class="filename">/usr</code>. In that directory you run the
checkout command, which is <span><strong class="command">cvs -q checkout -P
pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
- checkout -rpkgsrc-2006Q1 -P pkgsrc</strong></span> for the stable
+ checkout -rpkgsrc-2006Q3 -P pkgsrc</strong></span> for the stable
branch. This command will create a directory called
<code class="filename">pkgsrc</code> with all the pkgsrc files in
it.</p>
@@ -1013,7 +1016,7 @@
by adding the option “<span class="quote">-A</span>” after the
“<span class="quote">update</span>” keyword. To switch from the current branch
back to the stable branch, add the
- “<span class="quote">-rpkgsrc-2006Q1</span>” option.</p>
+ “<span class="quote">-rpkgsrc-2006Q3</span>” option.</p>
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -1166,9 +1169,9 @@
</tr>
<tr>
<td class="osname">Interix 3.5</td>
-<td class="date">20051010</td>
-<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20051010.tar.gz"; target="_top">binary kit</a></td>
-<td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Interix-3.5/i386/current/"; target="_top">binary packages</a></td>
+<td class="date">20061106</td>
+<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz"; target="_top">binary kit</a></td>
+<td class="binary-pkgs-url"> </td>
</tr>
<tr>
<td class="osname">IRIX 6.5 n32-bit ABI</td>
@@ -1196,7 +1199,7 @@
</tr>
<tr>
<td class="osname">OpenBSD 3.5/i386</td>
-<td class="date">20040507</td>
+<td class="date">20040703</td>
<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz"; target="_top">binary kit</a></td>
<td class="binary-pkgs-url"> </td>
</tr>
@@ -1208,7 +1211,7 @@
</tr>
<tr>
<td class="osname">Slackware Linux 9/i386</td>
-<td class="date">20031023</td>
+<td class="date">20040703</td>
<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz"; target="_top">binary kit</a></td>
<td class="binary-pkgs-url"> </td>
</tr>
@@ -1226,9 +1229,9 @@
</tr>
<tr>
<td class="osname">Solaris 9/sparc</td>
-<td class="date">20041208</td>
-<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-20041208.tar.gz"; target="_top">binary kit</a></td>
-<td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/SunOS-5.9/sparc/"; target="_top">binary packages</a></td>
+<td class="date">20060713</td>
+<td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz"; target="_top">binary kit</a></td>
+<td class="binary-pkgs-url"> </td>
</tr>
<tr>
<td class="osname">Solaris 9/i386</td>
@@ -1395,9 +1398,12 @@
available with Cygwin. It is part of the Windows Services for Unix
package, available for free for any licensed copy of Windows 2000, XP
(not including XP Home), or 2003. SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/"; target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
-<p>Services for Unix 3.5, current as of this writing, has been tested. 3.0
- or 3.1 may work, but are not officially supported. (The main difference
- in 3.0/3.1 is lack of pthreads.)</p>
+<p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
+ are not officially supported. (The main difference in 3.0/3.1 is lack
+ of pthreads, but other parts of libc may also be lacking.)</p>
+<p>Services for Unix Applications (aka SUA) is an integrated component
+ of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
+ Interix 5.x subsystem not been tested with pkgsrc.</p>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
@@ -1428,6 +1434,16 @@
must be installed. Hotfixes are available from Microsoft through a
support contract; however, a NetBSD developer has made most Interix
hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php"; target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
+<p>In addition to the hotfix noted above, it may be necessary to
+ disable Data Execution Prevention entirely to make Interix functional.
+ This may happen only with certain types of CPUs; the cause is not fully
+ understood at this time. If gcc or other applications still segfault
+ repeatedly after installing one of the hotfixes note above, the
+ following option can be added to the appropriate "boot.ini" line on the
+ Windows boot drive: /NoExecute=AlwaysOff
+ (WARNING, this will disable DEP completely, which may be a security
+ risk if applications are often run as a user in the Administrators
+ group!)</p>
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -1493,11 +1509,6 @@
<a href="http://www.interopsystems.com/InteropXserver.htm"; target="_top">Interop X Server</a>),
and the free X11 server included with
<a href="http://x.cygwin.com/"; target="_top">Cygwin</a>.</p>
-<p>Also, StarNet Communications has graciously provided a free
- version of their X-Win32 product that accepts connections only
- from localhost:
- <a href="http://www.starnet.com/xwin32LX/get_xwin32LX.htm"; target="_top">X-Win32 LX</a>,
- recommended by the maintainer of Interix pkgsrc support.</p>
</li>
<li>
<p><span class="strong"><strong>X11 acceleration:</strong></span></p>
@@ -1596,7 +1607,7 @@
bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
default.</p>
<p>If you have both the MIPSPro compiler chain installed as well as gcc,
- but want to make sure that MIPRPro is used, please set your <code class="varname">PATH</code>
+ but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
to <span class="emphasis"><em>not</em></span> include the location of gcc (often
<code class="filename">/usr/freeware/bin</code>), and (important) pass the
'--preserve-path' flag.</p>
@@ -1721,7 +1732,7 @@
then either build gcc from
<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html"; target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
package, then remove gcc used during bootstrapping.</p>
-<p>Binary packages of gcc can be found through <a href="http://www.sun.com/bigadmin/common/freewareSearch.html"; target="_top">http://www.sun.com/bigadmin/common/freewareSearch.html</a>.</p>
+<p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/"; target="_top">http://www.sunfreeware.com/</a>.</p>
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
@@ -1749,7 +1760,7 @@
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="solaris-sunpro-64"></a>3.3.7.3. Buildling 64-bit binaries with SunPro</h4></div></div></div>
+<a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
<p>Building 64-bit binaries is a little trickier. First, you
need to bootstrap pkgsrc in 64-bit mode. One problem here is
that while building one of the programs in the bootstrap kit
@@ -2008,13 +2019,13 @@
FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities"; target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
</p>
<p>
- Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a>,
+ Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a>,
this list can be downloaded
automatically, and a security audit of all packages installed on a system
can take place.
</p>
<p>
- There are two components to
+ There are two components to
<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html"; target="_top"><code class="filename">security/audit-packages</code></a>. The first
component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
the list of vulnerabilities from the NetBSD FTP site. The second
@@ -2036,7 +2047,7 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
<p>
- Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
+ Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html"; target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
<span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
argument to check if your packages are up-to-date, e.g.
</p>
@@ -2137,7 +2148,7 @@
and adding the definitions there.</p>
<p>
If a package depends on many other packages (such as
- <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html"; target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
+ <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html"; target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
alternate between periods of
downloading source, and compiling. To ensure you have all the source
downloaded initially you can run the command:
@@ -2352,7 +2363,10 @@
and
<code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
<li><p><code class="varname">BINPKG_SITES</code>:
- List of sites carrying binary pkgs.</p></li>
+ List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
+ <em class="replaceable"><code>arch</code></em> are replaced with OS
+ release (“<span class="quote">2.0</span>”, etc.) and architecture
+ (“<span class="quote">mipsel</span>”, etc.).</p></li>
<li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
List of acceptable licenses. Whenever you try to build a package
whose license is not in this list, you will get an error message
@@ -2383,10 +2397,7 @@
<li><p><code class="varname">LOCALPATCHES</code>:
Directory for local patches that aren't part of pkgsrc.
See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
- information. <em class="replaceable"><code>rel</code></em> and
- <em class="replaceable"><code>arch</code></em> are replaced with OS
- release (“<span class="quote">2.0</span>”, etc.) and architecture
- (“<span class="quote">mipsel</span>”, etc.).</p></li>
+ information.</p></li>
<li><p><code class="varname">PKGMAKECONF</code>: Location of
the <code class="filename">mk.conf</code> file used by a package's
BSD-style Makefile. If this is not set,
@@ -2649,7 +2660,8 @@
<a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code></h4></div></div></div>
+<a name="binary.bulk.build.conf"></a>6.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
@@ -2709,11 +2721,11 @@
build system from even trying to build them, so possible
building errors would not show up.</p></li>
<li><p><code class="varname">CHECK_FILES</code>
- (<code class="filename">pkgsrc/mk/bsd.pkg.check.mk</code>) can be set to
+ (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
“<span class="quote">yes</span>” to check that the installed set of files
matches the <code class="filename">PLIST</code>.</p></li>
<li><p><code class="varname">CHECK_INTERPRETER</code>
- (<code class="filename">pkgsrc/mk/bsd.pkg.check.mk</code>) can be set to
+ (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
“<span class="quote">yes</span>” to check that the installed
“<span class="quote">#!</span>”-scripts will find their
interpreter.</p></li>
@@ -2730,7 +2742,8 @@
</div>
<div class="sect3" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code></h4></div></div></div>
+<a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
+</h4></div></div></div>
<p>It is possible to configure the bulk build to perform
certain site-specific tasks at the end of the pre-build
stage. If the file
@@ -2972,17 +2985,17 @@
<p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
set properly in your <code class="filename">mk/bulk/build.conf</code>
file, i.e. adjust it to something like one of the following:</p>
-<pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload </pre>
-<p>Please use appropriate values for "pkgsrc-200xQy",
+<pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
+<p>Please use appropriate values for "packages-200xQy",
"NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
is different from your local login, write your login directly
into the variable, e.g. my local account is "feyrer", but for my
login "hubertf", I use:</p>
-<pre class="screen">RSYNC_DST=hubertf%ftp.NetBSD.org@localhost:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload</pre>
+<pre class="screen">RSYNC_DST=hubertf%ftp.NetBSD.org@localhost:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
<p>A separate <code class="filename">upload</code> directory is used
here to allow "closing" the directory during upload. To do
so, run the following command on ftp.NetBSD.org next:</p>
-<pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
+<pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
Home |
Main Index |
Thread Index |
Old Index