[pkgsrc/trunk]: pkgsrc/doc/guide/files Be more explicit about where devhelp c...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/d43d0c6093c5
branches:  trunk
changeset: 517496:d43d0c6093c5
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Sat Aug 12 21:29:40 2006 +0000

description:
Be more explicit about where devhelp can find its files.
Document that we prefer share/doc/${PKGNAME} for docs.

diffstat:

 doc/guide/files/fixes.xml |  26 ++++++++++++++++++--------
 1 files changed, 18 insertions(+), 8 deletions(-)

diffs (48 lines):

diff -r 93ab76a97113 -r d43d0c6093c5 doc/guide/files/fixes.xml
--- a/doc/guide/files/fixes.xml Sat Aug 12 21:05:40 2006 +0000
+++ b/doc/guide/files/fixes.xml Sat Aug 12 21:29:40 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.67 2006/08/11 13:19:38 wiz Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.68 2006/08/12 21:29:40 wiz Exp $ -->
 
 <chapter id="fixes"> <?dbhtml filename="fixes.html"?>
   <title>Making your package work</title>
@@ -1103,12 +1103,15 @@
 
        <para>In general, documentation should be installed into
        <filename>${PREFIX}/share/doc/${PKGBASE}</filename> or
-       <filename>${PREFIX}/share/doc/${PKGNAME}</filename> (the latter
-       includes the version number of the package).</para>
+       <filename>${PREFIX}/share/doc/${PKGNAME}</filename> (the
+       latter includes the version number of the package).</para>
 
-       <para>Many modern packages using GNU autoconf allow to set the directory
-       where HTML documentation is installed with the <quote>--with-html-dir</quote>
-       option.</para>
+       <para>Many modern packages using GNU autoconf allow to set the
+       directory where HTML documentation is installed with the
+       <quote>--with-html-dir</quote> option. Sometimes using this
+       flag is needed because otherwise the documentation ends up in
+       <filename>${PREFIX}/share/doc/html</filename> or other
+       places.</para>
 
        <para>An exception to the above is that library API
        documentation generated with the <filename
@@ -1120,8 +1123,15 @@
        <filename>.devhelp</filename> or
        <filename>.devhelp2</filename>.  (It is also acceptable to
        install such files in
-       <filename>${PREFIX}/share/doc</filename>; no additional
-       subdirectory level is allowed in this case.)</para>
+       <filename>${PREFIX}/share/doc/${PKGBASE}</filename> or
+       <filename>${PREFIX}/share/doc/${PKGNAME}</filename>; the
+       <filename>.devhelp*</filename> file must be directly in that
+       directory then, no additional
+       subdirectory level is allowed in this case. This is usually
+       achieved by using
+       <quote>--with-html-dir=${PREFIX}/share/doc</quote>.
+       <filename>${PREFIX}/share/gtk-doc</filename> is preferred
+       though.)</para>
 
 </sect2>