[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Documentation/pkgsrc/components/chapter.xml: 1.4 -> 1.6
以下のページの更新をしました。ツッコミをお願いします。
Documentation/pkgsrc/components/chapter.xml: 1.4 -> 1.6
金曜日までに異議がなければ、 commit します。
以下、訳と原文の差分です。
--- Documentation/pkgsrc/components/chapter.xml.orig Thu Feb 16 01:10:23 2006
+++ Documentation/pkgsrc/components/chapter.xml Thu Feb 16 01:10:23 2006
@@ -1,6 +1,6 @@
-<!-- $NetBSD: chapter.xml,v 1.4 2003/05/24 04:24:39 grant Exp $ -->
+<!-- $NetBSD: chapter.xml,v 1.6 2003/06/19 13:10:56 grant Exp $ -->
<!-- Based on english version: -->
-<!-- NetBSD: chapter.xml,v 1.4 2003/05/24 04:24:39 grant Exp -->
+<!-- NetBSD: chapter.xml,v 1.6 2003/06/19 13:10:56 grant Exp -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>パッケージコンポーネント - ファイル、ディレクトリー、およびコンテンツ</title>
@@ -9,7 +9,7 @@
イルが存在します。
</para>
-<sect1>
+<sect1 id="components.Makefile">
<title>Makefile</title>
<para>
構築、インストールおよびバイナリー・パッケージの作成は、すべてパッケージの
@@ -51,14 +51,20 @@
<programlisting>${MASTER_SITE_GNU:=subdirectory/name/}</programlisting>
<para>
-(サブディレクトリー名の後のスラッシュ/に注意してください)廃止された
-MASTER_SITE_SUBDIRを使用しても動作しません。
+サブディレクトリー名の後のスラッシュ/に注意してください。
</para>
+<note>
+<varname>MASTER_SITE_SUBDIR</varname> は廃止されましたので、
+<emphasis>もう使わないでください</emphasis>。
+</note>
+
<para>
-パッケージに複数のDISTFILESまたは複数のPATCHFILESがあって、それらの配布元サ
-イトが異なる場合は、SITES_fooを、ファイル"foo"があるURIを列挙したものに設定
-します。"foo"にはサフィックスを含めます。たとえば以下のようにします。
+パッケージに複数の<varname>DISTFILES</varname>または複数の
+<varname>PATCHFILES</varname>があって、それらの配布元サ
+イトが異なる場合は、<varname>SITES_foo</varname>を、ファイル
+<quote>foo</quote>があるURIを列挙したものに設定
+します。<quote>foo</quote>にはサフィックスを含めます。たとえば以下のようにします。
</para>
<programlisting>DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
@@ -67,12 +73,12 @@
http://www.somewhereelse.com/mirror/somehow/</programlisting>
<para>
-なお、通常おこなうような、DISTFILESへのファイルの(置換ではなく)追加をする場
-合は、標準的なDISTFILESのデフォルト設定を明示的におこなわなければなりません。
+なお、通常おこなうような、<varname>DISTFILES</varname>へのファイルの(置換ではなく)追加をする場
+合は、標準的な<varname>DISTFILES</varname>のデフォルト設定を明示的におこなわなければなりません。
</para>
<para>
-現在CATEGORIESの値として以下が使用できます。もし複数にまたがる場合、それら
+現在<varname>CATEGORIES</varname>の値として以下が使用できます。もし複数にまたがる場合、それら
の値はスペースで分けられる必要があります:
</para>
@@ -86,11 +92,6 @@
x11</programlisting>
<para>
-全ての利用できるオプション、および変数の記述に関しては、NetBSD packages(7)
-マニュアルページを参照してください。 XXX
-</para>
-
-<para>
以下の事柄に気を配ってください。:
</para>
@@ -98,7 +99,7 @@
<listitem>
<para>
もしパッケージによりマニュアルページが圧縮され
-た形式でインストールされる場合、MANCOMPRESSEDを追加してください。
+た形式でインストールされる場合、<varname>MANCOMPRESSED</varname>を追加してください。
bsd.pkg.mkのコメントを参照。
</para>
</listitem>
@@ -110,34 +111,35 @@
</listitem>
<listitem>
<para>
-もし、パッケージがinfoファイルをインストールするのであれば、この文書の
-`infoファイルが附属するパッケージ'節を参照してください。 XXX # link
+もし、パッケージがinfoファイルをインストールするのであれば、
+<xref linkend="features.info-files"/>を参照してください。
</para>
</listitem>
<listitem>
<para>
もしあなたが将来の更新のために、そのパッケージをメンテナンスするつもりで
-あれば、MAINTAINERにあなたのメールアドレスをセットしてください。標準では
-MAINTAINERは<email>packages@NetBSD.org</email>にセットします。
+あれば、<varname>MAINTAINER</varname>にあなたのメールアドレスをセットしてください。標準では
+MAINTAINERは<email>tech-pkg@NetBSD.org</email>にセットします。
</para>
</listitem>
<listitem>
<para>
-もし問題のソフトウェアにホームページが存在するのであれば、MAINTAINERの後
-ろにHOMEPAGEを追加してください。HOMEPAGEの値はホームページのURLにしてく
-ださい。
+もし問題のソフトウェアにホームページが存在するのであれば、
+<varname>MAINTAINER</varname>の後ろに
+<varname>HOMEPAGE</varname>を追加してください。
+<varname>HOMEPAGE</varname>の値はホームページのURLにしてください。
</para>
</listitem>
<listitem>
<para>
-パッケージの短い説明をCOMMENT変数に設定してください。
+パッケージの短い説明を<varname>COMMENT</varname>変数に設定してください。
</para>
</listitem>
</itemizedlist>
</sect1>
-<sect1>
+<sect1 id="components.distinfo">
<title>distinfo</title>
<para>
最も重要で必須な、パッケージのコンパイルに必要なすべてのdistfileのメッセー
@@ -152,10 +154,9 @@
ティーは、distinfoファイル用のダイジェストをすべて計算してくれますし、さま
ざまなアルゴリズムにも対応しています。現在、以下のアルゴリズムに対応してい
ます:
-</para>
-
-<para>
- md5, rmd160, sha1, sha256, sha384, sha512
+<emphasis>md5</emphasis>, <emphasis>rmd160</emphasis>,
+<emphasis>sha1</emphasis>, <emphasis>sha256</emphasis>,
+<emphasis>sha384</emphasis>, <emphasis>sha512</emphasis>
</para>
<para>
@@ -166,8 +167,9 @@
</para>
<para>
-<filename>patches/</filename>ディレクトリー(セクション4.3参照)に入っている、公式なすべてのパッチ
-のメッセージダイジェスト/チェックサムも、このdistinfoファイルに格納されます。
+<filename>patches/</filename>ディレクトリー(<xref
+linkend="components.patches"/>参照)に入っている、公式なすべてのパッチ
+のメッセージダイジェスト/チェックサムも、この<filename>distinfo</filename>ファイルに格納されます。
これは、パッチ中のNetBSD RCS Idを除いたすべての行のメッセージダイジェスト/
チェックサムです。このファイルは<command>make makepatchsum</command>コマンドにより生成するこ
とができます。
@@ -180,14 +182,16 @@
このディレクトリーは、patch(1)コマンドが使用するファイルを含んでい
ます。このファイルは、配布ファイルのソースをNetBSD上で完全にコンパイルして
実行できるように変更するためのものです。これらのファイルは、アルファベット
-順(シェルによる"patches/patch-*"展開順)で適用されます。つまりpatch-aaは
-patch-abより前に適用されます。
+順(シェルによる
+<quote>patches/patch-*</quote>
+展開順)で適用されます。つまり<filename>patch-aa</filename>は
+<filename>patch-ab</filename>より前に適用されます。
</para>
<para>
問題を避けるため、patch-??ファイルは<command>diff -bu</command>フォーマットとし、かつ、曖昧
さなしで適用できるようにします。(曖昧さがあっても強制的にパッチを適用させる
-ため、PATCH_FUZZ_FACTOR=-F2を設定することができます)。なお、将来の変更が難
+ため、<varname>PATCH_FUZZ_FACTOR=-F2</varname>を設定することができます)。なお、将来の変更が難
しくなってしまうので、一つのパッチファイルに、複数のファイルへの変更を入れ
るのは止めてください。
</para>
@@ -200,21 +204,14 @@
<para>
一つ重要なこととして、NetBSD CVSツリーにチェックインした後に問題を引き起こ
-すので、パッチファイルにRCS IDを含ませないように注意してください。これを避
-けるためには、diffに"-U 2"または"-U 1"オプションのどちらかを使ってください。
-あるいは<pkg>pkgtools/pkgdiff</pkg>にある<command>pkgdiff</command>コマンドを使ってください。
-</para>
-
-<para>
-この 2 段落で述べた問題に気を使いたくない場合は、<pkg>pkgtools/pkgdiff</pkg>パッ
-ケージの<command>pkgdiff</command>を使ってください。これはすべてのRCS Idをよきにはからってくれ
-ます。
+すので、パッチファイルにRCS IDを含ませないように注意してください。
+この問題を避けるため、 <pkg>pkgtools/pkgdiff</pkg> パッケージを使ってください。
</para>
<para>
さらに自動化するため、同パッケージのmkpatchesを使ってパッチ一式を作ることを
-おすすめします。あなたがやらねばならないことは、ファイルの編集前に<command>cp -p filename
-filename.orig</command>のようにするか、あるいはさらに簡単に、同パッケージの
+おすすめします。あなたがやらねばならないことは、ファイルの編集前に
+<command>cp -p filename filename.orig</command>のようにするか、あるいはさらに簡単に、同パッケージの
<command>pkgvi</command>を使って、元のファイルを<filename>filename.orig</filename>の名前でバックアップしておくだ
けです。この方法でパッケージをアップグレードした場合、patchdiffを使って、新
しいパッチと既存のパッチを簡単に比較することができます。
@@ -222,19 +219,21 @@
<para>
パッケージを作り終えたとき、忘れずに<command>make makepatchsum</command>コマンドでパッチファ
-イルのチェックサムを生成するようにしてください。セクション4.2を参照してくだ
-さい。 XXX
+イルのチェックサムを生成するようにしてください。<xref linkend="components.distinfo"/>を参照してくだ
+さい。
</para>
<para>
置いておきたいパッチがあるがpkgsrcにcommitすべきものではない場合、それを
-pkgsrcツリーの外の$LOCALPATCHESディレクトリーに置いておくことができます。こ
-のディレクトリーツリーはpkgsrcと同様の"category/package"の構造を持つように
-し、パッチを各パッケージのディレクトリー(すなわち$LOCALPATCHES/$PKGPATH)に
-置くようになっています。たとえば、pkgsrc/graphics/pngに私的なパッチを適用す
-るようにしたい場合は、そのパッチを$LOCALPATCHES/graphics/png/mypatchに置き
+pkgsrcツリーの外の
+<filename>$LOCALPATCHES</filename>
+ディレクトリーに置いておくことができます。こ
+のディレクトリーツリーはpkgsrcと同様の<quote>category/package</quote>の構造を持つように
+し、パッチを各パッケージのディレクトリー(すなわち<filename>$LOCALPATCHES/$PKGPATH</filename>)に
+置くようになっています。たとえば、<filename>pkgsrc/graphics/png</filename>に私的なパッチを適用す
+るようにしたい場合は、そのパッチを<filename>$LOCALPATCHES/graphics/png/mypatch</filename>に置き
ます。このディレクトリーにあるファイルはすべてパッチファイルとして扱われ、
-pkgsrcの「標準の」パッチが適用された後に、このパッチが適用されます。
+<emphasis>pkgsrcのパッチが適用された後に、このパッチが適用されます</emphasis>。
</para>
</sect1>
@@ -243,7 +242,7 @@
<itemizedlist>
<listitem>
-<para>DESCR</para>
+<filename>DESCR</filename>
<para>
ソフトウェアについての複数行の説明。このファイルには適切なクレジットを含
めておいてください。他人があなたのユーモアのセンス(あるいは変わった綴り)
@@ -253,7 +252,7 @@
</listitem>
<listitem>
-<para>PLIST</para>
+<filename>PLIST</filename>
<para>
このファイルは、システムにインストールされるファイルを管理します:すべて
のバイナリー、マニュアルページ、その他。ディレクトリーの作成、削除、イン
@@ -270,34 +269,35 @@
<itemizedlist>
<listitem>
-<para>INSTALL</para>
+<filename>INSTALL</filename>
<para>
- このシェル・スクリプトはpkg_add実行中に二度起動されます。最初は、パッケー
- ジが展開された後、ファイルが移動される前に、二度目はインストールするファ
- イルが移動された後。このファイルは、PLIST内の@execコマンドでは不可能な特
- 別な処理のために使うことができます。より詳細な情報はpkg_add(1)と
- pkg_create(1)を参照してください。
+ このシェル・スクリプトはpkg_add実行中に二度起動されます。最初は、パッケー
+ ジが展開された後、ファイルが移動される前に、二度目はインストールするファ
+ イルが移動された後。このファイルは、
+ <filename>PLIST</filename>内の@execコマンドでは不可能な特
+ 別な処理のために使うことができます。より詳細な情報はpkg_add(1)と
+ pkg_create(1)を参照してください。
</para>
</listitem>
<listitem>
-<para>DEINSTALL</para>
+<filename>DEINSTALL</filename>
<para>
- このスクリプトは、ファイルが削除される前後に実行されます。このスクリプト
- の責任は、パッケージのインストレーションにかかわる雑多なものをきれいにす
- ることです。なぜなら、pkg_deleteは、オリジナルのディストリビューションで
- 作成されたファイルをどのように削除するかをすべて知っておかなければならな
- いからです。より詳細な情報はpkg_add(1)とpkg_create(1)を参照してください。
+ このスクリプトは、ファイルが削除される前後に実行されます。このスクリプト
+ の責任は、パッケージのインストレーションにかかわる雑多なものをきれいにす
+ ることです。なぜなら、pkg_deleteは、オリジナルのディストリビューションで
+ 作成されたファイルをどのように削除するかをすべて知っておかなければならな
+ いからです。より詳細な情報はpkg_add(1)とpkg_create(1)を参照してください。
</para>
</listitem>
<listitem>
-<para>MESSAGE</para>
+<filename>MESSAGE</filename>
<para>
- パッケージのインストール後にこのファイルの内容が表示されます。
- 完全にフリーでないソフトウェアについての法的な通知等に役立ちます。
- パッケージのMakefileでMESSAGE_SUBSTを使うことで、変数を簡単に変えられる
- ことに注意してください:
+ パッケージのインストール後にこのファイルの内容が表示されます。
+ 完全にフリーでないソフトウェアについての法的な通知等に役立ちます。
+ パッケージのMakefileで<varname>MESSAGE_SUBST</varname>を使うことで、変数を簡単に変えられる
+ ことに注意してください:
</para>
<programlisting>MESSAGE_SUBST+= SOMEVAR="somevalue"</programlisting>
@@ -311,15 +311,13 @@
</sect1>
<sect1>
-<title>work*</title>
+<title><filename>work*</filename></title>
<para>
<command>make</command>とタイプした時に、配布ファイルがこのディレクトリーに展開されます。
-シェル・プロンプトで、以下のようにタイプすれば、これらを削除することができ
-ます。
+<command>make clean</command>
+を実行すれば、これらを削除することができます。
</para>
-<screen># make clean</screen>
-
<para>
また、このディレクトリーはさまざまなタイムスタンプ・ファイルを作っておくた
めにも使用されます。
@@ -327,7 +325,7 @@
</sect1>
<sect1>
-<title>files/*</title>
+<title><filename>files/*</filename></title>
<para>
また、もしあなたがコンフィギュレーションまたは構築するより前に、パッケージ
中に何かファイルを置きたいならば、それらのファイルをfilesディレクトリーに置
@@ -348,7 +346,7 @@
<sect2>
<title>${INSTALL}, ${INSTALL_DATA_DIR}, ...</title>
<para>
-一部のプラットフォームに附属する BSD 互換の <filename>install</filename> は、
+一部のプラットフォームに附属する BSD 互換の <command>install</command> は、
一度に複数の操作をおこなうことができません。
このため、 ${INSTALL} などを使うときは、以下のようにします。
</para>
@@ -357,11 +355,13 @@
${INSTALL_DATA_DIR} ${PREFIX}/dir2</programlisting>
</sect2>
+<!--
<sect2>
XXX more portability stuff
XXX USE_PKGLOCALEDIR
XXX ???
</sect2>
+-->
</sect1>
Index: Documentation/pkgsrc/components/chapter.xml
===================================================================
RCS file: /cvsroot/htdocs/Documentation/pkgsrc/components/Attic/chapter.xml,v
retrieving revision 1.4
retrieving revision 1.6
diff -u -r1.4 -r1.6
--- Documentation/pkgsrc/components/chapter.xml 24 May 2003 04:24:39 -0000 1.4
+++ Documentation/pkgsrc/components/chapter.xml 19 Jun 2003 13:10:56 -0000 1.6
@@ -1,4 +1,4 @@
-<!-- $NetBSD: chapter.xml,v 1.4 2003/05/24 04:24:39 grant Exp $ -->
+<!-- $NetBSD: chapter.xml,v 1.6 2003/06/19 13:10:56 grant Exp $ -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>Package components - files, directories and contents</title>
@@ -7,7 +7,7 @@
which are described in the following sections.
</para>
-<sect1>
+<sect1 id="components.Makefile">
<title>Makefile</title>
<para>
Building, installation and creation of a binary package are all controlled
@@ -53,13 +53,19 @@
<programlisting>${MASTER_SITE_GNU:=subdirectory/name/}</programlisting>
<para>
-(Note the trailing slash after the subdirectory name.) Use of the deprecated
-MASTER_SITE_SUBDIR will not work.
+Note the trailing slash after the subdirectory name.
</para>
+<note>
+<varname>MASTER_SITE_SUBDIR</varname> has been deprecated and
+<emphasis>should no longer be used</emphasis>.
+</note>
+
<para>
-If the package has multiple DISTFILES or multiple PATCHFILES from different
-sites, set SITES_foo to a list of URI's where file "foo" may be found. "foo"
+If the package has multiple <varname>DISTFILES</varname> or multiple
+<varname>PATCHFILES</varname> from different
+sites, set <varname>SITES_foo</varname> to a list of URI's where file
+<quote>foo</quote> may be found. <quote>foo</quote>
includes the suffix, e.g.
</para>
@@ -69,12 +75,14 @@
http://www.somewhereelse.com/mirror/somehow/</programlisting>
<para>
-Note that the normal default setting of DISTFILES must be made explicit
-if you want to add to it (rather than replace it), as you usually would.
+Note that the normal default setting of <varname>DISTFILES</varname> must
+be made explicit if you want to add to it (rather than replace it), as
+you usually would.
</para>
<para>
-Currently the following values are available for CATEGORIES. If more than
+Currently the following values are available for
+<varname>CATEGORIES</varname>. If more than
one is used, they need to be separated by spaces:
</para>
@@ -88,57 +96,54 @@
x11</programlisting>
<para>
-See the NetBSD packages(7) manual page for a description of all available
-options and variables. XXX
-</para>
-
-<para>
Please pay attention to the following gotchas:
</para>
<itemizedlist>
<listitem>
<para>
-Add MANCOMPRESSED if manpages are installed in compressed form by
-the package; see comment in bsd.pkg.mk
+Add <varname>MANCOMPRESSED</varname> if manpages are installed in
+compressed form by the package; see comment in bsd.pkg.mk.
</para>
</listitem>
<listitem>
<para>
-Replace <filename>/usr/local</filename> by ${PREFIX} in all files (see patches, below)
+Replace <filename>/usr/local</filename> with ${PREFIX} in all files (see
+patches, below).
</para>
</listitem>
<listitem>
<para>
-If the package installs any info files, see the section `Packages providing
-info files' in this document. XXX # link
+If the package installs any info files, see
+<xref linkend="features.info-files"/>.
</para>
</listitem>
<listitem>
<para>
-Adjust MAINTAINER to be either yourself, if you plan to maintain the
-package for future updates, or set it to the default MAINTAINER
-<email>packages@NetBSD.org</email>.
+Adjust <varname>MAINTAINER</varname> to be either yourself, if you plan
+to maintain the package for future updates, or set it to the default
+maintainer <email>tech-pkg@NetBSD.org</email>.
</para>
</listitem>
<listitem>
<para>
If there exists a home page for the software in question, please
-add the variable HOMEPAGE right after MAINTAINER. The value of this
+add the variable <varname>HOMEPAGE</varname> right after
+<varname>MAINTAINER</varname>. The value of this
variable should be the URL for the home page.
</para>
</listitem>
<listitem>
<para>
-Be sure to set the COMMENT variable to a short description of the
-package.
+Be sure to set the <varname>COMMENT</varname> variable to a short
+description of the package.
</para>
</listitem>
</itemizedlist>
</sect1>
-<sect1>
+<sect1 id="components.distinfo">
<title>distinfo</title>
<para>
Most important, the mandatory message digest, or checksum, of all the
@@ -153,10 +158,9 @@
The <pkg>pkgtools/digest</pkg> utility calculates all of the digests
in the distinfo file, and it provides various different algorithms.
At the current time, the algorithms provided are:
-</para>
-
-<para>
- md5, rmd160, sha1, sha256, sha384 and sha512
+<emphasis>md5</emphasis>, <emphasis>rmd160</emphasis>,
+<emphasis>sha1</emphasis>, <emphasis>sha256</emphasis>,
+<emphasis>sha384</emphasis> and <emphasis>sha512</emphasis>.
</para>
<para>
@@ -168,10 +172,11 @@
<para>
The message digest/checksum for all the official patches found in the
-<filename>patches/</filename> directory (see section 4.3) for the package is also stored in
-the distinfo file. This is a message digest/checksum of all lines in
-the patch file except the NetBSD RCS Id. This file is generated by
-invoking <command>make makepatchsum</command>.
+<filename>patches/</filename> directory (see <xref
+linkend="components.patches"/>) for the package is also stored in
+the <filename>distinfo</filename> file. This is a message
+digest/checksum of all lines in the patch file except the NetBSD RCS Id.
+This file is generated by invoking <command>make makepatchsum</command>.
</para>
</sect1>
@@ -181,16 +186,19 @@
This directory contains files that are used by the patch(1) command to
modify the sources as distributed in the distribution file into a form that
will compile and run perfectly on NetBSD. The files are applied
-successively in alphabetic order (as returned by a shell "patches/patch-*"
-glob expansion), so patch-aa is applied before patch-ab etc.
+successively in alphabetic order (as returned by a shell
+<quote>patches/patch-*</quote>
+glob expansion), so <filename>patch-aa</filename> is applied before
+<filename>patch-ab</filename>, etc.
</para>
<para>
-The patch-?? files should be in <command>diff -bu</command> format, and apply without
+The patch-?? files should be in <command>diff -bu</command> format, and
+apply without
a fuzz to avoid problems (To force patches to apply with fuzz you
-can set PATCH_FUZZ_FACTOR=-F2). Furthermore, do not put changes
-for more than one file into a single patch-file, as this will make
-future modifications more difficult.
+can set <varname>PATCH_FUZZ_FACTOR=-F2</varname>). Furthermore, do not
+put changes for more than one file into a single patch-file, as this will
+make future modifications more difficult.
</para>
<para>
@@ -202,43 +210,39 @@
<para>
One important thing to mention is to pay attention that no RCS IDs
get stored in the patch files, as these will cause problems when
-later checked into the NetBSD CVS tree. To avoid this, use either
-the "-U 2" or "-U 1" option to diff, or let the <command>pkgdiff</command> command
-from <pkg>pkgtools/pkgdiff</pkg> help you.
-</para>
-
-<para>
-If you don't want to worry about the problems in the last two paragraphs
-yourself, use <command>pkgdiff</command> from the
-<pkg>pkgtools/pkgdiff</pkg> package, which takes care of any RCS Ids by
-itself.
+later checked into the NetBSD CVS tree. Use the
+<pkg>pkgtools/pkgdiff</pkg> package to avoid these problems.
</para>
<para>
For even more automation, we recommend using mkpatches from the same
package to make a whole set of patches. You just have to backup files
-before you edit them to <filename>filename.orig</filename>, e.g. with <command>cp -p filename
-filename.orig</command> or, easier, by using <command>pkgvi</command> from the same package. If you
-upgrade a package this way, you can easily compare the new set of patches
-with the previously existing one with patchdiff.
+before you edit them to <filename>filename.orig</filename>, e.g. with
+<command>cp -p filename filename.orig</command> or, easier, by using
+<command>pkgvi</command> from the same package. If you upgrade a package
+this way, you can easily compare the new set of patches with the
+previously existing one with patchdiff.
</para>
<para>
When you have finished a package, remember to generate the checksums
-for the patch files by using the <command>make makepatchsum</command> command, see
-section 4.2. XXX
+for the patch files by using the <command>make makepatchsum</command> command,
+see <xref linkend="components.distinfo"/>.
</para>
<para>
If it is desired to store any patches that should not be committed into
-pkgsrc, they can be kept outside the pkgsrc tree in the $LOCALPATCHES
+pkgsrc, they can be kept outside the pkgsrc tree in the
+<filename>$LOCALPATCHES</filename>
directory. The directory tree there is expected to have the same
-"category/package" structure as pkgsrc, and patches are expected to be
-stored inside these dirs (also known as $LOCALPATCHES/$PKGPATH). For
-example if you want to keep a private patch for pkgsrc/graphics/png, keep
-it in $LOCALPATCHES/graphics/png/mypatch. All files in the named directory
-are expected to be patch files, and they are applied after the "normal"
-pkgsrc patches are applied.
+<quote>category/package</quote> structure as pkgsrc, and patches are
+expected to be stored inside these dirs (also known as
+<filename>$LOCALPATCHES/$PKGPATH</filename>). For
+example if you want to keep a private patch for
+<filename>pkgsrc/graphics/png</filename>, keep
+it in <filename>$LOCALPATCHES/graphics/png/mypatch</filename>. All files
+in the named directory are expected to be patch files, and <emphasis>they
+are applied after pkgsrc patches are applied</emphasis>.
</para>
</sect1>
@@ -247,7 +251,7 @@
<itemizedlist>
<listitem>
-<para>DESCR</para>
+<filename>DESCR</filename>
<para>
A multi-line description of the piece of software. This should include
any credits where they are due. Please bear in mind that others do not
@@ -257,7 +261,7 @@
</listitem>
<listitem>
-<para>PLIST</para>
+<filename>PLIST</filename>
<para>
This file governs the files that are installed on your system: all the
binaries, manual pages, etc. There are other directives which may be
@@ -274,34 +278,35 @@
<itemizedlist>
<listitem>
-<para>INSTALL</para>
+<filename>INSTALL</filename>
<para>
- Shell script invoked twice during pkg_add. First time after package
- extraction and before files are moved in place, the second time after
- the files to install are moved in place. This can be used to do any
- custom procedures not possible with @exec commands in PLIST. See
- pkg_add(1) and pkg_create(1) for more information.
+ Shell script invoked twice during pkg_add. First time after package
+ extraction and before files are moved in place, the second time after
+ the files to install are moved in place. This can be used to do any
+ custom procedures not possible with @exec commands in
+ <filename>PLIST</filename>. See
+ pkg_add(1) and pkg_create(1) for more information.
</para>
</listitem>
<listitem>
-<para>DEINSTALL</para>
+<filename>DEINSTALL</filename>
<para>
- This script is executed before and after any files are removed. It is
- this script's responsibility to clean up any additional messy details
- around the package's installation, since all pkg_delete knows is how to
- delete the files created in the original distribution. See pkg_delete(1)
- and pkg_create(1) for more information.
+ This script is executed before and after any files are removed. It is
+ this script's responsibility to clean up any additional messy details
+ around the package's installation, since all pkg_delete knows is how to
+ delete the files created in the original distribution. See pkg_delete(1)
+ and pkg_create(1) for more information.
</para>
</listitem>
<listitem>
-<para>MESSAGE</para>
+<filename>MESSAGE</filename>
<para>
- Display this file after installation of the package.
- Useful for things like legal notices on almost-free software, etc.
- Please note that you can modify variables in it easily by using
- MESSAGE_SUBST in the package's Makefile:
+ Display this file after installation of the package.
+ Useful for things like legal notices on almost-free software, etc.
+ Please note that you can modify variables in it easily by using
+ <varname>MESSAGE_SUBST</varname> in the package's Makefile:
</para>
<programlisting>MESSAGE_SUBST+= SOMEVAR="somevalue"</programlisting>
@@ -315,22 +320,20 @@
</sect1>
<sect1>
-<title>work*</title>
+<title><filename>work*</filename></title>
<para>
-When you type <command>make</command> the distribution files are unpacked into this
-directory. It can be removed by typing
+When you type <command>make</command> the distribution files are unpacked
+into this directory. It can be removed by running
+<command>make clean</command>.
</para>
-<screen># make clean</screen>
-
<para>
-at the shell prompt. Also, this directory is used to keep various
-timestamp files.
+This directory is also used to keep various timestamp files.
</para>
</sect1>
<sect1>
-<title>files/*</title>
+<title><filename>files/*</filename></title>
<para>
If you have any files that you wish to be placed in the package prior
to configuration or building, you could place these files here and use
@@ -351,7 +354,7 @@
<sect2>
<title>${INSTALL}, ${INSTALL_DATA_DIR}, ...</title>
<para>
-The BSD-compatible <filename>install</filename> supplied with some
+The BSD-compatible <command>install</command> supplied with some
operating systems will not perform more than one operation at a time.
As such, you should call ${INSTALL}, etc. like this:
</para>
@@ -360,11 +363,13 @@
${INSTALL_DATA_DIR} ${PREFIX}/dir2</programlisting>
</sect2>
+<!--
<sect2>
XXX more portability stuff
XXX USE_PKGLOCALEDIR
XXX ???
</sect2>
+-->
</sect1>