diff options
Diffstat (limited to 'doc/guide/files')
| -rw-r--r-- | doc/guide/files/buildlink.xml | 28 | ||||
| -rw-r--r-- | doc/guide/files/configuring.xml | 4 | ||||
| -rw-r--r-- | doc/guide/files/fixes.xml | 23 |
3 files changed, 25 insertions, 30 deletions
diff --git a/doc/guide/files/buildlink.xml b/doc/guide/files/buildlink.xml index 8f33b4a3995..2730d069d02 100644 --- a/doc/guide/files/buildlink.xml +++ b/doc/guide/files/buildlink.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: buildlink.xml,v 1.13 2006/03/09 21:45:51 jlam Exp $ --> +<!-- $NetBSD: buildlink.xml,v 1.14 2006/04/06 06:21:57 reed Exp $ --> <chapter id="buildlink"> <title>Buildlink methodology</title> @@ -85,7 +85,7 @@ </para> <programlisting> - BUILDLINK_DEPENDS.foo+= foo>=1.1.0 + BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0 .include "../../category/foo/buildlink3.mk" </programlisting> @@ -197,7 +197,7 @@ BUILDLINK_PACKAGES+= tiff .if !empty(TIFF_BUILDLINK3_MK:M+) - BUILDLINK_DEPENDS.tiff+= tiff>=3.6.1 + BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1 BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff .endif # TIFF_BUILDLINK3_MK @@ -235,7 +235,7 @@ <itemizedlist> <listitem> - <para> <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> + <para> <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> is the actual dependency recorded in the installed package; this should always be set using <command>+=</command> to ensure that @@ -363,12 +363,12 @@ </sect2> <sect2 id="updating-buildlink-depends"> - <title>Updating <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> in <filename>buildlink3.mk</filename> files</title> + <title>Updating <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> in <filename>buildlink3.mk</filename> files</title> <para> There are two situations that require increasing the dependency listed in - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> after a package update: </para> <orderedlist> @@ -383,27 +383,27 @@ </orderedlist> <para> In these cases, - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> should be adjusted to require at least the new package version. In some cases, the packages that depend on this new version may need their <varname>PKGREVISION</varname>s increased and, if they have <filename>buildlink3.mk</filename> files, their - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> adjusted, too. This is needed so that binary packages made using it will require the correct package dependency and not settle for an older one which will not contain the necessary shared libraries. </para> <para> Please take careful consideration before adjusting - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname> + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname> as we don't want to cause unneeded package deletions and rebuilds. In many cases, new versions of packages work just fine with older dependencies. See <xref linkend="dependencies"/> for more information about dependencies on other packages, - including the <varname>BUILDLINK_RECOMMENDED</varname> and - <varname>RECOMMENDED</varname> definitions. </para> + including the <varname>BUILDLINK_ABI_DEPENDS</varname> and + <varname>ABI_DEPENDS</varname> definitions. </para> </sect2> </sect1> @@ -473,7 +473,7 @@ .if !defined(USE_BUILTIN.foo) USE_BUILTIN.foo?= ${IS_BUILTIN.foo} . if defined(BUILTIN_PKG.foo) - . for _depend_ in ${BUILDLINK_DEPENDS.foo} + . for _depend_ in ${BUILDLINK_API_DEPENDS.foo} . if !empty(USE_BUILTIN.foo:M[yY][eE][sS]) USE_BUILTIN.foo!= \ if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \ @@ -519,11 +519,11 @@ <filename>builtin.mk</filename> files. The code in this section must make the determination whether the built-in software is adequate to satisfy the dependencies listed in - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname>. + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname>. This is typically done by comparing <varname>BUILTIN_PKG.<replaceable>pkg</replaceable></varname> against each of the dependencies in - <varname>BUILDLINK_DEPENDS.<replaceable>pkg</replaceable></varname>. + <varname>BUILDLINK_API_DEPENDS.<replaceable>pkg</replaceable></varname>. <varname>USE_BUILTIN.<replaceable>pkg</replaceable></varname> <emphasis>must</emphasis> be set to the correct value by the end of the <filename>builtin.mk</filename> file. Note that diff --git a/doc/guide/files/configuring.xml b/doc/guide/files/configuring.xml index 22470cc0b02..7a9cda67baf 100644 --- a/doc/guide/files/configuring.xml +++ b/doc/guide/files/configuring.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: configuring.xml,v 1.12 2006/02/28 11:50:07 rillig Exp $ --> +<!-- $NetBSD: configuring.xml,v 1.13 2006/04/06 06:21:57 reed Exp $ --> <chapter id="configuring"> <title>Configuring pkgsrc</title> @@ -106,7 +106,7 @@ <sect1 id="developer-advanced-settings"> <title>Developer/advanced settings</title> - <!-- IGNORE_RECOMMENDED --> + <!-- USE_ABI_DEPENDS --> <para>XXX <itemizedlist> <listitem><para><varname>PKG_DEVELOPER</varname>: diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml index 4279ecaab96..dcd8f53d879 100644 --- a/doc/guide/files/fixes.xml +++ b/doc/guide/files/fixes.xml @@ -1,4 +1,4 @@ -<!-- $NetBSD: fixes.xml,v 1.48 2006/03/20 01:48:57 jlam Exp $ --> +<!-- $NetBSD: fixes.xml,v 1.49 2006/04/06 06:21:57 reed Exp $ --> <chapter id="fixes"> <?dbhtml filename="fixes.html"?> <title>Making your package work</title> @@ -221,25 +221,25 @@ <para>Please note that such dependencies should only be updated if a package requires a newer pre-requisite, but - not to denote recommendations such as security updates or + not to denote recommendations such as ABI changes that do not prevent a package from building correctly. Such recommendations can be expressed using - <varname>RECOMMENDED</varname>:</para> + <varname>ABI_DEPENDS</varname>:</para> <programlisting> - RECOMMENDED+= tiff>=3.6.1:../../graphics/tiff + ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff </programlisting> <para>In addition to the above <varname>DEPENDS</varname> line, this denotes that while a package will build against tiff>=3.5.4, at least version 3.6.1 is recommended. - <varname>RECOMMENDED</varname> entries will be turned into + <varname>ABI_DEPENDS</varname> entries will be turned into dependencies unless explicitly ignored (in which case a warning will be printed).</para> - <para>To ignore these dependency recommendations and just + <para>To ignore these ABI dependency recommendations and just use the required <varname>DEPENDS</varname>, set - <varname>IGNORE_RECOMMENDED=YES</varname>. This may make + <varname>USE_ABI_DEPENDS=NO</varname>. This may make it easier and faster to update packages built using pkgsrc, since older compatible dependencies can continue to be used. This is useful for people who watch their rebuilds @@ -254,8 +254,7 @@ different versions of binary packages installed.</para> <para>For security fixes, please update the package - vulnerabilities file as well as setting - <varname>RECOMMENDED</varname>, see <xref + vulnerabilities file. See <xref linkend="security-handling"/> for more information.</para> </listitem> @@ -379,11 +378,7 @@ <para>After fixing the vulnerability by a patch, its <varname>PKGREVISION</varname> should be increased (this is of course not necessary if the problem is fixed by using - a newer release of the software). In addition, if a - <filename>buildlink3.mk</filename> file exists for an - affected package, a corresponding - <varname>BUILDLINK_RECOMMENDED.<replaceable>pkg</replaceable></varname> - entry should be added or updated in it.</para> + a newer release of the software).</para> <para>Also, if the fix should be applied to the stable pkgsrc branch, be sure to submit a pullup request!</para> |