[pkgsrc/trunk]: pkgsrc/doc/guide/files Clarify where gtk-doc documentation sh...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/eebbde164732
branches:  trunk
changeset: 518777:eebbde164732
user:      jmmv <jmmv%pkgsrc.org@localhost>
date:      Sun Sep 17 15:48:45 2006 +0000

description:
Clarify where gtk-doc documentation should be installed to match current
practices in pkgsrc.

diffstat:

 doc/guide/files/gnome.xml |  16 ++++++++++++----
 1 files changed, 12 insertions(+), 4 deletions(-)

diffs (31 lines):

diff -r 00732b1a2cb4 -r eebbde164732 doc/guide/files/gnome.xml
--- a/doc/guide/files/gnome.xml Sun Sep 17 15:35:52 2006 +0000
+++ b/doc/guide/files/gnome.xml Sun Sep 17 15:48:45 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: gnome.xml,v 1.2 2006/09/13 23:30:15 wiz Exp $ -->
+<!-- $NetBSD: gnome.xml,v 1.3 2006/09/17 15:48:45 jmmv Exp $ -->
 
 <chapter id="gnome"> <?dbhtml filename="gnome.html"?>
 <title>GNOME packaging and porting</title>
@@ -138,10 +138,18 @@
     tool is rather big and the distfile should come with pregenerated
     documentation anyway; if it does not, it is a bug that you ought to
     report.  For such packages you should disable gtk-doc (unless it is
-    the default) and change the location of installed HTML files:</para>
+    the default):</para>
 
-    <programlisting>CONFIGURE_ARGS+=--disable-gtk-doc
-CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/doc</programlisting>
+    <programlisting>CONFIGURE_ARGS+=--disable-gtk-doc</programlisting>
+    
+    <para>The default location of installed HTML files
+    (<filename>share/gtk-doc/&lt;package-name&gt;</filename>) is correct
+    and should not be changed unless the package insists on installing
+    them somewhere else.  Otherwise programs as
+    <command>devhelp</command> will not be able to open them.  You can
+    do that with an entry similar to:</para>
+
+    <programlisting>CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</programlisting>
   </listitem>
 </itemizedlist>