[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
pkgsrc/doc/guide/files/components.xml: 1.3 -> 1.4
以下のページの更新をしました。ツッコミをお願いします。
pkgsrc/doc/guide/files/components.xml: 1.3 -> 1.4
> revision 1.4
> date: 2005/05/07 15:28:40; author: rillig; state: Exp; lines: +48 -21
> Restructured the description of the first two sections of the package
> Makefile. Fixed some other typos. Removed the MESSAGE file of audit-
> package and described how to display it. Approved by wiz.
水曜日までに異議がなければ、 commit します。
以下、訳と原文それぞれの新旧の差分です。
--- components.xml.orig 2006-09-12 00:27:26.000000000 +0900
+++ components.xml 2006-09-12 00:27:26.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: components.xml,v 1.3 2004/12/02 22:20:34 dillo Exp $ -->
+<!-- $NetBSD: components.xml,v 1.4 2005/05/07 15:28:40 rillig Exp $ -->
<!-- Based on english version: -->
-<!-- NetBSD: components.xml,v 1.3 2004/12/02 22:20:34 dillo Exp -->
+<!-- NetBSD: components.xml,v 1.4 2005/05/07 15:28:40 rillig Exp -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>パッケージコンポーネント - ファイル、ディレクトリー、およびコンテンツ</title>
@@ -12,21 +12,54 @@
<title><filename>Makefile</filename></title>
<para>構築、インストールおよびバイナリーパッケージの作成は、すべてパッケージの
- <filename>Makefile</filename>によりコントロールされます。</para>
+ <filename>Makefile</filename>によりコントロールされます。
+ <filename>Makefile</filename> には、パッケージに関するさまざまな情報が記述されています。
+ たとえば、パッケージをどこで取得するか、
+ パッケージをどのように構成、構築、インストールするか、などです。
+ </para>
+
+ <para>パッケージの <filename>Makefile</filename> は、
+ 当該パッケージについて記述した、複数の節からなっています。</para>
+
+ <para>最初の節には、以下に掲げる変数を書きます。
+ これらは以下に掲げたままの順で並べるようにします。
+ <itemizedlist>
+
+ <listitem><para><varname>DISTNAME</varname> は、当該パッケージの
+ web サイトからダウンロードされる配布ファイルの
+ 基礎となる名前です。</para></listitem>
+
+ <listitem><para><varname>PKGNAME</varname> は、
+ pkgsrc が使うパッケージ名です。これは、パッケージ名が DISTNAME
+ と異なる場合のみ書く必要があります。
+ 通常、これはディレクトリー名とバージョン番号を合わせたものになります。</para></listitem>
+
+ <listitem><para><varname>CATEGORIES</varname> は、
+ 当該パッケージにふさわしいカテゴリーのリストです。
+ pkgsrc の最上層にあるディレクトリーから自由に選ぶことができます。</para></listitem>
+
+ <listitem><para><varname>MASTER_SITES</varname> は、配布ファイルをダウンロード可能な
+ URL のリストです。
+ 各 URL はスラッシュで終わる必要があります。</para></listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>二つ目の節には、以下に掲げる変数を書きます。
+ <itemizedlist>
+
+ <listitem><para><varname>MAINTAINER</varname> は当該パッケージのメンテナー
+ (パッケージが動作しない場合の連絡先となる人)
+ のメールアドレスです。</para></listitem>
- <para>それぞれのパッケージのための<filename>Makefile</filename>があります。
- このファイルは、パッケージ
- のコンパイルとインストールのために必要なすべての定義とアクションがセットさ
- れた標準の<filename>bsd.pkg.mk</filename>ファイル
- (<filename>../../mk/bsd.pkg.mk</filename>)をインクルードします。必
- 須となる変数は、インターネットのサイトからダウンロードされる配布ファ
- イルのベース名を指定する<varname>DISTNAME</varname>と、そのサイトを指定する<varname>MASTER_SITES</varname>、パッ
- ケージが置かれるカテゴリーを意味する<varname>CATEGORIES</varname>、パッケージの名前である
- <varname>PKGNAME</varname>と、メンテナー名である<varname>MAINTAINER</varname>と、パッケージの一行説明(パッケージ
- 名は自動的に追加されるので、含めないでください) からなる<varname>COMMENT</varname>変数です。
- maintainer変数は、そのパッケージを維持する人による(いつも完全に正しい)決定
- にへりくつを言う誰かが、活発に苦情を言ったり、
- 感謝のしるしにチョコレートを送ったりできるようにするためです。</para>
+ <listitem><para><varname>HOMEPAGE</varname> は、当該パッケージについて、
+ 利用者がより詳しい情報を得られる URL です。</para></listitem>
+
+ <listitem><para><varname>COMMENT</varname> は、
+ 当該パッケージの用途についての一行説明です。</para></listitem>
+
+ </itemizedlist>
+ </para>
<para><varname>MASTER_SITES</varname>は、定義済みのサイトの一つをセットすることもできます。</para>
Index: components.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/components.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- components.xml 2 Dec 2004 22:20:34 -0000 1.3
+++ components.xml 7 May 2005 15:28:40 -0000 1.4
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.3 2004/12/02 22:20:34 dillo Exp $ -->
+<!-- $NetBSD: components.xml,v 1.4 2005/05/07 15:28:40 rillig Exp $ -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>Package components - files, directories and contents</title>
@@ -11,27 +11,54 @@
<title><filename>Makefile</filename></title>
<para>Building, installation and creation of a binary package are all
- controlled by the package's <filename>Makefile</filename>.</para>
+ controlled by the package's <filename>Makefile</filename>.
+ The <filename>Makefile</filename> describes various things about
+ a package, for example from where to get it, how to configure,
+ build, and install it.
+ </para>
+
+ <para>A package <filename>Makefile</filename> contains several
+ sections that describe the package.</para>
+
+ <para>In the first section there are the following variables, which
+ should appear exactly in the order given here.
+ <itemizedlist>
+
+ <listitem><para><varname>DISTNAME</varname> is the basename of the
+ distribution file to be downloaded from the package's
+ website.</para></listitem>
+
+ <listitem><para><varname>PKGNAME</varname> is the name of the package,
+ as used by pkgsrc. You only need to provide it if it differs from
+ DISTNAME. Usually it is the directory name together with the
+ version number.</para></listitem>
+
+ <listitem><para><varname>CATEGORIES</varname> is a list of categories
+ which the package fits in. You can choose any of the top-level
+ directories of pkgsrc for it.</para></listitem>
+
+ <listitem><para><varname>MASTER_SITES</varname> is a list of URLs where
+ the distribution files can be downloaded. Each URL must end with a
+ slash.</para></listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>The second section contains the following variables.
+ <itemizedlist>
+
+ <listitem><para><varname>MAINTAINER</varname> is the mail address of the
+ package's maintainer, which is the person you can contact when the
+ package does not work.</para></listitem>
- <para>There is a <filename>Makefile</filename> for each package.
- This file includes the standard
- <filename>bsd.pkg.mk</filename> file (referenced as
- <filename>../../mk/bsd.pkg.mk</filename>), which sets all the
- definitions and actions necessary for the package to compile and
- install itself. The mandatory variables are the
- <varname>DISTNAME</varname> which specifies the base name
- of the distribution file to be downloaded from the site on the
- Internet, <varname>MASTER_SITES</varname> which specifies that site,
- <varname>CATEGORIES</varname> which denotes the
- categories into which the package falls, <varname>PKGNAME</varname>
- which is the name of the package, the <varname>MAINTAINER</varname>'s
- name, and the <varname>COMMENT</varname> variable, which should
- contain a one-line description of the package (the package name
- should not appear, it will be added automatically). The maintainer
- variable is there so that anyone who quibbles with the (always
- completely correct) decisions taken by the guy who maintains the
- package can complain vigorously, or send chocolate as a sign of
- appreciation.</para>
+ <listitem><para><varname>HOMEPAGE</varname> is a URL where users can
+ find more information about the package.</para></listitem>
+
+ <listitem><para><varname>COMMENT</varname> is a one-line comment about
+ the purpose of the package.</para></listitem>
+
+ </itemizedlist>
+ </para>
<para>The <varname>MASTER_SITES</varname> may be set to one of the
predefined sites:</para>