[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Documentation/pkgsrc/fixes/chapter.xml: 1.2 -> 1.3
以下のページの更新をしました。ツッコミをお願いします。
Documentation/pkgsrc/fixes/chapter.xml: 1.2 -> 1.3
木曜日までに異議がなければ、 commit します。
> revision 1.3
> date: 2003/06/23 07:03:04; author: grant; state: Exp; lines: +167 -129
> markup, style and typo fixes.
以下、訳と原文それぞれの、
1.2 から字下げと改行位置を調整したものと 1.3 との差分です。
--- chapter.xml.ja.1.2indent2 2006-03-29 21:54:51.000000000 +0900
+++ chapter.xml.ja.1.3 2006-03-29 22:23:18.000000000 +0900
@@ -1,6 +1,6 @@
-<!-- $NetBSD: chapter.xml,v 1.2 2003/06/19 12:42:34 grant Exp $ -->
+<!-- $NetBSD: chapter.xml,v 1.3 2003/06/23 07:03:04 grant Exp $ -->
<!-- Based on english version: -->
-<!-- NetBSD: chapter.xml,v 1.2 2003/06/19 12:42:34 grant Exp -->
+<!-- NetBSD: chapter.xml,v 1.3 2003/06/23 07:03:04 grant Exp -->
<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
<title>パッケージの修正に関する注意</title>
@@ -30,7 +30,7 @@
#endif]]></programlisting>
<para>
- どうか注意して__NetBSD__定義を使って下さい。4.4-liteから派生した他のBSDにな
+ どうか注意して<quote>__NetBSD__</quote>定義を使って下さい。4.4-liteから派生した他のBSDにな
いNetBSD固有の特徴にのみ適用してください。
</para>
</sect1>
@@ -43,9 +43,9 @@
ングの有無すらも異なります。これに対応するためにコマンドそのもの、およびオ
プションがコンパイラー、リンカーなどに渡される必要があります。すべてのマシ
ンで正しく動作させることは非常にむずかしく、テストのためにすべてのマシンを
- 持っていない場合は特にそうでしょう。「libtool」パッケージはこれを助けます。
- 「libtool」はソースファイルから、静的、動的なライブラリー両方を構築する方法
- を知っています。したがって、プラットフォーム独立です。
+ 持っていない場合は特にそうでしょう。<pkg>devel/libtool</pkg>パッケージはこれを助けます。
+ <pkg>devel/libtool</pkg>はソースファイルから、静的、動的なライブラリー両方を構築する方法
+ を<quote>知って</quote>います。したがって、プラットフォーム独立です。
</para>
<para>
@@ -56,15 +56,15 @@
<listitem>
<para>
- USE_LIBTOOL=yesをパッケージのMakefileへ追加します。
+ <varname>USE_LIBTOOL=yes</varname>をパッケージのMakefileへ追加します。
</para>
</listitem>
<listitem>
<para>
- ライブラリーオブジェクトのために、<quote>${LIBTOOL} --mode=compile ${CC}</quote>を${CC}
+ ライブラリーオブジェクトのために、<quote>${LIBTOOL} --mode=compile ${CC}</quote>を<quote>${CC}</quote>
に設定します。ライブラリーが、提供されたMakefileだけを使用して構築される
- のであれば、CCの定義にこれを追加するだけです。このコマンドひとつだけで、
+ のであれば、<varname>CC</varname>の定義にこれを追加するだけです。このコマンドひとつだけで、
PICと非PICのライブラリーオブジェクトを作成します。したがって、共有ライブ
ラリーとそうでないライブラリーの構築規則を別々に記述する必要はありません。
</para>
@@ -79,19 +79,26 @@
<programlisting>${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} -rpath ${PREFIX}/lib -version-info major:minor</programlisting>
<para>
- ライブラリーの拡張子は.laに、オブジェクトの拡張子は.loに変更されることに
- 注意してください。OBJSを必要に応じて変更してください。このコマンドは、必
- 要なものすべて、.a、.so.major.minor、そしてELFのシンボリックリンク(必要
+ ライブラリーの拡張子は<filename>.la</filename>に、オブジェクトの拡張子は
+ <filename>.lo</filename>に変更されることに
+ 注意してください。<varname>OBJS</varname>
+ を必要に応じて変更してください。このコマンドは、必
+ 要なものすべて、
+ <filename>.a</filename>、<filename>.so.major.minor</filename>、
+ そしてELFのシンボリックリンク(必要
なら)を自動的にカレントディレクトリーに作成します。特に、メジャー番号と
- マイナー番号がゼロの場合は、-version-infoをかならず含めるようにしてくだ
+ マイナー番号がゼロの場合は、<quote>-version-info</quote>をかならず含めるようにしてくだ
さい。そうしないとlibtoolは共有ライブラリーのバージョンを取り除きます。
</para>
<para>
また、<quote>-release</quote>オプションは、ある一つの場合に限って、a.outとELF(シンボ
リックリンクを除く)との間で異なる結果をもたらします。
- libfoo-release.so.x.yの形式のELFライブラリーは、a.outプラットフォーム上
- ではlibfoo.so.x.yのシンボリックリンクを持ちます。これは自動的に処理され
+ <quote>libfoo-release.so.<emphasis>x</emphasis>.<emphasis>y</emphasis></quote>
+ の形式のELFライブラリーは、a.outプラットフォーム上
+ では
+ <quote>libfoo.so.<emphasis>x</emphasis>.<emphasis>y</emphasis></quote>
+ のシンボリックリンクを持ちます。これは自動的に処理され
ます。
</para>
@@ -100,35 +107,43 @@
</para>
<para>
- <filename>PLIST</filename>には、.a, .laおよびso, .so.major, .so.major.minorがすべて含まれるべ
- きです。
+ <filename>PLIST</filename>には、
+ <filename>.a</filename>, <filename>.la</filename> および、
+ <filename>.so</filename>,
+ <filename>.so.<emphasis>major</emphasis></filename> と
+ <filename>.so.<emphasis>major</emphasis>.<emphasis>minor</emphasis></filename>
+ ファイルをすべて含めます。
</para>
</listitem>
<listitem>
<para>
- 共有オブジェクト(.so)ファイル(すなわち、dlopen(3)でロードされるファイル
+ 共有オブジェクト(<filename>.so</filename>)ファイル(すなわち、dlopen(3)でロードされるファイル
であって、共有ライブラリーでは*ありません*)のリンク時には、ファイルにバー
ジョンが加えられないようにするため、<quote>-module -avoid-version</quote>を使ってくだ
さい。
</para>
<para>
- <filename>PLIST</filename>にはfoo.soの一覧が加わります。
+ <filename>PLIST</filename>には<filename>foo.so</filename>
+ の一覧が加わります。
</para>
</listitem>
<listitem>
<para>
- インストールする前のライブラリーに依存するプログラムをリンクする時に、cc
- かldの前に<quote>${LIBTOOL} --mode=link</quote>を書いてください。このコマンドは、正
+ インストールする<emphasis>前</emphasis>のライブラリーに依存するプログラムをリンクする時に、
+ <command>cc</command>か<command>ld</command>の前に
+ <quote>${LIBTOOL} --mode=link</quote>を書いてください。このコマンドは、正
しいライブラリー(静的、または共有)を見つけます。ただし、libtoolを使う時
には-Lオプションで相対パスを指定すること(<quote>-L../somelib</quote>のように)ができない
- ことに注意してください。引数として.laファイルを使うように修正しなければ
+ ことに注意してください。引数として<filename>.la</filename>ファイルを使うように修正しなければ
なりません。例えば、
</para>
+<informalexample>
<programlisting>${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib</programlisting>
+</informalexample>
<para>
は、以下のように変更する必要があります。
@@ -143,25 +158,22 @@
<listitem>
<para>
- ライブラリーをインストールするときに、installあるいはcpコマンドの前に
+ ライブラリーをインストールするときに、<command>install</command>
+ あるいは<command>cp</command>コマンドの前に
<quote>${LIBTOOL} --mode=install</quote>を書いて下さい。そしてライブラリーの名前を
- .laに変えてください。例えば、以下のように書く必要があります。
+ <filename>.la</filename>に変えてください。例えば、以下のように書く必要があります。
</para>
+<informalexample>
<programlisting>${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib</programlisting>
+</informalexample>
<para>
- これは、静的リンクのための.a、共有ライブラリー、必要なシンボリックリンク
+ これは、静的リンクのための<filename>.a</filename>、共有ライブラリー、必要なシンボリックリンク
をインストールし、<command>ldconfig</command>を実行します。
</para>
</listitem>
-<listitem>
-<para>
- <filename>PLIST</filename> の中に、.a、.la、そしてso, .so.major, .so.major.minor ファイルを追
- 加してください(以前とはやり方が変わっています)。
-</para>
-</listitem>
</orderedlist>
</sect1>
@@ -169,20 +181,23 @@
<sect1>
<title>すでにlibtoolをサポートしているGNUパッケージでlibtoolを使う</title>
<para>
- パッケージのlibtoolを簡単に回避する方法として、USE_LIBTOOL=yesおよび
- LTCONFIG_OVERRIDE=${WRKSRC}/ltconfigをパッケージのMakefileに追加してくださ
- い。パッケージのlibtoolは、do-configureターゲットでltconfigスクリプトにより
- 作られます。USE_LIBTOOL および LTCONFIG_OVERRIDE が定義されている場合、指定
- されたltconfigは、パッケージのlibtoolのかわりにpkgsrc/devel/libtoolを使うよ
+ パッケージの<emphasis>libtool</emphasis>を簡単に回避する方法として、
+ <varname>USE_LIBTOOL=yes</varname>および
+ <varname>LTCONFIG_OVERRIDE=${WRKSRC}/ltconfig</varname>をパッケージのMakefileに追加してくださ
+ い。パッケージの<emphasis>libtool</emphasis>は、do-configureターゲットでltconfigスクリプトにより
+ 作られます。<varname>USE_LIBTOOL</varname> および
+ <varname>LTCONFIG_OVERRIDE</varname> が定義されている場合、指定
+ されたltconfigは、パッケージのlibtoolのかわりに<pkg>devel/libtool</pkg>を使うよ
う上書きされます。新しい(ltconfigを持たない)バージョンのlibtoolの場合は、上
- で説明したもののかわりにLIBTOOL_OVERRIDE=${WRKSRC}/libtoolを使う必要がある
+ で説明したもののかわりに
+ <varname>LIBTOOL_OVERRIDE=${WRKSRC}/libtool</varname>を使う必要がある
かもしれません。
</para>
<para>
パッケージが動的共有オブジェクトのロードに、libtool (libltdl)のプラットフォー
ム独立なライブラリーを使う場合は、libtoolのbuildlink2.mkをインクルード(さら
- に、USE_BUILDLINK2をYESに設定)してください。
+ に、<varname>USE_BUILDLINK2=YES</varname>を設定)してください。
</para>
<para>
@@ -198,8 +213,8 @@
ている場合は、問題になりません。
<orderedlist>
<listitem>その共有オブジェクトが正しく命名されている。すなわち、
- foo.laではなく
- libfoo.laとなっている。</listitem>
+ <filename>libfoo.la</filename>ではなく
+ <filename>libfoo.la</filename>となっている。</listitem>
<listitem>-dlopenオプションが実行形式のリンク時に使われている。</listitem>
</orderedlist>
</listitem>
@@ -219,7 +234,7 @@
パッケージが、configureスクリプトやmakefileの雛型Makefile.inを再生成するた
めにGNU autoconfまたはautomakeを実行する必要がある場合、これらの実行は
pre-configureターゲットでおこないます。これらのツールの扱いを補助するための
- makefileの断片が二つ、pkgsrc/mk/autoconf.mkおよびpkgsrc/mk/automake.mkで用
+ Makefileの断片が二つ、pkgsrc/mk/autoconf.mkおよびpkgsrc/mk/automake.mkで用
意されています。詳細は、このファイル中のコメントをご覧ください。
</para>
@@ -257,53 +272,62 @@
生成されたファイルに対して、configureプロセスがさらに変更を加える時がありま
すが、この時には構築プロセスが一連のautomakeの手順を再実行しようとします。
configureの段階でさまざまなファイルに手を加えると、この挙動は止められます。
- この挙動が問題が起こす場合は、そのパッケージのMakefileでAUTOMAKE_OVERRIDEを
- NOに設定することができます。
+ この挙動が問題が起こす場合は、そのパッケージのMakefileで
+ <varname>AUTOMAKE_OVERRIDE=NO</varname>を設定することができます。
</para>
</sect1>
<sect1>
<title>パッケージの設定ファイル</title>
<para>
- パッケージの設定ファイルの場所は、${PKG_SYSCONFDIR}として指示され、この値は
- configureおよびbuildのプロセスに渡されます。PKG_SYSCONFDIRは、他のmake変数
+ パッケージの設定ファイルの場所は、<varname>${PKG_SYSCONFDIR}</varname>として指示され、この値は
+ configureおよびbuildのプロセスに渡されます。
+ <varname>PKG_SYSCONFDIR</varname>は、他のmake変数
のさまざまな設定によってカスタマイズすることができます:
</para>
<itemizedlist>
<listitem>
<para>
- PKG_SYSCONFBASEは主たる設定ディレクトリーで、パッケージ用の設定ファイルす
- べてがこれ以下に置かれます。デフォルトは${PREFIX}/etcですが、/etc/mk.conf
- で上書きすることができます。
+ <varname>PKG_SYSCONFBASE</varname>は主たる設定ディレクトリーで、パッケージ用の設定ファイルす
+ べてがこれ以下に置かれます。デフォルトは<filename>${PREFIX}/etc</filename>ですが、
+ <filename>/etc/mk.conf</filename>で上書きすることができます。
</para>
</listitem>
<listitem>
<para>
- PKG_SYSCONFSUBDIRはPKG_SYSCONFBASEのサブディレクトリーで、個々のパッケー
+ <varname>PKG_SYSCONFSUBDIR</varname>は
+ <varname>PKG_SYSCONFBASE</varname>のサブディレクトリーで、個々のパッケー
ジ用の設定ファイルはこの下に置かれます。たとえば、Apacheの設定ファイルは
- すべて、${PKG_SYSCONFBASE}のサブディレクトリー"httpd"の下に置かれます。こ
+ すべて、
+ <varname>${PKG_SYSCONFBASE}</varname>のサブディレクトリー
+ <filename>httpd/</filename>の下に置かれます。こ
れは、パッケージのMakefileで設定することを想定しています。
</para>
</listitem>
<listitem>
<para>
- デフォルトではPKG_SYSCONFDIR=${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}にな
+ デフォルトでは
+ <varname>PKG_SYSCONFDIR=${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</varname>にな
りますが、このデフォルト値は、個々のパッケージに対して
- PKG_SYSCONFDIR.${PKG_SYSCONFVAR} を設定することで上書きすることができます。
- このPKG_SYSCONFVARは、デフォルトでは${PKGBASE}です。これは、パッケージの
+ <varname>PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</varname> を設定することで上書きすることができます。
+ この<varname>PKG_SYSCONFVAR</varname>
+ は、デフォルトでは<varname>${PKGBASE}</varname>です。これは、パッケージの
Makefileで設定するためのものではなく、ユーザーが個々のパッケージについて
- PKG_SYSCONFDIRの設定を特別な場所に上書きするために予約されているものです。
+ <varname>PKG_SYSCONFDIR</varname>の設定を特別な場所に上書きするために予約されているものです。
</para>
</listitem>
</itemizedlist>
<para>
- ユーザーがカスタマイズすべき変数は、PKG_SYSCONFBASEと
- PKG_SYSCONFDIR.${PKG_SYSCONFVAR}だけです。通常、ユーザーはPKG_SYSCONFBASEを
- /etcに設定するか、またはデフォルトの場所の${PREFIX}/etcのままにするでしょう。
+ ユーザーがカスタマイズすべき変数は、
+ <varname>PKG_SYSCONFBASE</varname>と
+ <varname>PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</varname>だけです。通常、ユーザーは
+ <varname>PKG_SYSCONFBASE</varname>を
+ <filename>/etc</filename>に設定するか、またはデフォルトの場所の
+ <filename>${PREFIX}/etc</filename>のままにするでしょう。
</para>
</sect1>
--- chapter.xml.en.1.2indent2 2006-03-29 21:59:43.000000000 +0900
+++ chapter.xml.en.1.3 2006-03-29 02:39:06.000000000 +0900
@@ -1,4 +1,4 @@
-<!-- $NetBSD: chapter.xml,v 1.2 2003/06/19 12:42:34 grant Exp $ -->
+<!-- $NetBSD: chapter.xml,v 1.3 2003/06/23 07:03:04 grant Exp $ -->
<chapter id="fixes"> <?dbhtml filename="fixes.html"?>
<title>Notes on fixes for packages</title>
@@ -29,7 +29,7 @@
#endif]]></programlisting>
<para>
- Please use the __NetBSD__ definition sparingly - it
+ Please use the <quote>__NetBSD__</quote> definition sparingly - it
should only apply to features of NetBSD that are not present in other
4.4-lite derived BSDs.
</para>
@@ -41,10 +41,10 @@
pkgsrc supports many different machines, with different object formats
like a.out and ELF, and varying abilities to do shared library and
dynamic loading at all. To accompany this, varying commands and options
- have to be passed to the compiler, linker etc. to get the Right Thing,
+ have to be passed to the compiler, linker, etc. to get the Right Thing,
which can be pretty annoying especially if you don't have all the
- machines at your hand to test things. The "libtool" pkg
- can help here, as it just "knows" how to build both static
+ machines at your hand to test things. The <pkg>devel/libtool</pkg> pkg
+ can help here, as it just <quote>knows</quote> how to build both static
and dynamic libraries from a set of source files, thus being platform
independent.
</para>
@@ -57,15 +57,15 @@
<listitem>
<para>
- Add USE_LIBTOOL= yes to the package Makefile.
+ Add <varname>USE_LIBTOOL=yes</varname> to the package Makefile.
</para>
</listitem>
<listitem>
<para>
For library objects, use <quote>${LIBTOOL} --mode=compile
- ${CC}</quote> in place of ${CC}. You could even
- add it to the definition of CC, if only
+ ${CC}</quote> in place of <quote>${CC}</quote>. You could even
+ add it to the definition of <varname>CC</varname>, if only
libraries are being built in a given Makefile. This one command
will build both PIC and non-PIC library objects, so you need not
have separate shared and non-shared library rules.
@@ -82,13 +82,13 @@
<programlisting>${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} -rpath ${PREFIX}/lib -version-info major:minor</programlisting>
<para>
- Note that the library is changed to have a .la
+ Note that the library is changed to have a <filename>.la</filename>
extension, and the objects are changed to have a
- .lo extension. Change OBJS
+ <filename>.lo</filename> extension. Change <varname>OBJS</varname>
as necessary. This automatically creates all of the
- .a, .so.major.minor,
+ <filename>.a</filename>, <filename>.so.major.minor</filename>,
and ELF symlinks (if necessary) in the build directory. Be sure
- to include the -version-info especially when major
+ to include <quote>-version-info</quote>, especially when major
and minor are zero, as libtool will otherwise strip off the
shared library version.
</para>
@@ -97,9 +97,9 @@
The <quote>-release</quote> option will produce different results for
a.out and ELF (excluding symlinks) in only one case. An ELF library of
the form
- libfoo-release.so.x.y
+ <quote>libfoo-release.so.<emphasis>x</emphasis>.<emphasis>y</emphasis></quote>
will have a symlink of
- libfoo.so.x.y
+ <quote>libfoo.so.<emphasis>x</emphasis>.<emphasis>y</emphasis></quote>
on an a.out platform. This is handled automatically.
</para>
@@ -109,21 +109,25 @@
</para>
<para>
- <filename>PLIST</filename> should include all of the .a, .la and so,
- .so.major and .so.major.minor entries.
+ In the <filename>PLIST</filename>, include all of the
+ <filename>.a</filename>, <filename>.la</filename>, and
+ <filename>.so</filename>,
+ <filename>.so.<emphasis>major</emphasis></filename> and
+ <filename>.so.<emphasis>major</emphasis>.<emphasis>minor</emphasis></filename>
+ files.
</para>
</listitem>
<listitem>
<para>
- When linking shared object (.so) files,
+ When linking shared object (<filename>.so</filename>) files,
i.e. files that are loaded via dlopen(3), NOT shared libraries,
use <quote>-module -avoid-version</quote> to prevent them
getting version tacked on.
</para>
<para>
- <filename>PLIST</filename> gets the foo.so
+ <filename>PLIST</filename> gets the <filename>foo.so</filename>
entry.
</para>
</listitem>
@@ -131,17 +135,19 @@
<listitem>
<para>
When linking programs that depend on these libraries
- _before_ they are installed, preface the
- cc or ld line with
+ <emphasis>before</emphasis> they are installed, preface the
+ <command>cc</command> or <command>ld</command> line with
<quote>${LIBTOOL} --mode=link</quote>, and
it will find the correct libraries (static or shared), but
please be aware that libtool will not allow you to specify
a relative path in -L (such as <quote>-L../somelib</quote>),
because it expects you to change that argument to be the
- .la file. For example:
+ <filename>.la</filename> file. e.g.
</para>
+<informalexample>
<programlisting>${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib</programlisting>
+</informalexample>
<para>
should be changed to:
@@ -150,33 +156,28 @@
<programlisting>${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la</programlisting>
<para>
- and it will DTRT with the libraries.
+ and it will do the right thing with the libraries.
</para>
</listitem>
<listitem>
<para>
- When installing libraries, preface the install
- or cp command with
+ When installing libraries, preface the <command>install</command>
+ or <command>cp</command> command with
<quote>${LIBTOOL} --mode=install</quote>, and change the library
- name to .la. For example:
+ name to <filename>.la</filename>. e.g.
</para>
+<informalexample>
<programlisting>${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib</programlisting>
+</informalexample>
<para>
- This will install the static .a, shared
+ This will install the static <filename>.a</filename>, shared
library, any needed symlinks, and run <command>ldconfig</command>.
</para>
</listitem>
-<listitem>
-<para>
- In your <filename>PLIST</filename>, include all of the .a, .la, and so,
- .so.major and .so.major.minor files (this is a change from the previous
- behaviour).
-</para>
-</listitem>
</orderedlist>
</sect1>
@@ -184,29 +185,29 @@
<sect1>
<title>Using libtool on GNU packages that already support libtool</title>
<para>
- Add USE_LIBTOOL=yes and
- LTCONFIG_OVERRIDE=${WRKSRC}/ltconfig to the
+ Add <varname>USE_LIBTOOL=yes</varname> and
+ <varname>LTCONFIG_OVERRIDE=${WRKSRC}/ltconfig</varname> to the
package Makefile as the quick way to bypass the pkg's own
- libtool. The pkg's own
- libtool is made by ltconfig script at
- do-configure target. If USE_LIBTOOL and
- LTCONFIG_OVERRIDE are defined, the specified
- ltconfig is overridden, using the pkgsrc/devel/libtool instead of
- the pkg's own libtool. For newer versions of libtool (without
+ <emphasis>libtool</emphasis>. The pkg's own
+ <emphasis>libtool</emphasis> is created by ltconfig script at
+ do-configure target. If <varname>USE_LIBTOOL</varname> and
+ <varname>LTCONFIG_OVERRIDE</varname> are defined, the specified
+ ltconfig is overridden, using <pkg>devel/libtool</pkg> instead of
+ the pkg's own libtool. For newer versions of libtool (without
ltconfig) it may be necessary to use
- LIBTOOL_OVERRIDE=${WRKSRC}/libtool instead.
+ <varname>LIBTOOL_OVERRIDE=${WRKSRC}/libtool</varname> instead.
</para>
<para>
If your package makes use of the platform independent library
for loading dynamic shared objects, that comes with libtool
(libltdl), you should include the libtool buildlink2.mk (and
- set USE_BUILDLINK2 to YES).
+ set <varname>USE_BUILDLINK2=YES</varname>).
</para>
<para>
Some packages use libtool incorrectly so that the package may not work or
- build in some circumstances. Some common errors are
+ build in some circumstances. Some of the more common errors are:
</para>
<itemizedlist>
@@ -216,8 +217,8 @@
has been done:
<orderedlist>
<listitem>The shared object is named correctly, i.e.
- libfoo.la and
- not foo.la</listitem>
+ <filename>libfoo.la</filename>, not
+ <filename>foo.la</filename></listitem>
<listitem>The -dlopen option is used when linking an executable.</listitem>
</orderedlist>
</listitem>
@@ -237,7 +238,7 @@
If a package needs GNU autoconf or automake to be executed
to regenerate the configure script and Makefile.in makefile
templates, then they should be executed in a pre-configure
- target. Two makefile fragments are provided in
+ target. Two Makefile fragments are provided in
pkgsrc/mk/autoconf.mk and pkgsrc/mk/automake.mk to help
dealing with these tools. See comments in these files for
details.
@@ -279,7 +280,7 @@
process to try to re-execute the automake sequence. This is
prevented by touching various files in the configure stage. If
this causes problems with your package you can set
- AUTOMAKE_OVERRIDE to NO in the package
+ <varname>AUTOMAKE_OVERRIDE=NO</varname> in the package
Makefile.
</para>
</sect1>
@@ -288,44 +289,44 @@
<title>Package configuration files</title>
<para>
Packages should be taught to look for their configuration
- files in ${PKG_SYSCONFDIR}, which is passed
+ files in <varname>${PKG_SYSCONFDIR}</varname>, which is passed
through to the configure and build processes.
- PKG_SYSCONFDIR may be customized in various
+ <varname>PKG_SYSCONFDIR</varname> may be customized in various
ways by setting other make variables:
</para>
<itemizedlist>
<listitem>
<para>
- PKG_SYSCONFBASE is the main config directory
+ <varname>PKG_SYSCONFBASE</varname> is the main config directory
under which all package configuration files are to be found.
- This defaults to ${PREFIX}/etc, but may
- be overridden in /etc/mk.conf.
+ This defaults to <filename>${PREFIX}/etc</filename>, but may
+ be overridden in <filename>/etc/mk.conf</filename>.
</para>
</listitem>
<listitem>
<para>
- PKG_SYSCONFSUBDIR is the subdirectory of
- PKG_SYSCONFBASE under which the
+ <varname>PKG_SYSCONFSUBDIR</varname> is the subdirectory of
+ <varname>PKG_SYSCONFBASE</varname> under which the
configuration files for a particular package may be found, e.g.
the Apache configuration files may all be found under the
- "httpd" subdirectory of
- ${PKG_SYSCONFBASE}. This is meant to be set in
- a package Makefile.
+ <filename>httpd/</filename> subdirectory of
+ <varname>${PKG_SYSCONFBASE}</varname>. This should be set in
+ the package Makefile.
</para>
</listitem>
<listitem>
<para>
- By default
- PKG_SYSCONFDIR=${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR},
- but the default may be overridden by setting
- PKG_SYSCONFDIR.${PKG_SYSCONFVAR} for a
- particular package, where PKG_SYSCONFVAR
- defaults to ${PKGBASE}. This is not meant to
+ By default,
+ <varname>PKG_SYSCONFDIR=${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</varname>,
+ but this may be overridden by setting
+ <varname>PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</varname> for a
+ particular package, where <varname>PKG_SYSCONFVAR</varname>
+ defaults to <varname>${PKGBASE}</varname>. This is not meant to
be set by a package Makefile, but is reserved for users who wish
- to override the PKG_SYSCONFDIR setting for
+ to override the <varname>PKG_SYSCONFDIR</varname> setting for
a particular package with a special location.
</para>
</listitem>
@@ -333,12 +334,12 @@
<para>
The only variables that users should customize are
- PKG_SYSCONFBASE and
- PKG_SYSCONFDIR.${PKG_SYSCONFVAR}.
+ <varname>PKG_SYSCONFBASE</varname> and
+ <varname>PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</varname>.
Users will typically want to set
- PKG_SYSCONFBASE to
- /etc, or to accept the default location
- of ${PREFIX}/etc.
+ <varname>PKG_SYSCONFBASE</varname> to
+ <filename>/etc</filename>, or to accept the default location
+ of <filename>${PREFIX}/etc</filename>.
</para>
</sect1>