[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
pkgsrc/doc/guide/files/components.xml: 1.24 -> 1.25

Subject: pkgsrc/doc/guide/files/components.xml: 1.24 -> 1.25
From: kano@na.rim.or.jp (OKANO Takayoshi)
To: www-changes-ja@jp.NetBSD.org
Date: Thu, 30 Nov 2006 00:49:25 +0900 (JST)
Message-Id: <200611291549.AAA86683@shell.rim.or.jp>
Delivered-To: mailing list www-changes-ja@jp.netbsd.org
Mailing-List: contact www-changes-ja-help@jp.netbsd.org; run by ezmlm-idx
以下のページの更新をしました。ツッコミをお願いします。

pkgsrc/doc/guide/files/components.xml: 1.24 -> 1.25

> revision 1.25
> date: 2006/06/25 10:33:33;  author: rillig;  state: Exp;  lines: +54 -3
> Documented some more file names, so that almost all files in pkgsrc are
> covered now by the documentation.

金曜日までに異議がなければ、 commit します。

以下、訳と原文それぞれの新旧の差分です。

--- components.xml.orig	2006-11-30 00:48:18.000000000 +0900
+++ components.xml	2006-11-30 00:48:18.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: components.xml,v 1.24 2006/06/25 10:02:10 rillig Exp $ -->
+<!-- $NetBSD: components.xml,v 1.25 2006/06/25 10:33:33 rillig Exp $ -->
 <!-- Based on english version: -->
-<!-- NetBSD: components.xml,v 1.24 2006/06/25 10:02:10 rillig Exp   -->
+<!-- NetBSD: components.xml,v 1.25 2006/06/25 10:33:33 rillig Exp   -->
 
 <chapter id="components"> <?dbhtml filename="components.html"?>
   <title>パッケージコンポーネント - ファイル、ディレクトリー、およびコンテンツ</title>
@@ -360,6 +360,9 @@
   <sect1 id="components.optional">
     <title>オプションのファイル</title>
 
+<sect2 id="components.optional.bin">
+<title>バイナリーパッケージに影響をおよぼすファイル</title>
+
     <variablelist>
       <varlistentry>
         <term><filename>INSTALL</filename></term>
@@ -408,19 +411,65 @@
         </listitem>
       </varlistentry>
 
+	<varlistentry><term><filename>ALTERNATIVES</filename></term>
+	<listitem><para>FIXME: alternatives の枠組に関するドキュメンテーションは、
+	ありません。</para></listitem></varlistentry>
+
+    </variablelist>
+
+</sect2>
+<sect2 id="components.optional.build">
+<title>構築の過程に影響をおよぼすファイル</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>Makefile.common</filename></term>
+	<listitem><para>このファイルには、<filename>Makefile</filename>
+	に書くことができることを好きなように含めることができますが、
+	このファイルの目的は複数のパッケージから利用することです。
+	このファイルを利用するパッケージがあらかじめわかっている場合に限り、
+	使うようにします。それ以外の場合には、<filename>*.mk</filename>
+	ファイルを書いて、
+	その役割をあらわすファイル名をつけたほうがよいことが多いでしょう。</para></listitem></varlistentry>
+
 	<varlistentry><term><filename>buildlink3.mk</filename></term>
 	<listitem><para>このファイルには、buildlink3 の枠組 (<xref
 	linkend="buildlink"/>参照) のための
 	依存性情報が含まれます。</para></listitem></varlistentry>
 
+	<varlistentry><term><filename>hacks.mk</filename></term>
+	<listitem><para>このファイルには、コンパイラーのバグや、
+	それに類する事象への回避策が含まれます。このファイルは pkgsrc
+	の基盤が自動的にインクルードしますので、インクルードのための
+	<literal>.include</literal> 行は必要ありません。</para></listitem></varlistentry>
+	
 	<varlistentry><term><filename>options.mk</filename></term>
 	<listitem><para>このファイルには、
 	利用者が選択可能なパッケージ固有のオプション (<xref linkend="options"/>参照)
 	のためのコードが含まれます。パッケージにオプションが一つか二つしかない場合は、
 	このコードを <filename>Makefile</filename> 内に直接書いてもかまいません。</para></listitem></varlistentry>
 
-    </variablelist>
-  </sect1>
+	</variablelist>
+
+</sect2>
+<sect2 id="components.optional.none">
+<title>何の影響もおよぼさないファイル</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>README*</filename></term>
+	<listitem><para>このファイルは、
+	パッケージの作成に対して何の影響もおよぼさず、
+	パッケージ開発者向けの情報を記しただけのものです。</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>TODO</filename></term>
+	<listitem><para>このファイルには、
+	パッケージを改良するためにおこなう必要があることが含まれます。</para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect2>
+</sect1>
 
   <sect1 id="work-dir">
     <title><filename>work*</filename></title>
Index: components.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/components.xml,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- components.xml	25 Jun 2006 10:02:10 -0000	1.24
+++ components.xml	25 Jun 2006 10:33:33 -0000	1.25
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.24 2006/06/25 10:02:10 rillig Exp $ -->
+<!-- $NetBSD: components.xml,v 1.25 2006/06/25 10:33:33 rillig Exp $ -->
 
 <chapter id="components"> <?dbhtml filename="components.html"?>
   <title>Package components - files, directories and contents</title>
@@ -363,6 +363,9 @@
   <sect1 id="components.optional">
     <title>Optional files</title>
 
+<sect2 id="components.optional.bin">
+<title>Files affecting the binary package</title>
+
     <variablelist>
       <varlistentry>
         <term><filename>INSTALL</filename></term>
@@ -412,11 +415,39 @@
         </listitem>
       </varlistentry>
 
+	<varlistentry><term><filename>ALTERNATIVES</filename></term>
+	<listitem><para>FIXME: There is no documentation on the
+	alternatives framework.</para></listitem></varlistentry>
+
+    </variablelist>
+
+</sect2>
+<sect2 id="components.optional.build">
+<title>Files affecting the build process</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>Makefile.common</filename></term>
+	<listitem><para>This file contains arbitrary things that could
+	also go into a <filename>Makefile</filename>, but its purpose is
+	to be used by more than one package. This file should only be
+	used when the packages that will use the file are known in
+	advance. For other purposes it is often better to write a
+	<filename>*.mk</filename> file and give it a good name that
+	describes what it does.</para></listitem></varlistentry>
+
 	<varlistentry><term><filename>buildlink3.mk</filename></term>
 	<listitem><para>This file contains the dependency information
 	for the buildlink3 framework (see <xref
 	linkend="buildlink"/>).</para></listitem></varlistentry>
 
+	<varlistentry><term><filename>hacks.mk</filename></term>
+	<listitem><para>This file contains workarounds for compiler bugs
+	and similar things. It is included automatically by the pkgsrc
+	infrastructure, so you don't need an extra
+	<literal>.include</literal> line for
+	it.</para></listitem></varlistentry>
+	
 	<varlistentry><term><filename>options.mk</filename></term>
 	<listitem><para>This file contains the code for the
 	package-specific options (see <xref linkend="options"/>) that can be
@@ -424,8 +455,28 @@
 	it is equally acceptable to put the code directly into the
 	<filename>Makefile</filename>.</para></listitem></varlistentry>
 
-    </variablelist>
-  </sect1>
+	</variablelist>
+
+</sect2>
+<sect2 id="components.optional.none">
+<title>Files affecting nothing at all</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>README*</filename></term>
+	<listitem><para>These files do not take place in the creation of
+	a package and thus are purely informative to the package
+	developer.</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>TODO</filename></term>
+	<listitem><para>This file contains things that need to be done
+	to make the package even
+	better.</para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect2>
+</sect1>
 
   <sect1 id="work-dir">
     <title><filename>work*</filename></title>
Prev by Date: CVS commit: htdocs
Next by Date: pkgsrc/doc/guide/files/build.xml: 1.27 -> 1.28
Prev by thread: gallery/index.xml: 1.6 -> 1.7
Next by thread: pkgsrc/doc/guide/files/build.xml: 1.27 -> 1.28
Index(es):
- Date
- Thread