diff options
author | gdt <gdt@pkgsrc.org> | 2005-08-04 17:53:11 +0000 |
---|---|---|
committer | gdt <gdt@pkgsrc.org> | 2005-08-04 17:53:11 +0000 |
commit | 643d77b4f07c14a26295f3c79599a8823b9e6090 (patch) | |
tree | ce3b0030f3dc3c3d6688964eb9e81da92204b808 /doc/pkgsrc.html | |
parent | ef176f1a7ad869622cf594d7a1f644f1807febc9 (diff) | |
download | pkgsrc-643d77b4f07c14a26295f3c79599a8823b9e6090.tar.gz |
regen for upstream patch admonition.
(Also noticed part numbering changed to I/II/A, but that seems ok.)
Diffstat (limited to 'doc/pkgsrc.html')
-rw-r--r-- | doc/pkgsrc.html | 110 |
1 files changed, 58 insertions, 52 deletions
diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index ef1ee87169e..a5358b8cb2e 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -108,7 +108,7 @@ alink="#0000FF"> </dl> </dd> - <dt><span class="part"><a href="#users-guide">1. The pkgsrc + <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt> <dd> @@ -384,7 +384,7 @@ alink="#0000FF"> </dl> </dd> - <dt><span class="part"><a href="#developers-guide">2. The + <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt> <dd> @@ -909,63 +909,63 @@ alink="#0000FF"> </dl> </dd> - <dt><span class="appendix"><a href="#examples">1. A simple + <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt> <dd> <dl> - <dt><span class="sect1"><a href="#example-files">1.1. + <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt> <dd> <dl> <dt><span class="sect2"><a href= - "#example-Makefile">1.1.1. Makefile</a></span></dt> + "#example-Makefile">A.1.1. Makefile</a></span></dt> <dt><span class="sect2"><a href= - "#example-descr">1.1.2. DESCR</a></span></dt> + "#example-descr">A.1.2. DESCR</a></span></dt> <dt><span class="sect2"><a href= - "#example-plist">1.1.3. PLIST</a></span></dt> + "#example-plist">A.1.3. PLIST</a></span></dt> <dt><span class="sect2"><a href= - "#checking-package-with-pkglint">1.1.4. Checking a + "#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class= "command">pkglint</strong></span></a></span></dt> </dl> </dd> - <dt><span class="sect1"><a href="#steps-for-b-i-p">1.2. + <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt> </dl> </dd> - <dt><span class="appendix"><a href="#logs">2. Build + <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt> <dd> <dl> - <dt><span class="sect1"><a href="#logs.building">2.1. + <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt> - <dt><span class="sect1"><a href="#logs.package">2.2. + <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt> </dl> </dd> - <dt><span class="appendix"><a href="#ftp-layout">3. Layout + <dt><span class="appendix"><a href="#ftp-layout">C. Layout of the FTP server's package archive</a></span></dt> - <dt><span class="appendix"><a href="#editing">4. Editing + <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt> <dd> <dl> - <dt><span class="sect1"><a href="#targets">4.1. + <dt><span class="sect1"><a href="#targets">D.1. Targets</a></span></dt> - <dt><span class="sect1"><a href="#procedure">4.2. + <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt> </dl> </dd> @@ -1150,16 +1150,16 @@ alink="#0000FF"> <p>This document is divided into two parts. The first, <a href="#users-guide" title= - "Part 1. The pkgsrc user's guide">The pkgsrc + "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. The second part, <a href= "#developers-guide" title= - "Part 2. 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.</p> + "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.</p> <p>This document is available in various formats:</p> @@ -1310,8 +1310,7 @@ alink="#0000FF"> <div> <div> <h1 class="title"><a name="users-guide" id= - "users-guide"></a>Part 1. The pkgsrc user's - guide</h1> + "users-guide"></a>The pkgsrc user's guide</h1> </div> </div> </div> @@ -2869,7 +2868,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 <p>This assumes that the package is already in pkgsrc. If it is not, see <a href="#developers-guide" title= - "Part 2. The pkgsrc developer's guide">Part 2, + "Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for instructions how to create your own packages.</p> @@ -2976,7 +2975,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 <p>Taking the figlet utility as an example, we can install it on our system by building as shown in <a href="#logs" title= - "Appendix 2. Build logs">Appendix 2, <i>Build + "Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p> <p>The program is installed under the default root of @@ -3676,7 +3675,7 @@ CFLAGS= -xtarget=ultra -xarch=v9 "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/usr/pkgsrc/packages</code>, in the form of a gzipped tar file. See <a href="#logs.package" title= - "2.2. Packaging figlet">Section 2.2, + "B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a continuation of the above <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= @@ -5519,8 +5518,8 @@ SU_CMD=${LOCALBASE}/bin/sudo /bin/sh -c <div> <div> <h1 class="title"><a name="developers-guide" id= - "developers-guide"></a>Part 2. The pkgsrc - developer's guide</h1> + "developers-guide"></a>The pkgsrc developer's + guide</h1> </div> </div> </div> @@ -6512,6 +6511,13 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ “<code xmlns="http://www.w3.org/TR/xhtml1/transitional" class="filename">distinfo</code>”</a>.</p> + <p>When adding a patch that corrects a problem in the + distfile (rather than e.g. enforcing pkgsrc's view of + where man pages should go), send the patch as a bug + report to the maintainer. This benefits non-pkgsrc users + of the package, and usually enables removing the patch in + future version.</p> + <p>Patch files that are distributed by the author or other maintainers can be listed in <code class= "varname">$PATCHFILES</code>.</p> @@ -13689,7 +13695,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist <div> <div> <h2 class="title"><a name="examples" id= - "examples"></a>Appendix 1. A simple example + "examples"></a>Appendix A. A simple example package: bison</h2> </div> </div> @@ -13699,28 +13705,28 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist <p><b>Table of Contents</b></p> <dl> - <dt><span class="sect1"><a href="#example-files">1.1. + <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt> <dd> <dl> <dt><span class="sect2"><a href= - "#example-Makefile">1.1.1. Makefile</a></span></dt> + "#example-Makefile">A.1.1. Makefile</a></span></dt> <dt><span class="sect2"><a href= - "#example-descr">1.1.2. DESCR</a></span></dt> + "#example-descr">A.1.2. DESCR</a></span></dt> <dt><span class="sect2"><a href= - "#example-plist">1.1.3. PLIST</a></span></dt> + "#example-plist">A.1.3. PLIST</a></span></dt> <dt><span class="sect2"><a href= - "#checking-package-with-pkglint">1.1.4. Checking a + "#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class= "command">pkglint</strong></span></a></span></dt> </dl> </dd> - <dt><span class="sect1"><a href="#steps-for-b-i-p">1.2. + <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt> </dl> </div> @@ -13739,7 +13745,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist <div> <h2 class="title" style="clear: both"><a name= "example-files" id= - "example-files"></a>1.1. files</h2> + "example-files"></a>A.1. files</h2> </div> </div> </div> @@ -13749,7 +13755,7 @@ PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist <div> <div> <h3 class="title"><a name="example-Makefile" id= - "example-Makefile"></a>1.1.1. Makefile</h3> + "example-Makefile"></a>A.1.1. Makefile</h3> </div> </div> </div> @@ -13777,7 +13783,7 @@ INFO_FILES= bison.info <div> <div> <h3 class="title"><a name="example-descr" id= - "example-descr"></a>1.1.2. DESCR</h3> + "example-descr"></a>A.1.2. DESCR</h3> </div> </div> </div> @@ -13794,7 +13800,7 @@ of the NetBSD source tree is beyond me. <div> <div> <h3 class="title"><a name="example-plist" id= - "example-plist"></a>1.1.3. PLIST</h3> + "example-plist"></a>A.1.3. PLIST</h3> </div> </div> </div> @@ -13813,7 +13819,7 @@ share/bison.hairy <div> <h3 class="title"><a name= "checking-package-with-pkglint" id= - "checking-package-with-pkglint"></a>1.1.4. Checking + "checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class= "command">pkglint</strong></span></h3> </div> @@ -13849,7 +13855,7 @@ looks fine. <div> <h2 class="title" style="clear: both"><a name= "steps-for-b-i-p" id= - "steps-for-b-i-p"></a>1.2. Steps for building, + "steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2> </div> </div> @@ -14007,7 +14013,7 @@ Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz' <div> <div> <h2 class="title"><a name="logs" id= - "logs"></a>Appendix 2. Build logs</h2> + "logs"></a>Appendix B. Build logs</h2> </div> </div> </div> @@ -14016,10 +14022,10 @@ Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz' <p><b>Table of Contents</b></p> <dl> - <dt><span class="sect1"><a href="#logs.building">2.1. + <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt> - <dt><span class="sect1"><a href="#logs.package">2.2. + <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt> </dl> </div> @@ -14030,7 +14036,7 @@ Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz' <div> <h2 class="title" style="clear: both"><a name= "logs.building" id= - "logs.building"></a>2.1. Building figlet</h2> + "logs.building"></a>B.1. Building figlet</h2> </div> </div> </div> @@ -14134,7 +14140,7 @@ cp figlet.6 /usr/pkg/man/man6 <div> <h2 class="title" style="clear: both"><a name= "logs.package" id= - "logs.package"></a>2.2. Packaging figlet</h2> + "logs.package"></a>B.2. Packaging figlet</h2> </div> </div> </div> @@ -14157,7 +14163,7 @@ Registering depends:. <div> <div> <h2 class="title"><a name="ftp-layout" id= - "ftp-layout"></a>Appendix 3. Layout of the + "ftp-layout"></a>Appendix C. Layout of the FTP server's package archive</h2> </div> </div> @@ -14262,7 +14268,7 @@ Registering depends:. <div> <div> <h2 class="title"><a name="editing" id= - "editing"></a>Appendix 4. Editing guidelines + "editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2> </div> </div> @@ -14272,10 +14278,10 @@ Registering depends:. <p><b>Table of Contents</b></p> <dl> - <dt><span class="sect1"><a href="#targets">4.1. + <dt><span class="sect1"><a href="#targets">D.1. Targets</a></span></dt> - <dt><span class="sect1"><a href="#procedure">4.2. + <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt> </dl> </div> @@ -14288,7 +14294,7 @@ Registering depends:. <div> <div> <h2 class="title" style="clear: both"><a name= - "targets" id="targets"></a>4.1. Targets</h2> + "targets" id="targets"></a>D.1. Targets</h2> </div> </div> </div> @@ -14346,7 +14352,7 @@ Registering depends:. <div> <h2 class="title" style="clear: both"><a name= "procedure" id= - "procedure"></a>4.2. Procedure</h2> + "procedure"></a>D.2. Procedure</h2> </div> </div> </div> |