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

pkgsrc/doc/guide/files/fixes.xml: 1.53 -> 1.54



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

pkgsrc/doc/guide/files/fixes.xml: 1.53 -> 1.54

> revision 1.54
> date: 2006/06/01 09:31:18;  author: rillig;  state: Exp;  lines: +56 -100
> Rewrote and shortened the section on C preprocessor macros. Renamed some
> headings to follow a common structure.

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

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

--- fixes.xml.orig	2006-11-24 22:26:33.000000000 +0900
+++ fixes.xml	2006-11-24 22:26:33.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: fixes.xml,v 1.53 2006/05/23 09:09:13 rillig Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.54 2006/06/01 09:31:18 rillig Exp $ -->
 <!-- Based on english version: -->
-<!-- NetBSD: fixes.xml,v 1.53 2006/05/23 09:09:13 rillig Exp   -->
+<!-- NetBSD: fixes.xml,v 1.54 2006/06/01 09:31:18 rillig Exp   -->
 
 <chapter id="fixes"> <?dbhtml filename="fixes.html"?>
   <title>パッケージを動くようにする</title>
@@ -427,8 +427,8 @@
   </sect1>
 
 
-  <sect1 id="downloading-issues">
-    <title>ダウンロードで起こりうる問題</title>
+<sect1 id="fixes.fetch">
+<title><emphasis>fetch</emphasis> 相での問題を修正する</title>
 
     <sect2 id="no-plain-download">
       <title>distfileのダウンロードが単純にできないパッケージ</title>
@@ -483,8 +483,8 @@
   </sect1>
 
 
-  <sect1 id="configuration-gotchas">
-    <title>コンフィギュレーションの技巧</title>
+<sect1 id="fixes.configure">
+<title><emphasis>configure</emphasis> 相での問題を修正する</title>
 
     <sect2 id="fixes.libtool">
       <title>共有ライブラリー - libtool</title>
@@ -730,53 +730,57 @@
     </sect2>
   </sect1>
 
+<sect1 id="fixes.build">
+<title><emphasis>build</emphasis> 相での問題を修正する</title>
 
-  <sect1 id="fixes-build">
-    <title>パッケージを構築する</title>
+	<para>パッケージ構築時に最もよくある障害は、
+	プラットフォームによっては必要なヘッダーファイル、関数やライブラリーがなかったり、
+	あるいは、ライブラリーで提供される関数がパッケージ作者の考えているものと違っていたりするものです。
+	そのようなことを回避するために、ほとんどの場合は、
+	ない関数を使わないようにしたり、代替の関数を提供したりするように
+	ソースコードを書き換えることができます。</para>
+
+<sect2 id="fixes.build.cpp">
+<title>C および C++ のコードの条件つきコンパイル</title>
+
+	<para>パッケージに最初から GNU configure スクリプトが附属している場合は、
+	構築の障害の修正方法としては、コードを変更せずに configure
+	スクリプトを変更するのが望ましい方法です。configure スクリプトが附属しない場合は、
+	コンパイル対象のオペレーティングシステムやハードウェアアーキテクチャーに応じて必要なマクロを定義している
+	C プリプロセッサーを役立てることができます。このマクロは、たとえば
+	<varname>#if defined(__i386)</varname> のようにして調べることができます。
+	ほとんどすべてのオペレーティングシステム、ハードウェアアーキテクチャー、
+	およびコンパイラーには、独自のマクロがあります。
+	たとえば、<varname>__GNUC__</varname>,
+	<varname>__i386__</varname>, <varname>__NetBSD__</varname>
+	の各マクロがすべて定義されている場合は、i386 互換 CPU 上の NetBSD を使っていることと、
+	コンパイラーが GCC であることがわかります。</para>
+
+	<para>以下に列挙するハードウェアおよびオペレーティングシステム用のマクロは、
+	使っているコンパイラーに依存します。
+	たとえば、Solaris 上でコードを条件付きコンパイルしたい場合、
+	<varname>__sun__</varname> は
+	SunPro コンパイラーでは定義されていないので使ってはいけません。
+	かわりに <varname>__sun</varname> を使います。</para>
 
-    <sect2 id="cpp-defines">
-      <title>CPP定義</title>
 
-      <para>時には、対象プラットフォームによって、
-      コンパイルするコードを変える必要があります。 C プリプロセッサーには、
-      一連の定義済みマクロがあり、<varname>#ifdef FOO</varname>
-      または <varname>#if defined(FOO)</varname>
-      を使ってそれらを問い合わせることができます。これらのマクロは通常は、
-      ターゲットの CPU およびオペレーティングシステムについての情報を持つものです。
-      どのようなマクロが定義されているかによって、
-      特定のプラットフォームに固有の機能を使ったコードを書くことができます。
-      一般的には、GNU autotools (automake,
-      autoconf, etc.) を使って、個別の機能 (ヘッダーファイル、関数やライブラリーの有無)
-      を検査するのがいいのですが、時には、この方法を使うのが不可能だったり、
-      使いたくなかったりすることがあります。</para>
-
-      <para>そのような場合は、
-      実行しているプラットフォーム用のコードを構成するために、
-      以下の定義済みマクロを使うことができます。
-      ほとんどすべてのオペレーティングシステム、ハードウェアアーキテクチャー、
-      およびコンパイラーには、独自のマクロがあります。
-      たとえば、<varname>__GNUC__</varname>,
-      <varname>__i386__</varname>, <varname>__NetBSD__</varname>
-      の各マクロがすべて定義されている場合は、i386 互換 CPU 上の NetBSD を使っていることと、
-      コンパイラーが GCC であることがわかります。</para>
-
-      <sect3 id="fixes-build-cpp-opsys">
-        <title>オペレーティングシステムに関する CPP 定義</title>
+<sect3 id="fixes.build.cpp.os">
+<title>オペレーティングシステムを特定するための C プリプロセッサーマクロ</title>
 
         <para>4.4 BSD から派生したシステムとそれ以外のシステムを
         見分けるには、以下のコードを使うようにしてください。</para>
 
-<programlisting><![CDATA[
-    #include <sys/param.h>
-    #if (defined(BSD) && BSD >= 199306)
+<programlisting>
+    #include &lt;sys/param.h&gt;
+    #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
       /* BSD-specific code goes here */
     #else
       /* non-BSD-specific code goes here */
     #endif
-]]></programlisting>
+</programlisting>
 
         <para>これでは十分正確でない場合は、
-        以下の定義を使うこともできます。</para>
+	以下のマクロを検査することもできます。</para>
 
 <programlisting>
     FreeBSD     __FreeBSD__
@@ -788,8 +792,9 @@
     Solaris     sun, __sun
 </programlisting>
 
-      </sect3><sect3 id="fixes-build-cpp-cpu">
-        <title>CPU に関する CPP 定義</title>
+</sect3>
+<sect3 id="fixes.build.cpp.arch">
+<title>ハードウェアアーキテクチャーを特定するための C プリプロセッサーマクロ</title>
 
 <programlisting>
     i386        i386, __i386, __i386__
@@ -797,72 +802,18 @@
     SPARC       sparc, __sparc
 </programlisting>
 
-      </sect3><sect3 id="fixes-build-cpp-compiler">
-        <title>コンパイラーに関する CPP 定義</title>
+</sect3>
+<sect3 id="fixes.build.cpp.compiler">
+<title>コンパイラーを特定するための C プリプロセッサーマクロ</title>
 
 <programlisting>
     GCC         __GNUC__ (メジャーバージョン), __GNUC_MINOR__
     SunPro      __SUNPRO_C (バージョン 5.7 なら 0x570)
 </programlisting>
 
-      </sect3>
-    </sect2>
-
-    <sect2 id="cpp-list-examples">
-      <title>いくつかのプラットフォームの CPP 定義の例</title>
-
-      <para>CPP のハードウェアおよびオペレーティングシステムの識別用マクロの一覧は、
-      使っているコンパイラーによって異なることがあります。
-      以下に、正しい組合せを選ぶうえで参考になりそうな例をいくつか示します。
-      たとえば、Solaris 上でコードを条件付きコンパイルしたい場合、
-      <varname>__sun__</varname> は
-      SunPro コンパイラーでは定義されていないので使ってはいけません。
-      かわりに <varname>__sun</varname> を使います。</para>
-
-      <variablelist>
-	<varlistentry><term>GCC 3.3.3 + SuSE Linux 9.1 + i386</term>
-        <listitem><para>__ELF__, __gnu_linux__, __i386, __i386__,
-        __linux, __linux__, __unix, __unix__, i386, linux,
-        unix.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 2.95 + NetBSD 1.6.2 + i386</term>
-        <listitem><para>__ELF__, __NetBSD__, __i386, __i386__,
-        i386.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 3.3.3 + NetBSD 2.0 + i386</term>
-        <listitem><para>__ELF__, __NetBSD__, __i386, __i386__,
-        i386.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 4 + Solaris 8 + SPARC</term>
-        <listitem><para>__ELF__, __sparc, __sparc__, __sun, __sun__,
-        __SVR4, __svr4__, __unix, __unix__, sparc, sun,
-        unix.</para></listitem></varlistentry>
-
-	<varlistentry><term>SunPro 5.7 + Solaris 8 + SPARC</term>
-        <listitem><para>__SVR4, __sparc, __sun, __unix, sparc, sun,
-        unix.</para></listitem></varlistentry>
-
-      </variablelist>
-    </sect2>
-
-    <sect2 id="cpp-list">
-      <title>CPP 定義の一覧を調べる</title>
-
-      <para>お使いのシステムが GNU C Compiler を使っている場合は、
-      以下のコマンドを使うと、たとえばプラットフォームを特定するために、
-      標準で定義されているシンボルの一覧を表示することができます。</para>
-
-<programlisting>
-    <![CDATA[gcc -E -dM - < /dev/null ]]>
-</programlisting>
-
-      <para>gcc を使っていないシステムでは、システムコール追跡用ユーティリティー
-      (ktrace, truss, strace) を使って、コンパイラー本体に渡されている引数を調べることで、
-      このような一覧を入手することができます。</para>
-
-    </sect2>
-  </sect1>
-
+</sect3>
+</sect2>
+</sect1>
 
   <sect1 id="package-specific-actions">
     <title>パッケージ特有の機能</title>
@@ -987,6 +938,10 @@
 	  といった指定ができなくなるというものもあります。
 	  これは特に、料金を支払っているライセンスへの同意を示したい場合には不適当です。</para>
     </sect2>
+</sect1>
+
+<sect1 id="fixes.install">
+<title><emphasis>install</emphasis> 相での問題を修正する</title>
 
     <sect2 id="installing-score-files">
       <title>得点ファイルをインストールする</title>
Index: fixes.xml
===================================================================
RCS file: /cvsroot/pkgsrc/doc/guide/files/fixes.xml,v
retrieving revision 1.53
retrieving revision 1.54
diff -u -r1.53 -r1.54
--- fixes.xml	23 May 2006 09:09:13 -0000	1.53
+++ fixes.xml	1 Jun 2006 09:31:18 -0000	1.54
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.53 2006/05/23 09:09:13 rillig Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.54 2006/06/01 09:31:18 rillig Exp $ -->
 
 <chapter id="fixes"> <?dbhtml filename="fixes.html"?>
   <title>Making your package work</title>
@@ -460,8 +460,8 @@
   </sect1>
 
 
-  <sect1 id="downloading-issues">
-    <title>Possible downloading issues</title>
+<sect1 id="fixes.fetch">
+<title>Fixing problems in the <emphasis>fetch</emphasis> phase</title>
 
     <sect2 id="no-plain-download">
       <title>Packages whose distfiles aren't available for plain downloading</title>
@@ -517,8 +517,8 @@
   </sect1>
 
 
-  <sect1 id="configuration-gotchas">
-    <title>Configuration gotchas</title>
+<sect1 id="fixes.configure">
+<title>Fixing problems in the <emphasis>configure</emphasis> phase</title>
 
     <sect2 id="fixes.libtool">
       <title>Shared libraries - libtool</title>
@@ -777,50 +777,55 @@
     </sect2>
   </sect1>
 
+<sect1 id="fixes.build">
+<title>Fixing problems in the <emphasis>build</emphasis> phase</title>
 
-  <sect1 id="fixes-build">
-    <title>Building the package</title>
+	<para>The most common failures when building a package are that
+	some platforms do not provide certain header files, functions or
+	libraries, or they provide the functions in a library that the
+	original package author didn't know. To work around this, you
+	can rewrite the source code in most cases so that it does not
+	use the missing functions or provides a replacement function.</para>
+
+<sect2 id="fixes.build.cpp">
+<title>Compiling C and C++ code conditionally</title>
+
+	<para>If a package already comes with a GNU configure script, the
+	preferred way to fix the build failure is to change the
+	configure script, not the code. In the other cases, you can
+	utilize the C preprocessor, which defines certain macros
+	depending on the operating system and hardware architecture it
+	compiles for. These macros can be queried using for example
+	<varname>#if defined(__i386)</varname>. Almost every operating
+	system, hardware architecture and compiler has its own macro.
+	For example, if the macros <varname>__GNUC__</varname>,
+	<varname>__i386__</varname> and <varname>__NetBSD__</varname>
+	are all defined, you know that you are using NetBSD on an i386
+	compatible CPU, and your compiler is GCC.</para>
+
+	<para>The list of the following macros for hardware and
+	operating system depends on the compiler that is used. For
+	example, if you want to conditionally compile code on Solaris,
+	don't use <varname>__sun__</varname>, as the SunPro compiler
+	does not define it. Use <varname>__sun</varname> instead.</para>
 
-    <sect2 id="cpp-defines">
-      <title>CPP defines</title>
-
-      <para>Sometimes you need to compile different code depending on
-      the target platform. The C preprocessor has a set of predefined
-      macros that can be queried by using <varname>#ifdef FOO</varname>
-      or <varname>#if defined(FOO)</varname>. Among these macros are
-      usually ones that describe the target CPU and operating system.
-      Depending of which of the macros are defined, you can write code
-      that uses features unique to a specific platform. Generally you
-      should rather use the GNU autotools (automake, autoconf, etc.) to
-      check for specific features (like the existence of a header file,
-      a function or a library), but sometimes this is not possible or
-      desired.</para>
-
-      <para>In that case you can use the predefined macros
-      below to configure your code to the platform it runs on. Almost
-      every operating system, hardware architecture and compiler has its
-      own macro. For example, if the macros <varname>__GNUC__</varname>,
-      <varname>__i386__</varname> and <varname>__NetBSD__</varname> are
-      all defined, you know that you are using NetBSD on an i386
-      compatible CPU, and your compiler is GCC.</para>
-
-      <sect3 id="fixes-build-cpp-opsys">
-        <title>CPP defines for operating systems</title>
+<sect3 id="fixes.build.cpp.os">
+<title>C preprocessor macros to identify the operating system</title>
 
         <para>To distinguish between 4.4 BSD-derived systems and the
         rest of the world, you should use the following code.</para>
 
-<programlisting><![CDATA[
-    #include <sys/param.h>
-    #if (defined(BSD) && BSD >= 199306)
+<programlisting>
+    #include &lt;sys/param.h&gt;
+    #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
       /* BSD-specific code goes here */
     #else
       /* non-BSD-specific code goes here */
     #endif
-]]></programlisting>
+</programlisting>
 
-        <para>If this distinction is not fine enough, you can also use
-        the following defines.</para>
+        <para>If this distinction is not fine enough, you can also test
+	for the following macros.</para>
 
 <programlisting>
     FreeBSD     __FreeBSD__
@@ -832,8 +837,9 @@
     Solaris     sun, __sun
 </programlisting>
 
-      </sect3><sect3 id="fixes-build-cpp-cpu">
-        <title>CPP defines for CPUs</title>
+</sect3>
+<sect3 id="fixes.build.cpp.arch">
+<title>C preprocessor macros to identify the hardware architecture</title>
 
 <programlisting>
     i386        i386, __i386, __i386__
@@ -841,72 +847,18 @@
     SPARC       sparc, __sparc
 </programlisting>
 
-      </sect3><sect3 id="fixes-build-cpp-compiler">
-        <title>CPP defines for compilers</title>
+</sect3>
+<sect3 id="fixes.build.cpp.compiler">
+<title>C preprocessor macros to identify the compiler</title>
 
 <programlisting>
     GCC         __GNUC__ (major version), __GNUC_MINOR__
     SunPro      __SUNPRO_C (0x570 for version 5.7)
 </programlisting>
 
-      </sect3>
-    </sect2>
-
-    <sect2 id="cpp-list-examples">
-      <title>Examples of CPP defines for some platforms</title>
-
-      <para>The list of the CPP identification macros for hardware and
-      operating system may depend on the compiler that is used. The
-      following list contains some examples that may help you to choose
-      the right ones. For example, if you want to conditionally compile
-      code on Solaris, don't use <varname>__sun__</varname>, as the
-      SunPro compiler does not define it. Use <varname>__sun</varname>
-      instead.</para>
-
-      <variablelist>
-	<varlistentry><term>GCC 3.3.3 + SuSE Linux 9.1 + i386</term>
-        <listitem><para>__ELF__, __gnu_linux__, __i386, __i386__,
-        __linux, __linux__, __unix, __unix__, i386, linux,
-        unix.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 2.95 + NetBSD 1.6.2 + i386</term>
-        <listitem><para>__ELF__, __NetBSD__, __i386, __i386__,
-        i386.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 3.3.3 + NetBSD 2.0 + i386</term>
-        <listitem><para>__ELF__, __NetBSD__, __i386, __i386__,
-        i386.</para></listitem></varlistentry>
-
-	<varlistentry><term>GCC 4 + Solaris 8 + SPARC</term>
-        <listitem><para>__ELF__, __sparc, __sparc__, __sun, __sun__,
-        __SVR4, __svr4__, __unix, __unix__, sparc, sun,
-        unix.</para></listitem></varlistentry>
-
-	<varlistentry><term>SunPro 5.7 + Solaris 8 + SPARC</term>
-        <listitem><para>__SVR4, __sparc, __sun, __unix, sparc, sun,
-        unix.</para></listitem></varlistentry>
-
-      </variablelist>
-    </sect2>
-
-    <sect2 id="cpp-list">
-      <title>Getting a list of CPP defines</title>
-
-      <para>If your system uses the GNU C Compiler, you can get a list
-      of symbols that are defined by default, e.g. to identify  the
-      platform, with the following command:</para>
-
-<programlisting>
-    <![CDATA[gcc -E -dM - < /dev/null ]]>
-</programlisting>
-
-      <para>On other systems you may get the list by using the system's
-      syscall trace utility (ktrace, truss, strace) to have a look which
-      arguments are passed to the actual compiler.</para>
-
-    </sect2>
-  </sect1>
-
+</sect3>
+</sect2>
+</sect1>
 
   <sect1 id="package-specific-actions">
     <title>Package specific actions</title>
@@ -1032,6 +984,10 @@
 	  be inappropriate when e.g. one accepts a particular license to
 	  indicate to pkgsrc that a fee has been paid.</para>
     </sect2>
+</sect1>
+
+<sect1 id="fixes.install">
+<title>Fixing problems in the <emphasis>install</emphasis> phase</title>
 
     <sect2 id="installing-score-files">
       <title>Installing score files</title>