[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
pkgsrc/doc/guide/files/options.xml 1.20
以下のページの翻訳をしました。ツッコミをお願いします。
pkgsrc/doc/guide/files/options.xml 1.20
月曜日までに異議がなければ、 commit します。
原文は
http://cvsweb.NetBSD.org/bsdweb.cgi/%7Echeckout%7E/pkgsrc/doc/guide/files/options.xml?rev=1.20&content-type=text/plain
http://cvsweb.NetBSD.org/bsdweb.cgi/%7Echeckout%7E/htdocs/Documentation/pkgsrc/options.html?rev=1.39&content-type=text/html
で、訳文は
http://www.na.rim.or.jp/%7Ekano/tmp/pkgsrc/doc/guide/files/options.xml
http://www.na.rim.or.jp/%7Ekano/tmp/Documentation/pkgsrc/options.html
に置いてあります。
以下は原文との差分です。
--- options.xml.orig 2006-06-20 01:32:43.000000000 +0900
+++ options.xml 2006-11-12 12:32:41.000000000 +0900
@@ -1,39 +1,40 @@
<!-- $NetBSD: options.xml,v 1.20 2006/06/08 08:45:45 rillig Exp $ -->
+<!-- Based on english version: -->
+<!-- NetBSD: options.xml,v 1.20 2006/06/08 08:45:45 rillig Exp -->
<!-- based on: pkgsrc/mk/bsd.options.mk 1.56 -->
<chapter id="options">
-<title>Options handling</title>
+<title>オプションの扱い</title>
-<para>Many packages have the ability to be built to support different
-sets of features. <filename>bsd.options.mk</filename> is a framework
-in pkgsrc that provides generic handling of those options that
-determine different ways in which the packages can be built. It's
-possible for the user to specify exactly which sets of options will be
-built into a package or to allow a set of global default options
-apply.</para>
+<para>多くのパッケージは、対応する機能の組合せを変えて構築することができます。
+<filename>bsd.options.mk</filename> は pkgsrc における枠組のひとつで、
+このようなオプションに応じて異なるパッケージ構築方法の判断を、
+汎用的に処理するものです。この枠組のなかで、利用者は、
+どのようなオプションの組合せを組み込んでパッケージを構築するかを厳密に指定したり、
+大域的な標準状態のオプションの組合せを適用したりすることができます。</para>
<sect1 id="global-default-options">
-<title>Global default options</title>
+<title>標準の大域的なオプション</title>
-<para>Global default options are listed in
-<varname>PKG_DEFAULT_OPTIONS</varname>, which is a list of the options
-that should be built into every package if that option is supported.
-This variable should be set in <filename>/etc/mk.conf</filename>.</para>
+<para>標準の大域的なオプションは、
+<varname>PKG_DEFAULT_OPTIONS</varname> に列挙します。この値は、
+そのオプションに対応しているパッケージすべてに組み込むオプションを並べたものです。
+この変数は <filename>/etc/mk.conf</filename> で設定するようにします。</para>
</sect1>
<sect1 id="converting-to-options">
-<title>Converting packages to use <filename>bsd.options.mk</filename></title>
+<title>パッケージを変換して <filename>bsd.options.mk</filename> を使うようにする</title>
-<para>The following example shows how
-<filename>bsd.options.mk</filename> should be used
-by the hypothetical ``wibble'' package, either in the package
-<filename>Makefile</filename>, or in a file,
-e.g. <filename>options.mk</filename>, that is included by the
-main package <filename>Makefile</filename>.</para>
+<para>以下に掲げるのは、<filename>bsd.options.mk</filename>
+を架空の ``wibble'' パッケージでどのように使うかを示したものです。
+パッケージの <filename>Makefile</filename> に直接書くか、
+別のファイル <filename>options.mk</filename> に書いて
+<filename>Makefile</filename> からインクルードするか、
+どちらかの方法をとります。</para>
<programlisting>
PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
@@ -83,100 +84,101 @@
.endif
</programlisting>
-<para>The first section contains the information about which build
-options are supported by the package, and any default options settings
-if needed.</para>
+<para>最初の節には、
+このパッケージがどの構築オプションに対応しているかに関する情報があり、
+標準状態を設定する必要があるオプションについてはその設定をしています。</para>
<orderedlist>
-<listitem><para><varname>PKG_OPTIONS_VAR</varname> is the name of the
-&man.make.1; variable that the user can set to override the default
-options. It should be set to
-PKG_OPTIONS.<replaceable>pkgbase</replaceable>. Do not set it to
-PKG_OPTIONS.${PKGBASE}, since <varname>PKGBASE</varname> is not defined
-at the point where the options are processed.</para></listitem>
+<listitem><para><varname>PKG_OPTIONS_VAR</varname> は、
+&man.make.1; 変数の名前で、
+利用者はその名前の変数を設定して標準のオプションを上書きすることができます。
+この変数名は PKG_OPTIONS.<replaceable>pkgbase</replaceable> のように設定します。
+オプションの処理をする段階では
+<varname>PKGBASE</varname> は定義されていないので、
+PKG_OPTIONS.${PKGBASE} と定義してはいけません。</para></listitem>
-<listitem><para><varname>PKG_SUPPORTED_OPTIONS</varname> is a list of
-build options supported by the package.</para></listitem>
+<listitem><para><varname>PKG_SUPPORTED_OPTIONS</varname>
+は、このパッケージが対応している構築オプションを並べたリストです。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname> is a
-list of names of groups of mutually exclusive options. The options in
-each group are listed in
-<varname>PKG_OPTIONS_GROUP.<replaceable>groupname</replaceable></varname>.
-The most specific setting of any option from the group takes
-precedence over all other options in the group. Options from the
-groups will be automatically added to
-<varname>PKG_SUPPORTED_OPTIONS</varname>.</para></listitem>
+<listitem><para><varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname> は、
+互いに排他的なオプションからなるグループの名前を並べたリストです。
+各グループに含まれるオプションは、
+<varname>PKG_OPTIONS_GROUP.<replaceable>groupname</replaceable></varname> に列挙します。
+ここでは、各グループのオプションのうちもっとも特徴的な設定を先頭に書きます。
+各グループに含まれるオプションは、自動的に
+<varname>PKG_SUPPORTED_OPTIONS</varname> に追加されます。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_REQUIRED_GROUPS</varname> is like
-<varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname>, but building the
-packages will fail if no option from the group is
-selected.</para></listitem>
+<listitem><para><varname>PKG_OPTIONS_REQUIRED_GROUPS</varname> は、
+<varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname> に似ていますが、
+グループに含まれるオプションをどれも選ばなかった場合には、
+パッケージの構築に失敗する点が異なります。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_NONEMPTY_SETS</varname> is a list
-of names of sets of options. At least one option from each set must
-be selected. The options in each set are listed in
-<varname>PKG_OPTIONS_SET.<replaceable>setname</replaceable></varname>.
-Options from the sets will be automatically added to
-<varname>PKG_SUPPORTED_OPTIONS</varname>. Building the package will
-fail if no option from the set is selected.</para></listitem>
+<listitem><para><varname>PKG_OPTIONS_NONEMPTY_SETS</varname> は、
+オプションの集合の名前を並べたリストです。
+各集合からは、少なくともひとつのオプションを設定する必要があります。
+各集合に含まれるオプションは、
+<varname>PKG_OPTIONS_SET.<replaceable>setname</replaceable></varname> に列挙します。
+各集合に含まれるオプションは、自動的に
+<varname>PKG_SUPPORTED_OPTIONS</varname> に追加されます。
+集合に含まれるオプションをひとつも設定しなかった場合、パッケージの構築に失敗します。</para></listitem>
-<listitem><para><varname>PKG_SUGGESTED_OPTIONS</varname> is a list of
-build options which are enabled by default.</para></listitem>
+<listitem><para><varname>PKG_SUGGESTED_OPTIONS</varname> は、
+標準状態で有効となる構築オプションを並べたリストです。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_LEGACY_VARS</varname> is a list
-of
+<listitem><para><varname>PKG_OPTIONS_LEGACY_VARS</varname> は、
+旧式の <filename>/etc/mk.conf</filename> 変数を同等のオプションに対応づけた
<quote><replaceable>USE_VARIABLE</replaceable>:<replaceable>option</replaceable></quote>
-pairs that map legacy <filename>/etc/mk.conf</filename> variables to
-their option counterparts. Pairs should be added with
-<quote>+=</quote> to keep the listing of global legacy variables. A
-warning will be issued if the user uses a legacy
-variable.</para></listitem>
+という組合せを並べたリストです。
+この組合せは、旧式の変数の大域的なリストを残すために、
+<quote>+=</quote> を使って追加するようにします。
+利用者が旧式の変数を使った場合には、警告が出ます。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_LEGACY_OPTS</varname> is a list
-of
+<listitem><para><varname>PKG_OPTIONS_LEGACY_OPTS</varname> は、
+名前が変更されたオプションを新しいものに対応づけた
<quote><replaceable>old-option</replaceable>:<replaceable>new-option</replaceable></quote>
-pairs that map options that have been renamed to their new
-counterparts. Pairs should be added with <quote>+=</quote> to keep
-the listing of global legacy options. A warning will be issued if
-the user uses a legacy option.</para></listitem>
+という組合せを並べたリストです。
+この組合せは、旧名のオプションの大域的なリストを残すために、
+<quote>+=</quote> を使って追加するようにします。
+利用者が旧名のオプションを使った場合には、警告が出ます。</para></listitem>
-<listitem><para><varname>PKG_LEGACY_OPTIONS</varname> is a list of
-options implied by deprecated variables used. This can be used for
-cases that neither <varname>PKG_OPTIONS_LEGACY_VARS</varname> nor
-<varname>PKG_OPTIONS_LEGACY_OPTS</varname> can handle, e. g. when
-<varname>PKG_OPTIONS_VAR</varname> is renamed.</para></listitem>
+<listitem><para><varname>PKG_LEGACY_OPTIONS</varname> は、
+廃止された変数用のオプションを並べたリストです。
+これは、<varname>PKG_OPTIONS_LEGACY_VARS</varname> と
+<varname>PKG_OPTIONS_LEGACY_OPTS</varname> のどちらでも対処できない場合、
+たとえば <varname>PKG_OPTIONS_VAR</varname> の名前が変更された場合などに使うものです。</para></listitem>
-<listitem><para><varname>PKG_OPTIONS_DEPRECATED_WARNINGS</varname> is
-a list of warnings about deprecated variables or options used, and
-what to use instead.</para></listitem>
+<listitem><para><varname>PKG_OPTIONS_DEPRECATED_WARNINGS</varname> は、
+廃止された変数やオプションが使われたことと、その代替として何を使うかについての、
+警告を並べたリストです。</para></listitem>
</orderedlist>
-<para>A package should never modify
-<varname>PKG_DEFAULT_OPTIONS</varname> or the variable named in
-<varname>PKG_OPTIONS_VAR</varname>. These are strictly user-settable.
-To suggest a default set of options, use
-<varname>PKG_SUGGESTED_OPTIONS</varname>.</para>
+<para>パッケージ側では <varname>PKG_DEFAULT_OPTIONS</varname> や、
+<varname>PKG_OPTIONS_VAR</varname> による変数名を変えてはいけません。
+これらはもっぱら利用者が設定するためのものです。
+オプションの標準設定を提案する場合は
+<varname>PKG_SUGGESTED_OPTIONS</varname> を使います。</para>
-<para><varname>PKG_OPTIONS_VAR</varname> must be defined before
-including <filename>bsd.options.mk</filename>. If none of
+<para><varname>PKG_OPTIONS_VAR</varname> は、
+<filename>bsd.options.mk</filename> をインクルードする前に定義する必要があります。
<varname>PKG_SUPPORTED_OPTIONS</varname>,
-<varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname>, and
-<varname>PKG_OPTIONS_REQUIRED_GROUPS</varname> are defined (as can
-happen with platform-specific options if none of them is supported on
-the current platform), <varname>PKG_OPTIONS</varname> is set to the
-empty list and the package is otherwise treated as not using the
-options framework.</para>
+<varname>PKG_OPTIONS_OPTIONAL_GROUPS</varname>,
+<varname>PKG_OPTIONS_REQUIRED_GROUPS</varname> のいずれも定義されていない場合は
+(実行対象のプラットフォームが、
+プラットフォーム固有のオプションのどれにも対応していない場合に、
+これらの影響を受ける可能性があるため)、 <varname>PKG_OPTIONS</varname> は空のリストに設定され、
+パッケージがオプションの枠組を使わないように保護されます。</para>
-<para>After the inclusion of <filename>bsd.options.mk</filename>, the
-variable <varname>PKG_OPTIONS</varname> contains the list of selected
-build options, properly filtered to remove unsupported and duplicate
-options.</para>
+<para><filename>bsd.options.mk</filename> がインクルードされた後、
+変数 <varname>PKG_OPTIONS</varname> は、
+選択された構築オプションを並べたリスト
+(非対応あるいは廃止されたオプションは適切に除去されています)
+を値として持っています。</para>
-<para>The remaining sections contain the logic that is specific to
-each option. The correct way to check for an option is to check
-whether it is listed in <varname>PKG_OPTIONS</varname>:</para>
+<para>残りの節では、各オプション固有の処理をしています。
+あるオプションが <varname>PKG_OPTIONS</varname> のリストに含まれているかどうかの確認は、
+以下のようにするのが正しい方法です。</para>
<programlisting>
.if !empty(PKG_OPTIONS:M<replaceable>option</replaceable>)
@@ -185,31 +187,31 @@
</sect1>
<sect1 id="option-names">
-<title>Option Names</title>
+<title>オプション名</title>
-<para>Options that enable similar features in different packages (like
-optional support for a library) should use a common name in all
-packages that support it (like the name of the library). If another
-package already has an option with the same meaning, use the same
-name.</para>
+<para>異なるパッケージに類似の機能を追加するオプション
+(あるライブラリーにオプションで対応するなど) は、
+その機能に対応した全パッケージの間で共通の名前 (そのライブラリーの名前など) を使うべきです。
+同じ意味のオプションをもつパッケージがすでに存在する場合は、
+それと同じ名前を使ってください。</para>
-<para>Options that enable features specific to one package, where it's
-unlikely that another (unrelated) package has the same (or a similar)
-optional feature, should use a name prefixed with
-<varname><replaceable>pkgname</replaceable>-</varname>.</para>
+<para>ひとつのパッケージに固有の機能を追加するオプションで、
+他の (無関連の) パッケージが同じ (または類似の) オプション機能をもちそうにない場合は、
+冒頭に <varname><replaceable>pkgname</replaceable>-</varname>
+をつけたオプション名を使うようにします。</para>
-<para>If a group of related packages share an optional feature
-specific to that group, prefix it with the name of the
-<quote>main</quote> package
-(e. g. <varname>djbware-errno-hack</varname>).</para>
+<para>一群の関連パッケージの間で、
+それらに固有のオプション機能を共有している場合は、
+<quote>主たる</quote>パッケージ名を冒頭につけた形にします
+(たとえば <varname>djbware-errno-hack</varname>)。</para>
-<para>For new options, add a line to
-<filename>mk/defaults/options.description</filename>. Lines have two
-fields, separated by tab. The first field is the option name, the
-second its description. The description should be a whole sentence
-(starting with an uppercase letter and ending with a period) that
-describes what enabling the option does. E. g. <quote>Enable ispell
-support.</quote> The file is sorted by option names.</para>
+<para>新しいオプションを追加する場合は、
+<filename>mk/defaults/options.description</filename> にそのオプションの行を追加します。
+行は、タブで区切られた二つのフィールドからなります。
+最初のフィールドはオプション名、
+二つ目はその説明です。この説明は、完全な文章 (大文字ではじまり、ピリオドで終わる)
+で、このオプションで何ができるかを説明します。たとえば、<quote>Enable ispell
+support.</quote> とします。このファイルはオプション名でソートします。</para>
</sect1>