[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

pkgsrc/doc/guide/files/build.xml: 1.12 -> 1.14



以下のページの更新をしました。ツッコミをお願いします。

pkgsrc/doc/guide/files/build.xml: 1.12 -> 1.14

> revision 1.14
> date: 2005/11/03 18:15:47;  author: rillig;  state: Exp;  lines: +26 -16
> Reformatted and improved the explanation of the directories.
> ----------------------------
> revision 1.13
> date: 2005/11/03 17:06:13;  author: rillig;  state: Exp;  lines: +33 -1
> Added explanations for some of the directories used in the build
> process. More will follow.

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

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

--- build.xml.orig	2006-10-18 23:51:58.000000000 +0900
+++ build.xml	2006-10-18 23:51:58.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: build.xml,v 1.12 2005/11/03 16:43:59 rillig Exp $ -->
+<!-- $NetBSD: build.xml,v 1.14 2005/11/03 18:15:47 rillig Exp $ -->
 <!-- Based on english version: -->
-<!-- NetBSD: build.xml,v 1.12 2005/11/03 16:43:59 rillig Exp   -->
+<!-- NetBSD: build.xml,v 1.14 2005/11/03 18:15:47 rillig Exp   -->
 
 <chapter id="build">
 <title>構築の手順</title>
@@ -142,6 +142,48 @@
     </itemizedlist>
   </sect1>
 
+<sect1 id="build.builddirs">
+<title>構築の過程で使われるディレクトリー</title>
+
+<para>パッケージの構築時には、ソースファイル、一時ファイル、
+pkgsrc 内部ファイルなどを置いておくために、多数のディレクトリーが使われます。
+そのようなディレクトリーについて説明します。</para>
+
+<para>ディレクトリーを指す変数のなかには、相対パス名を値に持つものがあります。
+このような相対パス名の基点となるディレクトリーは、おもに二つあります。
+一つは <varname>PKGSRCDIR/PKGPATH</varname> で、pkgsrc 特有のディレクトリー用です。
+もう一つは  <varname>WRKSRC</varname> で、パッケージそのものの内部にあるディレクトリー用です。
+以下、変数名の後のカッコ内に記した許可属性は、
+パッケージの Makefile でその変数を変更可能かどうかを表しています。</para>
+
+<variablelist>
+
+<varlistentry><term><varname>PKGSRCDIR</varname> (読み出し専用)</term>
+<listitem><para>絶対パス名で、
+pkgsrc のルートディレクトリーを指します。
+通常は、この変数を使う必要はありません。</para></listitem></varlistentry>
+
+<varlistentry><term><varname>PKGPATH</varname> (読み出し専用)</term>
+<listitem><para><varname>PKGSRCDIR</varname>
+を基点とした相対パス名で、
+当該パッケージを指します。</para></listitem></varlistentry>
+
+<varlistentry><term><varname>WRKDIR</varname> (読み出し専用)</term>
+<listitem><para>絶対パス名で、全作業がおこなわれるディレクトリーを指します。
+一般的に、このディレクトリーには、
+<emphasis>buildlink</emphasis> や
+<emphasis>wrappers</emphasis> など、
+pkgsrc の各種基盤が使う一時ディレクトリーが含まれます。</para></listitem></varlistentry>
+
+<varlistentry><term><varname>WRKSRC</varname> (読み書き可能)</term>
+<listitem><para>絶対パス名で、distfile が展開されるディレクトリーを指します。
+普通は、<varname>WRKDIR</varname> 直下のサブディレクトリーであり、
+多くの場合は、このディレクトリーにおける、
+唯一の隠されていないディレクトリーエントリーです。</para></listitem></varlistentry>
+
+</variablelist>
+</sect1>
+
 <sect1 id="build.running">
 <title>相の実行</title>
 
Index: build.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/build.xml,v
retrieving revision 1.12
retrieving revision 1.14
diff -u -r1.12 -r1.14
--- build.xml	3 Nov 2005 16:43:59 -0000	1.12
+++ build.xml	3 Nov 2005 18:15:47 -0000	1.14
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.12 2005/11/03 16:43:59 rillig Exp $ -->
+<!-- $NetBSD: build.xml,v 1.14 2005/11/03 18:15:47 rillig Exp $ -->
 
 <chapter id="build">
 <title>The build process</title>
@@ -148,6 +148,48 @@
     </itemizedlist>
   </sect1>
 
+<sect1 id="build.builddirs">
+<title>Directories used during the build process</title>
+
+<para>When building a package, a number of directories is used to store
+source files, temporary files, pkgsrc-internal files, and so on. These
+directories are explained here.</para>
+
+<para>Some of the directory variables contain relative pathnames. There
+are two common base directories for these relative directories:
+<varname>PKGSRCDIR/PKGPATH</varname> is used for directories that are
+pkgsrc-specific. <varname>WRKSRC</varname> is used for directories
+inside the package itself. The permissions after each variable indicate
+whether the variable may be changed by the package Makefile.</para>
+
+<variablelist>
+
+<varlistentry><term><varname>PKGSRCDIR</varname> (read-only)</term>
+<listitem><para>This is an absolute pathname that points to the pkgsrc
+root directory. Generally, you don't need
+it.</para></listitem></varlistentry>
+
+<varlistentry><term><varname>PKGPATH</varname> (read-only)</term>
+<listitem><para>This is a pathname relative to
+<varname>PKGSRCDIR</varname> that points to the current
+package.</para></listitem></varlistentry>
+
+<varlistentry><term><varname>WRKDIR</varname> (read-only)</term>
+<listitem><para>This is an absolute pathname pointing to the directory
+where all work takes place. This directory typically contains temporary
+directories used by the various pkgsrc frameworks, like
+<emphasis>buildlink</emphasis> or the
+<emphasis>wrappers</emphasis>.</para></listitem></varlistentry>
+
+<varlistentry><term><varname>WRKSRC</varname> (read-write)</term>
+<listitem><para>This is an absolute pathname pointing to the directory
+where the distfiles are extracted. It is usually a direct subdirectory
+of <varname>WRKDIR</varname>, and often it's the only directory entry
+that isn't hidden.</para></listitem></varlistentry>
+
+</variablelist>
+</sect1>
+
 <sect1 id="build.running">
 <title>Running a phase</title>