[pkgsrc/trunk]: pkgsrc/doc/guide/files Provide usage description for the PLIS...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/3e141d245ac5
branches:  trunk
changeset: 556350:3e141d245ac5
user:      mishka <mishka%pkgsrc.org@localhost>
date:      Fri Mar 20 14:50:49 2009 +0000

description:
Provide usage description for the PLIST_VARS variable.
Proofreaded by <joerg> - thanks a lot!

diffstat:

 doc/guide/files/plist.xml |  36 +++++++++++++++++++++++++++++++++++-
 1 files changed, 35 insertions(+), 1 deletions(-)

diffs (50 lines):

diff -r 83209dbcd7da -r 3e141d245ac5 doc/guide/files/plist.xml
--- a/doc/guide/files/plist.xml Fri Mar 20 13:47:59 2009 +0000
+++ b/doc/guide/files/plist.xml Fri Mar 20 14:50:49 2009 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: plist.xml,v 1.14 2007/06/01 11:07:26 rillig Exp $ -->
+<!-- $NetBSD: plist.xml,v 1.15 2009/03/20 14:50:49 mishka Exp $ -->
 
 <chapter id="plist">
   <title>PLIST issues</title>
@@ -147,6 +147,40 @@
     <para>This replaces all occurrences of <quote>${SOMEVAR}</quote>
     in the <filename>PLIST</filename> with
     <quote>somevalue</quote>.</para>
+
+
+    <para>The <varname>PLIST_VARS</varname> can be used to simplify
+    the common case of conditionally including some
+    <filename>PLIST</filename> entries. It can be done by adding
+    <literal><varname>PLIST_VARS</varname>+=foo</literal> and
+    setting the coresponding <varname>PLIST.foo</varname> variable
+    to <literal>yes</literal>, if the entry should be included.
+    This will substitute <quote><varname>${PLIST.foo}</varname></quote>
+    in the <filename>PLIST</filename> with either
+    <quote><literal>""</literal></quote> or
+    <quote><literal>"@comment "</literal></quote>.
+    For example, in <filename>Makefile</filename>:</para>
+
+    <programlisting>
+PLIST_VARS+=   foo
+.if <replaceable>condition</replaceable>
+PLIST.foo=     yes
+.else
+    </programlisting>
+
+    <para>And then in <filename>PLIST</filename>:</para>
+    <programlisting>
+@comment $NetBSD: plist.xml,v 1.15 2009/03/20 14:50:49 mishka Exp $
+bin/bar
+man/man1/bar.1
+${PLIST.foo}bin/foo
+${PLIST.foo}man/man1/foo.1
+${PLIST.foo}share/bar/foo.data
+${PLIST.foo}@dirrm share/bar
+    </programlisting>
+
+
+
   </sect1>
 
   <sect1 id="manpage-compression">