[pkgsrc/trunk]: pkgsrc Remove the documentation for optional patch files, whi...

[peter <peter%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/a95c14c7681b
branches:  trunk
changeset: 483816:a95c14c7681b
user:      peter <peter%pkgsrc.org@localhost>
date:      Fri Nov 19 18:39:14 2004 +0000

description:
Remove the documentation for optional patch files, which was removed some
time ago.

ok wiz@

diffstat:

 Packages.txt                   |  27 +--------------------------
 doc/guide/files/components.xml |  41 +----------------------------------------
 2 files changed, 2 insertions(+), 66 deletions(-)

diffs (96 lines):

diff -r 414be19b05b8 -r a95c14c7681b Packages.txt
--- a/Packages.txt      Fri Nov 19 18:28:51 2004 +0000
+++ b/Packages.txt      Fri Nov 19 18:39:14 2004 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Packages.txt,v 1.362 2004/10/16 00:41:40 dan Exp $
+# $NetBSD: Packages.txt,v 1.363 2004/11/19 18:39:14 peter Exp $
 ###########################################################################
 
                        ==========================
@@ -835,31 +835,6 @@
 successively in alphabetic order (as returned by a shell "patches/patch-*"
 glob expansion), so patch-aa is applied before patch-ab etc.
 
-Patch files which are optional and will depend on local site configuration
-can be included with names matching the pattern "patches/patch-optional-*".
-Their suffixes should match the configuration options.  The selected
-optional patch file names should be assigned to the variable
-$OPTIONAL_PATCHFILES.  They will not be applied by default.
-
-For example if a package data file needs patching to indicate the default
-local printer paper size as specified in the $PAPERSIZE file you can
-include patches for all the possible paper sizes other than the one the
-package comes configured for by default.  In this case you might have a
-patch called "patch-optional-Letter-papersize" and/or another patch called
-"patch-optional-A4-papersize".  In your Makefile you would select between
-them with the following construct:
-
-   PATCHDIR=   ${.CURDIR}/patches
-   .if exists(${PATCHDIR}/patch-optional-${PAPERSIZE}-papersize)
-       OPTIONAL_PATCHFILES+= ${PATCHDIR}/patch-optional-${PAPERSIZE}-papersize
-   .endif
-
-Note that you have to define the value of $PATCHDIR in order to use it in a
-".if" statement like this as otherwise it's not defined until too late
-during the processing of the Makefile.  You should use a ".if" statement in
-order to avoid problems should the configuration item ($PAPERSIZE in this
-example) be set to an unexpected value.
-
 The patch-* files should be in "diff -bu" format, and apply without a fuzz
 to avoid problems (to force patches to apply with fuzz you can set
 PATCH_FUZZ_FACTOR=-F2).  Furthermore, do not put changes for more than one
diff -r 414be19b05b8 -r a95c14c7681b doc/guide/files/components.xml
--- a/doc/guide/files/components.xml    Fri Nov 19 18:28:51 2004 +0000
+++ b/doc/guide/files/components.xml    Fri Nov 19 18:39:14 2004 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.1.1.1 2004/10/21 14:27:38 grant Exp $ -->
+<!-- $NetBSD: components.xml,v 1.2 2004/11/19 18:42:39 peter Exp $ -->
 
 <chapter id="components"> <?dbhtml filename="components.html"?>
   <title>Package components - files, directories and contents</title>
@@ -183,45 +183,6 @@
       <filename>patch-aa</filename> is applied before
       <filename>patch-ab</filename>, etc.</para>
 
-    <para> Patch files which are optional and will depend on local
-      site configuration can be included with names matching the
-      pattern <filename>patches/patch-optional-*</filename>. Their
-      suffixes should match the configuration options.  The selected
-      optional patch file names should be assigned to the variable
-      <varname>OPTIONAL_PATCHFILES</varname>.  They will not be
-      applied by default. 
-      </para>
-
-    <para> For example if a package data file needs patching to
-      indicate the default local printer paper size as specified in
-      the <varname>$PAPERSIZE</varname> file you can include patches
-      for all the possible paper sizes other than the one the package
-      comes configured for by default.  In this case you might have a
-      patch called
-      "<filename>patch-optional-Letter-papersize</filename>" and/or
-      another patch called
-      "<filename>patch-optional-A4-papersize</filename>".  In your
-      <filename>Makefile</filename> you would select between them with
-      the following construct:
-      </para>
-
-    <programlisting>            
-   PATCHDIR=    ${.CURDIR}/patches
-   .if exists(${PATCHDIR}/patch-optional-${PAPERSIZE}-papersize)
-        OPTIONAL_PATCHFILES+= ${PATCHDIR}/patch-optional-${PAPERSIZE}-papersize
-   .endif </programlisting>
-
-    <para> Note that you have to define the value of
-      <varname>PATCHDIR</varname> in order to use it in a
-      <quote><command>.if</command></quote> statement like this as
-      otherwise it's not defined until too late during the processing
-      of the Makefile.  You should use a
-      <quote><command>.if</command></quote> statement in order to
-      avoid problems should the configuration item
-      (<varname>$PAPERSIZE</varname> in this example) be set to an
-      unexpected value.
-      </para>
-      
     <para>The <filename>patch-*</filename> files should be in
       <command>diff -bu</command> format, and apply without a fuzz to avoid
       problems. (To force patches to apply