diff options
author | wiz <wiz> | 2006-03-17 19:49:19 +0000 |
---|---|---|
committer | wiz <wiz> | 2006-03-17 19:49:19 +0000 |
commit | 7e191d8879deb98b95fd12d93283970bee630d6b (patch) | |
tree | 5aece8675b6c80ced90d641a92c2e576b96748cd /doc | |
parent | 65d8569f6d7c9d103ca84f704e7148a7abbb699d (diff) | |
download | pkgsrc-7e191d8879deb98b95fd12d93283970bee630d6b.tar.gz |
regen.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/pkgsrc.html | 169 | ||||
-rw-r--r-- | doc/pkgsrc.txt | 83 |
2 files changed, 136 insertions, 116 deletions
diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index 139c1dc4117..e2cbc7d9c45 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -3079,6 +3079,12 @@ alink="#0000FF"> CONFIG_SHELL= ${LOCALBASE}/bin/bash WRAPPER_SHELL= ${LOCALBASE}/bin/bash </pre> + + <p>Then, rebuild the <a xmlns= + "http://www.w3.org/TR/xhtml1/transitional" href= + "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/libtool-base/README.html" + target="_top"><code xmlns="" class= + "filename">devel/libtool-base</code></a> package.</p> </div> </div> </div> @@ -4504,9 +4510,8 @@ PKG_OPTIONS.apache= suexec "filename">pre-build.local</code> is to have the line:</p> <pre class="screen"> -<code class="prompt">#</code> <strong class= -"userinput"><code>echo "I do not have enough disk space to build this pig." \ - > pkgsrc/misc/openoffice/$BROKENF</code></strong> +echo "I do not have enough disk space to build this pig." \ + > misc/openoffice/$BROKENF </pre> <p>to prevent the system from trying to build a @@ -4820,17 +4825,12 @@ PKG_OPTIONS.apache= suexec <li> <p><code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">/usr/src</code> (system sources, for - <a xmlns= + "filename">/usr/src</code> (system sources, + e. g. for <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/sysutils/aperture/README.html" target="_top"><code xmlns="" class= - "filename">sysutils/aperture</code></a>, - <a xmlns="http://www.w3.org/TR/xhtml1/transitional" - href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/net/ppp-mppe/README.html" - target="_top"><code xmlns="" class= - "filename">net/ppp-mppe</code></a>):</p> + "filename">sysutils/aperture</code></a>):</p> <pre class="screen"> <code class="prompt">#</code> <strong class= "userinput"><code>ln -s ../disk1/cvs .</code></strong> @@ -5325,9 +5325,13 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> <li> <p><a href= "http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" - target="_top">pkgsrc-bugs</a>: A list where problem - reports related to pkgsrc are sent and - discussed.</p> + target="_top">pkgsrc-bugs</a>: All bug reports in + category "pkg" sent with <a href= + "http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"> + <span class="citerefentry"><span class= + "refentrytitle">send-pr</span>(1)</span></a> appear + here. Please do not report your bugs here directly; + use one of the other mailing lists. discussed.</p> </li> <li> @@ -5341,15 +5345,43 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> <li> <p><a href= "http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" - target="_top">pkgsrc-changes</a>: A list where all - commit messages to pkgsrc are sent.</p> + target="_top">pkgsrc-changes</a>: This list is for + those who are interested in getting a commit + message for every change committed to pkgsrc. It is + also available in digest form, meaning one daily + message containing all commit messages for changes + to the package source tree in that 24 hour + period.</p> </li> <li> <p><a href= "http://www.NetBSD.org/MailingLists/index.html#tech-pkg" - target="_top">tech-pkg</a>: A general discussion - list for all things related to pkgsrc.</p> + target="_top">pkgsrc-users</a>: This is a general + purpose list for most issues regarding pkgsrc, + regardless of platform, e.g. soliciting user help + for pkgsrc configuration, unexpected build + failures, using particular packages, upgrading + pkgsrc installations, questions regarding the + pkgsrc release branches, etc. General announcements + or proposals for changes that impact the pkgsrc + user community, e.g. major infrastructure changes, + new features, package removals, etc., may also be + posted.</p> + </li> + + <li> + <p><a href= + "http://www.NetBSD.org/MailingLists/index.html#tech-pkg" + target="_top">tech-pkg</a>: This is a list for + technical discussions related to pkgsrc + development, e.g. soliciting feedback for changes + to pkgsrc infrastructure, proposed new features, + questions related to porting pkgsrc to a new + platform, advice for maintaining a package, patches + that affect many packages, help requests moved from + pkgsrc-users when an infrastructure bug is found, + etc.</p> </li> </ul> </div> @@ -7064,7 +7096,7 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> "varname">MAINTAINER</code> to yourself. If you really can't maintain the package for future updates, set it to <code class="email"><<a href= - "mailto:tech-pkg@NetBSD.org">tech-pkg@NetBSD.org</a>></code>.</p> + "mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p> </li> <li> @@ -8760,9 +8792,9 @@ nbftp% <strong class="userinput"><code>chmod 755 .</code></strong> <li> <p><code xmlns= "http://www.w3.org/TR/xhtml1/transitional" class= - "filename">ossaudio.buildlink3.mk</code> defines - several variables that may be used by packages that - use the Open Sound System (OSS) API.</p> + "filename">oss.buildlink3.mk</code> defines several + variables that may be used by packages that use the + Open Sound System (OSS) API.</p> </li> <li> @@ -12637,13 +12669,8 @@ TOOLS_PLATFORM.true?= true # shell builtin "http://www.w3.org/TR/xhtml1/transitional" class= "filename">buildlink3.mk</code> file available, this is specified using the <code class= - "varname">DEPENDS</code> definition. An example - of this is the <a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/lyx/README.html" - target="_top"><code xmlns="" class= - "filename">print/lyx</code></a> package, which - uses the xpm library, version 3.4j to build:</p> + "varname">DEPENDS</code> definition. For + example:</p> <pre class="programlisting"> DEPENDS+= xpm-3.4j:../../graphics/xpm </pre> @@ -12760,28 +12787,15 @@ TOOLS_PLATFORM.true?= true # shell builtin </div> <p>If your package needs files from another package to - build, see the first part of the “<span class= - "quote">do-configure</span>” target <a xmlns= + build, add the relevant distribution files to + <code class="varname">DISTFILES</code>, so they will be + extracted automatically. See the <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/ghostscript5/README.html" + "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/ghostscript/README.html" target="_top"><code xmlns="" class= - "filename">print/ghostscript5</code></a> package (it - relies on the jpeg sources being present in source form - during the build):</p> - <pre class="programlisting"> - if [ ! -e ${_PKGSRCDIR}/graphics/jpeg/${WRKDIR:T}/jpeg-6b ]; then \ - cd ${_PKGSRCDIR}/../../graphics/jpeg && ${MAKE} extract; \ - fi -</pre> - - <p>If you build any other packages that way, please - make sure the working files are deleted too when this - package's working files are cleaned up. The easiest way - to do so is by adding a pre-clean target:</p> - <pre class="programlisting"> - pre-clean: - cd ${_PKGSRCDIR}/../../graphics/jpeg && ${MAKE} clean -</pre> + "filename">print/ghostscript</code></a> package for an + example. (It relies on the jpeg sources being present + in source form during the build.)</p> <p>Please also note the <code class= "varname">BUILD_USES_MSGFMT</code> and <code class= @@ -13111,43 +13125,16 @@ TOOLS_PLATFORM.true?= true # shell builtin situation. <code class="varname">_FETCH_MESSAGE</code> must be executable shell commands, not just a message. (Generally, it executes <code class= - "varname">${ECHO}</code>). As of this writing, the - following packages use this: <a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/cad/simian/README.html" - target="_top"><code xmlns="" class= - "filename">cad/simian</code></a>, <a xmlns= + "varname">${ECHO}</code>). See one of the following + packages for an example: <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/ipv6socket/README.html" - target="_top"><code xmlns="" class= - "filename">devel/ipv6socket</code></a>, <a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/emulators/vmware-module/README.html" - target="_top"><code xmlns="" class= - "filename">emulators/vmware-module</code></a>, - <a xmlns="http://www.w3.org/TR/xhtml1/transitional" - href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/fonts/acroread-jpnfont/README.html" target="_top"><code xmlns="" class= "filename">fonts/acroread-jpnfont</code></a>, <a xmlns= "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/multimedia/realplayer/README.html" - target="_top"><code xmlns="" class= - "filename">multimedia/realplayer</code></a>, <a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/sysutils/storage-manager/README.html" target="_top"><code xmlns="" class= - "filename">sysutils/storage-manager</code></a>, - <a xmlns="http://www.w3.org/TR/xhtml1/transitional" - href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/ap-aolserver/README.html" - target="_top"><code xmlns="" class= - "filename">www/ap-aolserver</code></a>, <a xmlns= - "http://www.w3.org/TR/xhtml1/transitional" href= - "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/openacs/README.html" - target="_top"><code xmlns="" class= - "filename">www/openacs</code></a>. Try to be consistent - with them.</p> + "filename">sysutils/storage-manager</code></a>.</p> </div> <div class="sect2" lang="en"> @@ -14022,11 +14009,20 @@ TOOLS_PLATFORM.true?= true # shell builtin this example):</p> <pre class="programlisting"> REPLACE_INTERPRETER+= tcl - _REPLACE.tcl.old= .*/bin/tclsh - _REPLACE.tcl.new= ${PREFIX}/bin/tclsh - _REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed, + REPLACE.tcl.old= .*/bin/tclsh + REPLACE.tcl.new= ${PREFIX}/bin/tclsh + REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed, # relative to ${WRKSRC}, just as in REPLACE_PERL </pre> + + <div class="note" style= + "margin-left: 0.5in; margin-right: 0.5in;"> + <h3 class="title">Note</h3> + + <p>Before March 2006, these variables were called + <code class="varname">_REPLACE.*</code> and + <code class="varname">_REPLACE_FILES.*</code>.</p> + </div> </div> <div class="sect2" lang="en"> @@ -15128,6 +15124,15 @@ TOOLS_PLATFORM.true?= true # shell builtin entry for the package you updated or removed, in case it was mentioned there.</p> + <p>When the <code class="varname">PKGREVISION</code> of a + package is bumped, the change should appear in + <code xmlns="http://www.w3.org/TR/xhtml1/transitional" + class="filename">pkgsrc/doc/CHANGES</code> if it is + security related or otherwise relevant. Mass bumps that + result from a dependency being updated should not be + mentioned. In all other cases it's the developer's + decision.</p> + <p>There is a make target that helps in creating proper <code xmlns="http://www.w3.org/TR/xhtml1/transitional" class="filename">CHANGES</code> entries: diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt index 34a222f8f1d..a3dec6a0b73 100644 --- a/doc/pkgsrc.txt +++ b/doc/pkgsrc.txt @@ -1132,6 +1132,8 @@ installing shells/bash and adding the following lines to your mk.conf: CONFIG_SHELL= ${LOCALBASE}/bin/bash WRAPPER_SHELL= ${LOCALBASE}/bin/bash +Then, rebuild the devel/libtool-base package. + Chapter 4. Using pkgsrc Table of Contents @@ -1661,8 +1663,8 @@ tasks at the end of the pre-build stage. If the file pre-build.local exists in /usr/pkgsrc/mk/bulk, it will be executed (as a sh(1) script) at the end of the usual pre-build stage. An example use of pre-build.local is to have the line: -# echo "I do not have enough disk space to build this pig." \ - > pkgsrc/misc/openoffice/$BROKENF +echo "I do not have enough disk space to build this pig." \ + > misc/openoffice/$BROKENF to prevent the system from trying to build a particular package which requires nearly 3 GB of disk space. @@ -1791,7 +1793,7 @@ src/etc, be sure the following items are present and properly configured: # ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime - 6. /usr/src (system sources, for sysutils/aperture, net/ppp-mppe): + 6. /usr/src (system sources, e. g. for sysutils/aperture): # ln -s ../disk1/cvs . # ln -s cvs/src-2.0 src @@ -1996,15 +1998,32 @@ for both pkgsrc users and developers. The following mailing lists may be of interest to pkgsrc users: - * pkgsrc-bugs: A list where problem reports related to pkgsrc are sent and - discussed. + * pkgsrc-bugs: All bug reports in category "pkg" sent with send-pr(1) appear + here. Please do not report your bugs here directly; use one of the other + mailing lists. discussed. * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and discussed. - * pkgsrc-changes: A list where all commit messages to pkgsrc are sent. - - * tech-pkg: A general discussion list for all things related to pkgsrc. + * pkgsrc-changes: This list is for those who are interested in getting a + commit message for every change committed to pkgsrc. It is also available + in digest form, meaning one daily message containing all commit messages + for changes to the package source tree in that 24 hour period. + + * pkgsrc-users: This is a general purpose list for most issues regarding + pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc + configuration, unexpected build failures, using particular packages, + upgrading pkgsrc installations, questions regarding the pkgsrc release + branches, etc. General announcements or proposals for changes that impact + the pkgsrc user community, e.g. major infrastructure changes, new features, + package removals, etc., may also be posted. + + * tech-pkg: This is a list for technical discussions related to pkgsrc + development, e.g. soliciting feedback for changes to pkgsrc infrastructure, + proposed new features, questions related to porting pkgsrc to a new + platform, advice for maintaining a package, patches that affect many + packages, help requests moved from pkgsrc-users when an infrastructure bug + is found, etc. To subscribe, do: @@ -2596,7 +2615,7 @@ The third section contains the following variables. developers should contact the MAINTAINER before making major changes to the package. When packaging a new program, set MAINTAINER to yourself. If you really can't maintain the package for future updates, set it to < - tech-pkg@NetBSD.org>. + pkgsrc-users@NetBSD.org>. * HOMEPAGE is a URL where users can find more information about the package. @@ -3271,8 +3290,8 @@ issues: * motif.buildlink3.mk checks for a system-provided Motif installation or adds a dependency on x11/lesstif or x11/openmotif. - * ossaudio.buildlink3.mk defines several variables that may be used by - packages that use the Open Sound System (OSS) API. + * oss.buildlink3.mk defines several variables that may be used by packages + that use the Open Sound System (OSS) API. * pgsql.buildlink3.mk will accept either Postgres 7.3 or 7.4, whichever is found installed. See the file for more information. @@ -4856,8 +4875,7 @@ version numbers recognized by pkg_info(1). 3. If your package needs a library with which to link and again there is no buildlink3.mk file available, this is specified using the DEPENDS - definition. An example of this is the print/lyx package, which uses the xpm - library, version 3.4j to build: + definition. For example: DEPENDS+= xpm-3.4j:../../graphics/xpm @@ -4921,20 +4939,10 @@ version numbers recognized by pkg_info(1). The comment about wildcard dependencies from previous paragraph applies here, too. -If your package needs files from another package to build, see the first part -of the "do-configure" target print/ghostscript5 package (it relies on the jpeg -sources being present in source form during the build): - - if [ ! -e ${_PKGSRCDIR}/graphics/jpeg/${WRKDIR:T}/jpeg-6b ]; then \ - cd ${_PKGSRCDIR}/../../graphics/jpeg && ${MAKE} extract; \ - fi - -If you build any other packages that way, please make sure the working files -are deleted too when this package's working files are cleaned up. The easiest -way to do so is by adding a pre-clean target: - - pre-clean: - cd ${_PKGSRCDIR}/../../graphics/jpeg && ${MAKE} clean +If your package needs files from another package to build, add the relevant +distribution files to DISTFILES, so they will be extracted automatically. See +the print/ghostscript package for an example. (It relies on the jpeg sources +being present in source form during the build.) Please also note the BUILD_USES_MSGFMT and BUILD_USES_GETTEXT_M4 definitions, which are provided as convenience definitions. The former works out whether @@ -5063,10 +5071,8 @@ If the download can't be automated, because the user must submit personal information to apply for a password, or must pay for the source, or whatever, you can set _FETCH_MESSAGE to a macro which displays a message explaining the situation. _FETCH_MESSAGE must be executable shell commands, not just a -message. (Generally, it executes ${ECHO}). As of this writing, the following -packages use this: cad/simian, devel/ipv6socket, emulators/vmware-module, fonts -/acroread-jpnfont, multimedia/realplayer, sysutils/storage-manager, www/ -ap-aolserver, www/openacs. Try to be consistent with them. +message. (Generally, it executes ${ECHO}). See one of the following packages +for an example: fonts/acroread-jpnfont, sysutils/storage-manager. 16.2.2. How to handle modified distfiles with the 'old' name @@ -5456,11 +5462,15 @@ script interpreter, you need to set the following definitions in your Makefile (we shall use tclsh in this example): REPLACE_INTERPRETER+= tcl - _REPLACE.tcl.old= .*/bin/tclsh - _REPLACE.tcl.new= ${PREFIX}/bin/tclsh - _REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed, + REPLACE.tcl.old= .*/bin/tclsh + REPLACE.tcl.new= ${PREFIX}/bin/tclsh + REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed, # relative to ${WRKSRC}, just as in REPLACE_PERL +Note + +Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*. + 16.5.6. Packages installing perl modules Makefiles of packages providing perl5 modules should include the Makefile @@ -5859,6 +5869,11 @@ pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/doc/ TODO file and remove the entry for the package you updated or removed, in case it was mentioned there. +When the PKGREVISION of a package is bumped, the change should appear in pkgsrc +/doc/CHANGES if it is security related or otherwise relevant. Mass bumps that +result from a dependency being updated should not be mentioned. In all other +cases it's the developer's decision. + There is a make target that helps in creating proper CHANGES entries: make changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The general usage is to first make sure that your CHANGES file is up-to-date (to |