Sun Feb 15 18:50:04 2015 UTC ()

Document GEENRATE_PLIST, based on an email by Hauke Fath.
While here, mention OWN_DIRS and MAKE_DIRS in directory section.


(wiz)

diff -r1.19 -r1.20 pkgsrc/doc/guide/files/plist.xml

--- pkgsrc/doc/guide/files/plist.xml 2009/08/25 13:19:50 1.19
+++ pkgsrc/doc/guide/files/plist.xml 2015/02/15 18:50:04 1.20

 @@ -1,14 +1,14 @@
-<!-- $NetBSD: plist.xml,v 1.19 2009/08/25 13:19:50 wiz Exp $ -->
+<!-- $NetBSD: plist.xml,v 1.20 2015/02/15 18:50:04 wiz Exp $ -->
 <chapter id="plist">
   <title>PLIST issues</title>
   <para>The <filename>PLIST</filename> file contains a package's
   <quote>packing list</quote>, i.e. a list of files that belong to
   the package (relative to the <filename>${PREFIX}</filename>
   directory it's been installed in) plus some additional statements
   - see the &man.pkg.create.1; man page for a full list.
   This chapter addresses some issues that need attention when
   dealing with the <filename>PLIST</filename> file (or files, see
   below!).</para>
 @@ -230,38 +230,58 @@ ${PLIST.foo}@dirrm share/bar
 	<para><filename>PLIST.${MACHINE_ARCH}</filename></para>
       </listitem>
       <listitem>
 	<para><filename>PLIST.${OPSYS}-${MACHINE_ARCH}</filename></para>
       </listitem>
       <listitem>
 	<para><filename>PLIST.common_end</filename></para>
       </listitem>
     </itemizedlist>
   </sect1>
   <sect1 id="build-plist">
     <title>Build-specific PLISTs</title>
     <para>Some packages decide to generate hard-to-guess file names
     during installation that are hard to wire down.</para>
     <para>In such cases, you can set the
     <varname>GENERATE_PLIST</varname> variable to shell code
     terminated (with a semicolon) that will output PLIST entries which
     will be appended to the PLIST</para>
     <para>You can find one example in editors/xemacs:</para>
     <programlisting>
       GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
     </programlisting>
     <para>which will append something like
     <filename>bin/xemacs-21.4.23-54e8ea71.dmp</filename> to the
     <filename>PLIST</filename>.
     </para>
   </sect1>
   <sect1 id="faq.common-dirs">
     <title>Sharing directories between packages</title>
     <para>A <quote>shared directory</quote> is a directory where
     multiple (and unrelated) packages install files.  These
     directories were problematic because you had to add special
     tricks in the PLIST to conditionally remove them, or have some
     centralized package handle them.</para>
     <para>In pkgsrc, it is now easy: Each package should create
     directories and install files as needed; <command>pkg_delete</command>
     will remove any directories left empty after uninstalling a
     package.</para>
     <para>If a package needs an empty directory to work, create
     the directory during installation as usual, and also add an
     entry to the PLIST:
     <programlisting>
 @pkgdir path/to/empty/directory
     </programlisting>
     or take a look at <varname>MAKE_DIRS</varname> and
     <varname>OWN_DIRS</varname>.
     </para>
   </sect1>
 </chapter>