summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwiz <wiz@pkgsrc.org>2006-08-11 12:09:33 +0000
committerwiz <wiz@pkgsrc.org>2006-08-11 12:09:33 +0000
commitaf3e2b3b73eb1ea03cd3c0f551e4a65603e95dc4 (patch)
treeacb15c873c26bb9ac0e44d55aaa00842c68a6a81
parentcf16242212101b7585864635a69799cb4d31607c (diff)
downloadpkgsrc-af3e2b3b73eb1ea03cd3c0f551e4a65603e95dc4.tar.gz
Describe where gtk-doc docs used by devhelp should be installed.
Based on text provided by drochner@
-rw-r--r--doc/guide/files/fixes.xml21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml
index 57fbc5e2b2d..136b6e5726b 100644
--- a/doc/guide/files/fixes.xml
+++ b/doc/guide/files/fixes.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.65 2006/07/27 06:39:10 rillig Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.66 2006/08/11 12:09:33 wiz Exp $ -->
<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
<title>Making your package work</title>
@@ -1101,11 +1101,28 @@ Changes to the PLIST
<sect2 id="where-to-install-documentation">
<title>Where to install documentation</title>
- <para>Documentation should be installed into
+ <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>
+ <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>An exception to the above is that library API
+ documentation generated with the <filename
+ role="pkg">textproc/gtk-doc</filename> tools, for use by
+ special browsers (devhelp) should be left at their default
+ location, which is
+ <filename>${PREFIX}/share/gtk-doc</filename>. Such
+ documentation can be recognized from files ending in
+ <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>
+
</sect2>
<sect2 id="installing-score-files">