[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
pkgsrc/doc/guide/files/fixes.xml: 1.65 -> 1.68
以下のページの更新をしました。ツッコミをお願いします。
pkgsrc/doc/guide/files/fixes.xml: 1.65 -> 1.68
> revision 1.68
> date: 2006/08/12 21:29:40; author: wiz; state: Exp; lines: +18 -8
> Be more explicit about where devhelp can find its files.
> Document that we prefer share/doc/${PKGNAME} for docs.
> ----------------------------
> revision 1.67
> date: 2006/08/11 13:19:38; author: wiz; state: Exp; lines: +2 -2
> Typo fix.
> ----------------------------
> revision 1.66
> date: 2006/08/11 12:09:33; author: wiz; state: Exp; lines: +19 -2
> Describe where gtk-doc docs used by devhelp should be installed.
> Based on text provided by drochner@
木曜日までに異議がなければ、 commit します。
以下、訳と原文それぞれの新旧の差分です。
--- fixes.xml.orig 2006-12-13 00:15:17.000000000 +0900
+++ fixes.xml 2006-12-13 00:15:17.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: fixes.xml,v 1.65 2006/07/27 06:39:10 rillig Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.68 2006/08/12 21:29:40 wiz Exp $ -->
<!-- Based on english version: -->
-<!-- NetBSD: fixes.xml,v 1.65 2006/07/27 06:39:10 rillig Exp -->
+<!-- NetBSD: fixes.xml,v 1.68 2006/08/12 21:29:40 wiz Exp -->
<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
<title>パッケージを動くようにする</title>
@@ -1057,11 +1057,38 @@
<sect2 id="where-to-install-documentation">
<title>ドキュメンテーションのインストール場所</title>
- <para>ドキュメンテーションは
+ <para>一般的には、ドキュメンテーションは
<filename>${PREFIX}/share/doc/${PKGBASE}</filename> または
<filename>${PREFIX}/share/doc/${PKGNAME}</filename> (後者は、
パッケージのバージョン番号を含んでいます) 以下にインストールします。</para>
+ <para>GNU autoconf を使っている最近のパッケージの多くは、
+ HTML のドキュメンテーションのインストール先を、
+ <quote>--with-html-dir</quote> オプションを使って設定することができます。
+ 時には、このフラグを使わないとドキュメンテーションが
+ <filename>${PREFIX}/share/doc/html</filename> や他の場所にインストールされるために、
+ このフラグを使う必要があることがあります。</para>
+
+ <para>例外は、<filename
+ role="pkg">textproc/gtk-doc</filename> ツールによって生成される、
+ ライブラリーの API のドキュメンテーションです。このドキュメンテーションは、
+ 専用のブラウザー (devhelp) から使うものであり、ブラウザーが標準で使う場所である
+ <filename>${PREFIX}/share/gtk-doc</filename> に置くようにします。
+ このようなドキュメンテーションは、ファイル名の末尾が
+ <filename>.devhelp</filename> または
+ <filename>.devhelp2</filename> であることから区別できます。
+ (これらのファイルを
+ <filename>${PREFIX}/share/doc/${PKGBASE}</filename> または
+ <filename>${PREFIX}/share/doc/${PKGNAME}</filename>
+ にインストールしても使うことができます。この場合、
+ これらのディレクトリーの直下に
+ <filename>.devhelp*</filename> ファイルを置く必要があり、
+ サブディレクトリー階層を追加することはできません。通常は、
+ <quote>--with-html-dir=${PREFIX}/share/doc</quote>
+ を使えばそのようにすることができます。
+ <filename>${PREFIX}/share/gtk-doc</filename>
+ のほうが好ましいのですが。)</para>
+
</sect2>
<sect2 id="installing-score-files">
Index: fixes.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/fixes.xml,v
retrieving revision 1.65
retrieving revision 1.68
diff -u -r1.65 -r1.68
--- fixes.xml 27 Jul 2006 06:39:10 -0000 1.65
+++ fixes.xml 12 Aug 2006 21:29:40 -0000 1.68
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.65 2006/07/27 06:39:10 rillig 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>
@@ -1101,10 +1101,37 @@
<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>
+ <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. 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
+ 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/${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>