Packaging/Guidelines/ja

= パッケージングガイドライン =

パッケージングを行う際、パッケージに関しての問題を指摘するのはレビューアの責任で、そのパッケージャの責任はレビューアから指摘された問題に対応することです. レビューアとパッケージャは問題の重要度(そのパッケージを公開しないようにするか、リポジトリに追加した後で対応できるかどうか)を判断するために一緒に作業します. パッケージングガイドラインはパッケージング全般に共通する問題やリポジトリに追加すべきかどうかの重要度の判断方法をまとめたものです. これらのガイドラインは無視して良いものではありませんが、とにかく何でも従えば良いと言うものでもありません.

パッケージを作成していて、そのパッケージがガイドラインの一部の内容に従う必要はないと思ったら、どうか Fedora パッケージ委員会へその問題を提示するようにしてください.

どのようなパッケージでもレビューガイドラインに沿って確認しなければならないことを必ず覚えておいてください.

Author:  Tom 'spot' Callaway  (他の多くのドキュメントに基づいています) Revision: 1.00 Initial Draft: Wednesday Feb 23, 2005 Last Revised: Tuesday July 21, 2009

名前付け
パッケージの名前が適切かどうかを判断するために名前付けガイドラインに目を通すべきです.

バージョンとリリース
バージョンとリリースのフィールドへの適切な番号の設定方法は名前付けガイドライン:パッケージバージョンで確認することができます.

法律
Fedora でパッケージングを行う際に考慮する必要がある様々な法的な内容があります.

ライセンス
パッケージのライセンスが適切かどうかを判断するためにライセンスとライセンスガイドラインを再検討すべきです.

外部のコードなしでは使えないパッケージ
ランタイムオペレーティングシステム環境において、ソフトウェアの中には外部のコードがない状態では全く使えないものもあります. そういった依存する外部のコードが、フリーではなく、法的にも認められてないか、バイナリのみ(例外的に認められたファームウェア)の場合、その依存するソフトウェアは Fedora に含めることが認められていません. もし、そのコードの依存関係が Fedora 向けに認められたなら、準必須ソフトウェアとして Fedora に含めてパッケージングされるべきです. 使える状態にするためにインターネットから集めてきたコードをダウンロードするようなソフトウェアは Fedora に含めることが認められていません(適切な依存関係として Fedora にパッケージングすることが認められているコードをダウンロードするかどうかに関係なく認められていません).

また、これはサードパーティのソースからのパッケージ、又はコードがない状態で使えないようなパッケージは Fedora に含めることが認められていないということにもなります.

ビルド済みのバイナリやライブラリは含めない
Fedora のパッケージとして提供する全てのプログラムのバイナリやライブラリは、ソースパッケージに含められたソースコードからビルドされなければなりません. これは次のような理由から必要条件になります.


 * セキュリティ: ソースコードからビルドされていない準パッケージングされたプログラムのバイナリやライブラリは、悪意や危険、単に壊れているといった部分を含む可能性があります. また、パッチの作成もできません.


 * コンパイラフラグ: ソースコードからビルドされていない準パッケージングされたプログラムのバイナリやライブラリは、おそらくはセキュリティや最適化のための標準的な Fedora のコンパイラフラグでコンパイルされていません.

(.mo, .pdf, .png, .ps ファイルのような)コンテンツバイナリはソースコードからリビルドする必要はありません.

もしプログラムのバイナリやライブラリについて何か疑問に思うことがあれば、ここに分かり易い判断基準があります.


 * それは実行可能なものですか？もしそうなら、おそらくはプログラムのバイナリです.
 * それは .so, so.#, .so.#.#.# といった拡張子のファイルを含んでいますか？もしそうなら、それはおそらくプログラムのライブラリです.
 * 疑問に思ったら、レビューアに尋ねてください. レビューアが分からない場合、そのレビューアが Fedora パッケージング委員会へ尋ねるでしょう.

また、ビルドするためにオープンソースではないコンポーネントを要求するパッケージも認められていません. (例 プロプライエタリなコンパイラが必要とか)

あるパッケージ内にビルド済みのバイナリを見つけたら、次のことを守らなければなりません.


 * パッケージのビルドが行われる前に実行される %prep セクションで全てのビルド済みのプログラムのバイナリやライブラリを削除してください. 例としては *.class, *.dll, *.DS_Store, *.exe, *.jar, *.o, *.pyc, *.pyo, *.egg, *.so などのファイルになりますが、これらのファイルのみに限定されるわけではありません.
 * 次のリリース時にバイナリを削除するようにアップストリームにお願いしてください.

例外事項

 * 以前のツールチェーンか、開発環境(オープンソース)を使用しないとビルドできないソフトウェア(通常はコンパイラ、又はクロスコンパイラ環境に関連します)があります. この判断が必要な状況に遭遇したら、承認をもらうために Fedora パッケージング委員会へ連絡してください.
 * バイナリのファームウェアのために作成された拡張機能は、それが必要条件であり続ける限り、ライセンスのバイナリファームウェアに記載されています.
 * 前もってパッケージングされたプログラムのバイナリやライブラリによっては再配布が許可されていない、又は特許のような法的な影響を受ける条項が含まれているかもしれません. そのような状況では、シンプルにそういったファイルを %prep セクションで削除すれば良いというわけではありません. メンテナはそういったファイルを含めないように変更したソースを作成する必要があります. パッケージング:ソース URL のアップストリームが禁止されているコードを使用しているときを参照してください.

Spec ファイルの読み易さ
全ての Fedora パッケージの spec ファイルは読み易い内容でなければなりません. レビューアが spec ファイルを読んで理解できない場合、レビュー作業ができないことになります. Fedora の spec ファイルはコードの難読化コンテストに参加するためのものではありません.

スクラッチからのパッケージ作成
スクラッチからパッケージを作成するとき、Fedora の spec ファイルテンプレート(Rpmdevtools を参照)をベースとして使用すべきです. spec ファイルのフォーマットや構成方法に関しては優先して、できるだけこのテンプレートを確認するようにしてください. その理由はこの spec ファイルが spec ファイルを書く唯一の正しい方法だと信じているからではありません. しかし、テンプレートを使用する方が誤りを発見し易かったり、やりたいことを素早く理解し易かったりするので品質を高めることになるからです.

既存のパッケージからの修正
既存の Fedora パッケージ以外のパッケージをベースにする場合、その正当性の検証とそのパッケージをインストールして使用することで何か問題が発生しないかを厳密に調査するようにしてください. 何か変なことが起こらないかを調査していない状態でパッケージを追加するように提案しないでください. 一見、害が無さそうに見えるコマンドも調査対象になります.

特に次のことをすべきです.
 * 全てのソースとパッチを検証する
 * spec ファイルに記載されているライセンスと実際のソフトウェアのライセンスがあっているかを検証する(タグを参照)
 * 要約とパッケージ説明内容の誤植や奇妙な箇所を修正する(要約とパッケージ説明内容を参照)
 * 正しいビルドルートが使用されているかを確認する
 * マクロの使用方法で一貫性があるかを確認する(マクロを参照)

オリジナルの作成者の履歴である古い changelog のエントリを保持してください. かなり古いバージョンか、何年分ものエントリは削除されるかもしれません. もし根本的な変更を行った場合、いずれにしても spec ファイルの大部分を書き直すことになります. 自由にスクラッチから changelog を書き始めるようにしてください. 言い換えれば、自分で最良の判断をするようにしてください.

アーキテクチャのサポート
全ての Fedora パッケージは少なくとも1つの主要なアーキテクチャをサポートして、ソースのコンパイルとバイナリ RPMS をビルドできなければなりません. Fedora パッケージャは全ての主要なアーキテクチャをサポートするように努めるべきです.

コンテンツ、コンパイル/ビルドを行う必要のないコードやアーキテクチャから独立したコード(noarch)は目立った例外になります.

アーキテクチャの違いによるビルドの失敗
あるアーキテクチャ上でビルドできて動作する Fedora パッケージが他のアーキテクチャでコンパイルに失敗する場合、失敗するアーキテクチャは spec ファイルに  を設定すべきです. に設定された各々のアーキテクチャは、そのアーキテクチャでコンパイル/ビルド/実行に失敗する理由を説明して bugzilla に登録する必要があります. 登録したバグ ID は対応する  行の隣にコメントとして記載すべきです. 新しいパッケージはレビュープロセスの間は bugzilla エントリを持っていないので、そのパッケージが承認されるまでコメントに失敗する理由を記載するようにしてください. そして、承認された後で bugzilla に登録して、記載した長い説明をバグ ID に置き換えてください. そういったバグはシンプルに問題を追跡するために、以下のバグの blocking(もしくはそれ以上) としてマークされます.


 * FE-ExcludeArch-x86
 * FE-ExcludeArch-x64
 * FE-ExcludeArch-ppc
 * FE-ExcludeArch-ppc64
 * F-ExcludeArch-arm
 * F-ExcludeArch-s390x
 * F-ExcludeArch-sparc

ファイルシステムの置き場所
Fedora はファイルシステムの階層に関してファイルシステム階層標準(FHS)に準拠しています. FHS はシステム上のファイルの置き場所を定義します. Fedora パッケージは FHS に準拠しなければなりません. パッケージがレビューされるときに FHS から逸脱していたら正しい置き場所に修正すべきです.

このガイドラインに対して(GNU コーディング標準で特別扱いされている) libexecdir とクロスコンパイラのための /usr/target に目立った例外があります.

libexecdir
ファイルシステム階層標準(FHS)には libexecdir に関しての定義はありませんが、Fedora パッケージはその場所にファイルを置くことができます. libexecdir(Fedora システム上では /usr/libexec)はユーザが使用するというよりも主に他のプログラムによって実行されるように設計された実行プログラムのためのディレクトリとして使用すべきです. Fedora の rpm は libexecdir のためのマクロ、 があります. パッケージャは  のような、パッケージに特化した   のサブディレクトリに libexecdir ファイルを保存することが強く推奨されます.

rpmlint の使用
共通エラーの調査のために rpmlint を実行して、(rpmlint が間違っていない限り発生するエラーも含めて) RPM のエラーを修正するようにしてください. もし rpmlint の出力がよく分からないなら、大半のエラーとワーニングのもっと詳細な情報を取得できる  オプションを付けるようにします. rpmlint パッケージは Fedora のリポジトリで利用可能です.

rpmlint エラー
rpmlint は完全に有効なパッケージだったとしても実行時に多くのゴミ出力を生成することがあります. このセクションでは、必要に応じて修正できるように、たくさん出力されるメッセージを解釈するのに役立つ情報を記載します.


 * : このエラーは spec ファイルで  が定義されていないときに発生します. Fedora では   タグを使用しないので、このエラーは無視することができます.
 * : このエラーはパッケージが署名されていないときに発生します. Fedora は CVS に SRPMS を保存しないので(SRPMS の中に含まれるファイルのみ保存する)、パッケージに署名する必要はありません. そのため、このエラーは無視することができます.
 * : このエラーは spec ファイルの  の内容がピリオドで終わっているときに発生します. ただ、行の最後からピリオドを削除してください.
 * : このエラーはファイル中で DOS の改行が使用されているときに発生します. %prep セクションで sed を使用して  とするか、  で修正してください.
 * : このエラーはよくある誤り検出で、通常は無視されます.

Changelogs
何か変更するときはいつも、パッケージの E-V-R(エポック-バージョン-リリース)を増加させて、changelog エントリに追加してください. changelog はパッケージの履歴を管理するのみでなく、さらにユーザ、仲間のパッケージャ、QA 担当者にあなたが行った変更を見つけ易くなるといった点でも重要です.

個々の変更が Bugzilla のバグに関連する場合、簡易リファレンスのために changelog のエントリにバグ ID を含めてください.

- Added README file (#42).
 * Wed Jun 14 2003 Joe Packager  - 1.0-2

次のフォーマットからどれか1つを使用しなければなりません. - And fix the link syntax.
 * Fri Jun 23 2006 Jesse Keating  - 0.6-4

- And fix the link syntax.
 * Fri Jun 23 2006 Jesse Keating  0.6-4

- 0.6-4 - And fix the link syntax.
 * Fri Jun 23 2006 Jesse Keating 

changelog のエントリは、新たなバージョン番号、追加されたパッチ、その他の spec ファイルの修正、バグや、もしあれば CVE のエントリを含めたリリース間でそのパッケージに対して行われた変更内容の簡潔な要約を記載すべきです. 絶対に変更された全ソースのコピーを CHANGELOG エントリに含めてはいけません. その目的は、多くの技術的な詳細とその変更内容でうんざりさせることなくアップデートされたパッケージで何が変更されたかについて、ユーザへヒントを与えることです. アップストリームの changelog へのリンクは追加情報を望むユーザのために含めることができます.

タグ

 * Packager タグは spec ファイルで使用すべきではありません. パッケージャの正体は changelog のエントリから明らかになります. Packager タグを使用しないことによって、ヘッダにあなたの名前があるのに、誰かがリビルドした良くないバイナリを見なくてすみます. また、www.rpm.org にある Packager タグの Maximum RPM の定義を参照してください. あなた自身がビルドした RPMS のパッケージャについての情報を含める必要があるなら、代わりに  に   を使用するようにしてください.
 * Vendor タグは使用すべきではありません. それはビルドシステムが自動的に設定するようにします.
 * Copyright タグは廃止予定です. ライセンスガイドラインの詳細を確認して、代わりに License タグを使用してください. そのソフトウェアを再配布するライセンスが何になるかに疑問があるなら、アップストリームの作者に連絡してください.
 * Summary タグで記載した内容はビリオドで終わるべきではありません. 文法的な観点からこれが気になるなら、一旦座って、深呼吸して、そして克服してください.
 * 通常は、''Pre (又は $RPM_BUILD_ROOT) を含む %clean セクションを設定しなければなりません. 

Requires
RPM は、例えば Perl モジュールなど、自動的にライブラリの依存関係を調べるというとても素晴らしい機能を持っています. 要するに車輪の再発明をしなくて済みますが、rpm は依存関係のみを教えてくれます. libX11 パッケージのライブラリに依存している状態で rpm が既にその依存関係を取得している場合、通常は明示的に Requires: libX11 と定義する必要はありません.

BuildRequires は違います. 自動的に依存関係を見つける処理はありません. それはつまり、ビルドが成功するために必要なパッケージの機能を明示的に定義しなければなりません. 典型的な例として、BuildRequires に -devel パッケージが定義されます. BuildRequires セクション を参照してください.

時々、ビルドするために gtk+-devel 1.2 かそれ以上のバージョンを要求をするパッケージを見かけます(そして、実行するためには gtk+ 1.2 かそれ以上が必要ですが、それは自動的に扱われます). ここで考慮しておくことが2つあります.

1つ目は、要求する最も低いバージョンのパッケージがかなり古いもので、対象とするディストリビューションのリリースでインストールされているパッケージよりも古いバージョンなら、依存関係にそのバージョンを含める必要は全くありません. そのような例では、利用できるソフトウェアは新しいバージョンで十分です. gtk+-devel 1.2 以上の依存関係におけるバージョンは、(少なくとも)リリース 6.2 以降の全ての Red Hat のディストリビューションには不要です. 大まかなルールとして、そのバージョンを要求しないなら、冗談半分にそのバージョンを追加しないでください.

2つ目は、エポック-バージョン-リリースの比較を堅牢にするためにバージョン指定された依存関係を追加するときに Epoch も定義しなければなりません. パッケージ foo の Epoch をチェックするための簡単な方法は次のように実行します.

rpm --query --qf "%{EPOCH}\n" packagename

典型的な例として、-devel パッケージのために他のパッケージを要求します. 通常は rpm によって自動的に取得されません. foo-devel パッケージが foo-config スクリプトを持っているなら、どのパッケージを foo が要求しているかの強力な手掛かりとして foo-config --libs や foo-config --cflags を実行するようにしてください.

$ gtk-config --cflags -I/usr/include/gtk-1.2 -I/usr/include/glib-1.2 -I/usr/lib/glib/include -I/usr/X11R6/include $ gtk-config --libs -L/usr/lib -L/usr/X11R6/lib -lgtk -lgdk -rdynamic -lgmodule -lglib -ldl -lXi -lXext -lX11 -lm

これは gtk+-devel が次のパッケージを要求していることになります.

Requires: glib-devel libXi-devel libXext-devel libX11-devel

PreReq
パッケージには PreReq を使用しないでください. 昔々、RPM がインストールトランザクションの中でインストールの順番を決定するとき、依存解決のループの中で PreReq は標準の Require よりも "優先" するために使用していました. しかし、現在はこの用途には使用しません.

ファイルの依存関係
rpm にはパッケージの代わりにファイルの依存関係を持つ機能もあります. できるだけ /etc, /bin, /sbin, /usr/bin 又は /usr/sbin 以外でファイルの依存関係を使用しないようにしてください. そのようなディレクトリ以外のファイルの依存関係を使用することは依存関係を探す巨大な xml ファイルをダウンロードして解析するために yum (や repmod 形式を使用するその他の依存関係解決ツール)を必要とします. エンドユーザに待ち時間を取らせないために、ファイルではなくパッケージの依存関係を持たせることで依存関係解決ツールはこの処理を行いません. ファイルの依存関係は、こういった懸念事項よりも優先する他の技術的な検討事項があるときもあります. 特別な例の1つとして %{_libdir}/mozilla/plugins にインストールされるパッケージです. この場合、ただこのディレクトリを所有するために特定ブラウザをパッケージの依存関係に持つと、多くの不要なパッケージを一緒にインストールされてしまいます. そういった依存関係を解決するためにディレクトリを要求する方が良い選択でしょう.

明示的な Requires
明示的な Requires とは spec ファイルでパッケージャが手動で追加した Requires です. パッケージには絶対的に必要な場合を除いてライブラリの明示的な Requires を定義してはいけません. 明示的なライブラリの Requires が必要なときは、そのことを説明するコメントを spec ファイルに残すべきです.

一般的にはライブラリの SONAME の依存関係を自動的に追加する rpmbuild を信頼します. 最近のパッケージ管理ツールは必要なパッケージを探してきて依存関係を解決する機能があります. 特定のパッケージの明示的な依存関係は手動で RPM パッケージをインストールしようとしている経験の浅いユーザにとっては助けになるかもしれません. しかし、ライブラリ/ファイルをあるパッケージから別のものに移行した場合、パッケージ名が変更された場合、複数の代替パッケージのうち1つだけあれば十分な場合、バージョン指定された明示的な依存関係が古くなってしまった場合など、このような依存関係は混乱を招くことがこれまでの歴史から分かっています. さらに、あるケースでは、古い明示的な依存関係が不要なアップデート/リビルドを要求します. 例えば、Fedora パッケージは2回のフルリリースサイクル向けに、過去の Provides を維持するためにのみ Requires します.

バージョン指定された明示的な依存関係のための模範的な定義は次の通りです.

# libfubar.so.1 の自動検出される依存関係は十分ではありません # 最低でも2つのセグメンテーションフォールトを修正したリリースを厳密に必要とします Requires: libfubar >= 0:1.2.3-7

パッケージャは明示的な依存関係が不正確で余分なものにならないように、必要に応じて見直すべきです. 上述した例において、現時点の Fedora リリースが libfubar < 1.2.3-7 を提供していないなら、この明示的なバージョン指定された依存関係を今後も残しておく必要はありません.

自動生成された Requires/Provides を取り除く
RPM は Requires/Provides をビルド時に自動生成しようとしますが、状況によっては、自動生成された Requires/Provides は正しくないものか、望まないものです. 自動生成された Requires/Provides を取り除く方法の詳細については Packaging:AutoProvidesAndRequiresFiltering を参照してください.

BuildRequires
パッケージ開発やテストの中で、ビルドに必要な依存関係が欠落していないかを検証してください. 適切なビルドのための依存関係を定義することは自動ビルドシステムと同様に、全ての開発者とテスターの作業を効率化します. というのは、手動で欠落したビルドの依存関係を探す必要がないからです. また、それは何らかの要因によるビルドエラーではなく、極めて重要な機能を欠落させた状態でビルドしないようにするための安全な機能です. 例えば、グラフのアプリケーションは、そのパッケージの configure スクリプトによって libpng がインストールされていないことを検出すると PNG サポートを排除するかもしれません.

Build Requires を検出する方法として2つの方法が提案されています. rpmdev-rmdevelrpms と mock です. rpmdev-rmdevelrpms はシステムから全ての開発関連パッケージを削除するように設計されています. もしビルドに失敗するか、ビルドのための依存関係が欠落して特定の機能がなくなってしまったら、欠落した依存関係を探して追加されます. 詳細は rpmdev-rmdevelrpms セクションを参照してください.  mock はビルドの依存関係を確認する優れたもう1つの方法です. 全ての開発関連パッケージ削除するよりも、chroot を行ってパッケージをビルドしようとします. その方法だと、通常の、毎日使用する環境を変更する必要はありません. そして、パッケージが正常にビルドされることを確認します. しかし、mock は要求された全てのパッケージをダウンロードするためにインターネットとの接続が必要です. MockTricks に詳細があります. 他に mock に似たツールで、 mach も Fedora のリポジトリで利用することができます.

rpmdev-rmdevelrpms
rpmdevtools ツールキットに含まれている rpmdev-rmdevelrpms スクリプトは、欠落した Build Requires に定義しているパッケージは yum で再インストールしてください. もしこの時点でビルドに失敗したら、ビルド処理を調査する必要があります. そして、エラーログから欠落した Build としての依存関係は、一般的によく使用されるので spec ファイルに定義する必要はありません. これらのパッケージは最小ビルド環境として認識されています.

bash bzip2 coreutils cpio diffutils fedora-release findutils gawk gcc gcc-c++ grep gzip info make patch redhat-rpm-config rpm-build sed shadow-utils tar unzip util-linux-ng which

要約とパッケージ説明
要約は短くパッケージの説明内容を簡潔にしたものにすべきです. パッケージ説明は要約から発展させます. パッケージ説明にインストールガイドを含めないでください. それはマニュアルではありません. パッケージが手動設定か、ユーザに対する重要なインストールガイドを必要とするなら、パッケージのドキュメントを参照させるようにしてください. 必要だと思ったら README.Fedora か、似たようなものを追加してください. また、パッケージ説明の1行は80文字以上にならないように注意してください.

個人的な優先度は置いておいて、要約やパッケージ説明にはアメリカ英語のつづりを使用してください. パッケージには、可能なら非英語圏のために翻訳された要約やパッケージ説明を追加で含めることもできます.

要約やパッケージ説明内容の商標
パッケージャは要約やパッケージ説明に商標を使用する方法に注意すべきです. 次にルールがあります.


 * 決して "(TM)"、"(R)" (又はユニコードの ™/®) を使用しないでください. これらのマークを適切に使用するには信じられないぐらい複雑です. そのため、これらのマークを全く使用しないのが我々にとっては安全です.
 * 曖昧ではない方法で商標を使用してください. "似ている" とか "ような" というフレーズは避けてください. 例があります.
 * 悪い例: Adobe Photoshop に似たものです
 * 良い例: Adobe Photoshop の PSD ファイルをサポートします ...
 * 悪い例: Microsoft Office の Linux バージョンです
 * 良い例: Microsoft Office の DOC ファイルをサポートするワードプロセッサです

あなたがよく分からないなら、誰かが混乱する可能性はないかと自問してください. そして、このパッケージは商標が必要かを考えてください. 疑問に思ったら、商標を外すようにしてください.

文字エンコーディング
外で文字を使用する必要がない限り、spec ファイルのエンコーディングについて考慮する必要はないでしょう. ASCII 文字以外を使用する必要があるなら、UTF-8 で spec ファイルを記述するようにしてください. ASCII 文字が何なのか分からないなら、を参照してください.

ASCII 文字ではないファイル名
同様に、ASCII 文字以外の文字を含むファイル名は UTF-8 でエンコードされなければなりません. ファイル名が何のエンコーディングかを設定する方法がないので、全てのファイル名に同じエンコーディングを使用することがユーザがファイル名を読めることを保証するために最も良い方法です. もしアップストリームが UTF-8 でエンコードされていないファイル名でリリースしていたら、%install セクションで(convmv パッケージにある)convmv のようなユーティリティを使用してファイル名を変換することができます.

ドキュメント
配布されているソースに含まれる、いかなる関連ドキュメントもパッケージ内に含まれるべきです. ビルド方法については無関係なドキュメントもあります. よくある INSTALL ファイルは一般的なビルド方法について記載していたり、例えば、README.MSDOS のように Linux 以外のシステムのドキュメントがあったりします. どのサブパッケージにドキュメントを含めるかにも注意を払ってください. 例えば、API の例に関するドキュメントは -devel パッケージに含めて、メインパッケージには含めません. さらに大量にドキュメントがあるなら、サブパッケージに分割することを検討してください. この例では、サブパッケージの名前として  が推奨されます. そして  タグの設定は   になります.

また、あるパッケージが  にドキュメントを含んでいるなら、アプリケーションの実行に影響を与えてはいけません. 要約すると、ドキュメントが  にあるなら、そのプログラムはそこにドキュメントがなかったとしても正常に実行されなければなりません.

コンパイラフラグ
パッケージをビルドするために使用するコンパイラはシステム内で rpm 設定としてセットされた適切なコンパイラフラグを受け取るべきです. 2006年8月以降は、C/C++ や Fortran コンパイラのために $RPM_OPT_FLAGS/%{optflags} が実際に使用されます. その変数の中身がパッケージのビルドにおいてコンパイラによって実際に使用される基本フラグになります. このフラグをフィルタリングしたり、追加や上書きしたりすることは、理由があるときには許可されています. そのように変更する論理的根拠は、特に上書きやフィルターするときに spec ファイル内に記載してレビューされるべきです.

Debuginfo パッケージ
パッケージングするときはデバッグに役立つ  パッケージも作成すべきです. 又は  パッケージを生成できない場合は明示的に無効にすべきです. とは言え、いずれにしても rpmbuild がそうします. パッケージが明示的に無効にするなら、spec ファイル内にその理由を説明したコメントを記載します. Debuginfo パッケージの詳細については Packaging:Debuginfo を参照してください.

Devel パッケージ
あるソフトウェアで開発に必要なファイルを含めるようにパッケージングする場合、そのようなファイルは -devel サブパッケージに含めるようにすべきです. 以下に -devel に含めるべきファイル種別の例を示します.


 * ヘッダファイル(.h ファイル)
 * バージョン指定のない共有ライブラリ(libfoo.so). バージョン指定のある共有ライブラリ(libfoo.so.3, libfoo.so.3.0.0)は -devel に含めるべきではありません.

分かり易い基本原則として、あるファイルが開発のために使用されてベースパッケージで実行するのに必要ないなら、そのファイルを -devel に含めるべきです.

Pkgconfig ファイル
pkgconfig(.pc) ファイルをどのパッケージに含めるかは、その使用方法に依存します. pkgconfig ファイルは、ほとんど開発の目的のために使用されるので、-devel パッケージに含められます. 分かり易い例外としては、メインパッケージそのものがユーザ向けのランタイムをインストールしない開発向けのツールがあります. 例えば、gcc や gdb になります.

ベースパッケージの要求
-devel パッケージは  のようにフルバージョンの依存関係を使用してベースパッケージを要求しなければなりません. 普通は、-devel 以外のサブパッケージもフルバージョンの依存関係を使用してベースパッケージを要求すべきです.

共有ライブラリ
できるだけ(そして適切なら)、ライブラリを含む Fedora パッケージは共有ライブラリとしてパッケージングすべきです. さらに、動的リンカの全てのデフォルトパスに存在する共有ライブラリファイル(単なるシンボリックリンクではない)を含むバイナリ RPM パッケージは  や   スクリプトで   コマンドを実行しなければなりません. パッケージがライブラリを含む複数のサブパッケージで構成される場合、各々のサブパッケージもまた  や   スクリプトを   コマンドを実行すべきです. 正しい構文の例は次の通りです.

%post -p /sbin/ldconfig

%postun -p /sbin/ldconfig

この特殊な構文は  が   や   で実行される場合にのみ有効であることを覚えておいてください. や  のスクリプトレットの中で他のコマンドを実行したい場合、次のように、そのスクリプトレットの最初に   を実行するようにします.

%post /sbin/ldconfig /usr/bin/foo --add

%postun /sbin/ldconfig /usr/bin/foo --remove

静的ライブラリのパッケージング
ライブラリを含むパッケージは、(例えば、--disable-staticを設定して)できるだけ静的ライブラリを除外すべきです. 静的ライブラリは例外的な状況や理由がある場合にのみ含めるべきです. ライブラリをリンクするアプリケーションは、できるだけ静的ライブラリではなく共有ライブラリをリンクするようにすべきです.

libtool のアーカイブ、つまり foo.la のようなファイルは含めるべきではありません. libtool を使用するパッケージは --disable-static を設定してもデフォルトで foo.la のようなファイルをインストールします. そのため、パッケージングする前にそのようなファイルを削除する必要があるかもしれません. libtool の古いバージョンのバグ、又は libtool を使用するプログラムのバグのために、そのプログラムを変更せずに *.la ファイルを削除できない場合があります. ほとんどのケースでは、この問題を修正するためにアップストリームで作業することが最も簡単です. 安定版(開発版ではない)リリースのライブラリをアップグレードする際にパッケージが既に *.la ファイルを含んでいる場合、*.la ファイルの削除は API/ABI の変更として取り扱うべきであることに注意してください. 例えば、*.la ファイルを削除することは、そのライブラリをリンクする外の世界とのインタフェースを変更します. そして、それは安易に取り掛かる作業ではありません.

静的ライブラリのパッケージング

 * 一般的に、パッケージャはやむを得ない理由がない限り静的ライブラリを提供しないことが強く推奨されます.

%package devel Provides: foo-static = %{version}-%{release}
 * 我々はどのパッケージが静的ライブラリを使用しているかを追跡できるようにしたいです(つまり、もし静的ライブラリに存在するセキュリティの不具合が修正された場合、どのパッケージをリビルドする必要があるかを見つけることができます). どの静的ライブラリがパッケージングされているかについて2つのシナリオがあります.
 * 1) 静的ライブラリと共有ライブラリ. このケースでは、静的ライブラリは *-static サブパッケージに含めなければなりません. *-devel サブパッケージにある他の開発ファイルから静的ライブラリを分離することは、どのパッケージが *-static パッケージを   するかをチェックすることによって、静的ライブラリと共有ライブラリを使用していることを追跡するために許容されています. その目的はこのような静的ライブラリから共有ライブラリを使用するように、可能になればいつでもパッケージを変更するためです.
 * 2) 静的ライブラリのみ. あるパッケージが静的ライブラリのみを提供する場合、全ての静的ライブラリを *-devel サブパッケージに含めることができます. さらに、*-devel に含めるなら、仮想的に *-static パッケージを Provide しなければなりません.

静的ライブラリのバージョンに対して明示的にリンクする必要があるパッケージは、その使用方法を追跡できるように  しなければなりません.


 * あるパッケージが静的ライブラリを機能として要求する共有ライブラリ(のみ)を持つなら、静的ライブラリは *-devel に含めることができます. その devel パッケージは *-static パッケージのために仮想的に Provide しなければなりません. そして、devel パッケージに依存するパッケージは *-static パッケージを  しなければなりません.

実行ファイルを静的にリンクすること

 * 静的リンクは特殊な例外であり、その都度、個別に決定されるべきです. パッケージャは承認をもらうために FESCO に対して、静的リンクをする理由やその優位性も含めて提示しなければなりません、


 * あるライブラリに対して静的リンクするなら、そのライブラリの新バージョンに対してリビルドしたいパッケージのセキュリティ問題やバグ修正を監視できるように、そのライブラリの initialcc リストへあなたの名前を追加してください. そういったリクエストを作成するための手順があります.

FESCo へ伝える必要のないプログラム

 * OCaml で書かれたプログラムは通常 OCaml ライブラリを動的にリンクしません. その仕様のために静的リンクについての要件は断念します. (そうは言っても、C 言語で書かれたライブラリを呼び出す OCaml のコードは、C 言語のライブラリを動的にリンクすべきです. )


 * あるライブラリが静的なバージョンのみを提供するモノに依存するなら、あなたのパッケージは *-static サブパッケージを  するように提供されたライブラリに対してリンクすることができます. そういった状況のパッケージャはある共有ライブラリが利用可能になったら、あなたのパッケージが共有ライブラリを使用するために調整すべきなことに気付くべきです.

例外として許可されたプログラム

 * yaboot はファイルシステムを読むために e2fsprogs-libs を使用するブートローダなので静的リンクすることができます.

システムライブラリの重複
システムに存在するライブラリのローカルコピーをパッケージに含めてビルドすべきではありません. そういったパッケージはシステムライブラリを使用するように修正すべきです. こうすることにより、システムのコアライブラリが修正された後でも古いバグやセキュリティホールが残り続けるのを防ぐことができます. パッケージによってはこの内容に対する例外が許可されるかもしれません. 詳細については一括りにまとめないライブラリの、関連内容や例外が許可されるためのプロセス、あなたのパッケージを一括りにまとめるならその要求仕様を参照してください.

Rpath に注意する
稀に、(-rpath 又は -R フラッグを使用して)バイナリをリンクするときにコード内に特定のライブラリパスがハードコーディングされます. これは一般的に rpath として参照されます. 通常は、動的リンカやローダー(ld.so)が共有ライブラリの実行可能な依存関係を解決して、必要とされるライブラリをロードします. しかし、-rpath 又は -R が使用された場合、そのパス情報はバイナリ内にハードコーディングされていて実行時に ld.so によって調べられます. Linux 動的リンカはハードコーディングされたパスよりも普通は利口に動作するので、Fedora では rpath の使用を通常は許可していません.

rpmdevtools パッケージに含まれる check-rpaths というツールがあります.   設定ファイルの   マクロに check-rpaths を追加すると良いでしょう.

%__arch_install_post           \ /usr/lib/rpm/check-rpaths    \ /usr/lib/rpm/check-buildroot check-rpaths が実行されると次のように出力されるかもしれません. ERROR  0001: file '/usr/bin/xapian-tcpsrv' contains a standard rpath '/usr/lib64' in [/usr/lib64]

check-rpaths が検出した全ての rpath は削除 しなければなりません.

内部ライブラリのための Rpath
あるプログラムが内部で使用するライブラリをインストールするとき、大抵はシステムパスにインストールしません. これらの内部ライブラリはパッケージ内のそのプログラムのため(例えば、共通で実行されるコードを取り除くため)にのみ使用されます. また内部ライブラリはパッケージの外部で使用することを想定していません. こういった場合、内部ライブラリを見つけるために rpath を使用してパッケージ内にそのプログラムを含める目的なら許容されます.

例: %{_libdir}/myapp/ %{_libdir}/myapp/libmyapp.so.0.3.4 %{_libdir}/myapp/libmyapp.so
 * 1) Internal libraries for myapp are present in:

readelf -d /usr/bin/myapp | grep RPATH 0x0000000f (RPATH)                     Library rpath: [/usr/lib/myapp]
 * 1) myapp has an rpath to %{_libdir}/myapp/

Rpath の代替方法
あるバイナリが非標準パス(標準パスは /lib, /usr/lib, /lib64, /usr/lib64 です)に存在するライブラリを探すのに rpath がよく使用されます. ライブラリを非標準パス(例えば、/usr/lib/foo/)に格納する場合、/etc/ld.so.conf.d/ にその設定ファイルを含めるべきです. 例えば、/usr/lib/foo に libfoo の 32bit ライブラリが存在する場合、/etc/ld.so.conf.d/ に "foo32.conf" というファイルを作成して次のように設定します. /usr/lib/foo 同様に 64bit バージョンのファイル(例えば、foo64.conf)を作成することも確認してください(もちろんパッケージが 64bit アーキテクチャをサポートする場合です).

Rpath を削除する
rpath の問題を修正する方法は幾つかあります.

%configure sed -i 's|^hardcode_libdir_flag_spec=.*|hardcode_libdir_flag_spec=""|g' libtool sed -i 's|^runpath_var=LD_RUN_PATH|runpath_var=DIE_RPATH_DIE|g' libtool chrpath --delete $RPM_BUILD_ROOT%{_bindir}/xapian-tcpsrv 最終的にこの方法を使用することに決めたら BuildRequires: chrpath を spec ファイルに追加することを忘れないように注意してください.
 * 対象アプリケーションが configure を使用するなら、オプションに --disable-rpath を与えるようにしてください.
 * 対象アプリケーションが libtool のローカルコピーを使用するなら、spec ファイルの %configure の後に次のように設定してください.
 * 稀に、コード/Makefile で -rpath 又は -R フラッグが与えられないように取り除くパッチが適用されます. しかし、これは簡単ではなく、適切な方法でもありません.
 * 最終手段として、Fedora には chrpath というパッケージがあります. このパッケージがインストールされる場合、rpath を含むファイルに対して  を実行することができます. 先に説明した例であれば次のように実行します.

設定ファイル
パッケージの設定ファイルはすぐに分かる状態でなければなりません.

大まかな方法として、よく考えて変更することで何かを壊してしまうと推測されない限り、 の代わりに　  を使用してください. 言い換えれば、パッケージのアップグレード時にローカルでの設定ファイルの変更内容を上書きする前に真剣に考えてください. を使用しない例としては、新しいリビジョンのパッケージが以前のリビジョンのパッケージの設定ファイルでは動作しないように設定ファイルを変更するときです. が使用されているときはいつでも、その理由を説明した簡潔なコメントを spec ファイルに追加してください.

/usr 配下で %config や %config(noreplace) を使用しないでください. Fedora では /usr に設定ファイルを置かないようにしています.

初期化スクリプト
現時点では、Fedora は SystemV スタイルの初期化スクリプトのみをサポートしています. SystemV スタイルの詳細なガイドラインについては Packaging:SysVInitScript を参照してください.

デスクトップファイル
パッケージが GUI アプリケーションを含むなら、適切にインストールされる .desktop ファイルも含める必要があります. このガイドラインの対象となる GUI アプリケーションとは X ウィンドウを描画して、そのウィンドウ内で実行される全てのアプリケーションのことです. インストールされる .desktop ファイルは、Name, GenericName, Categories, StartupNotify エントリの正しい用途を検証することに十分注意を払いながら、desktop-entry-spec に従わなければなりません.

アイコンタグとデスクトップファイル
アイコンタグの指定方法は2通りあります.


 * フルパス指定のアイコンファイル


 * 拡張子なしの短縮名

アイコンテーミング(デフォルトは .png、次に .svg、最後 .xpm と仮定する)を許容するので拡張子なしの短縮名の方が推奨されます. とは言え、どちらの方法でも良いです.

.desktop ファイルの作成
そのパッケージが自身の .desktop ファイルを持っていなくてインストールしないなら、.desktop ファイルを作成する必要があります. Source(例えば、Source3: %{name}.desktop)として作成した .desktop ファイルを含める、又は spec ファイル内で .desktop ファイルを生成することができます. 例えば、.desktop ファイル(comical.desktop)のサンプルは次のようになります.

[Desktop Entry] Name=Comical GenericName=Comic Archive Reader Comment=Open .cbr & .cbz files Exec=comical Icon=comical Terminal=false Type=Application Categories=Graphics;

desktop-file-install の使用方法
ただパッケージに .desktop ファイルを含めるのみだと十分ではありません. spec ファイルの仕様に準拠した安全な .desktop ファイルを保証するために  セクションで   又は   を実行しなければなりません(そして   を設定する). パッケージが .desktop ファイルをインストールしない、又は .desktop ファイルに対して(カテゴリを追加/削除する等の)変更がある場合、 が使用されなければなりません. .desktop ファイルの内容/場所を変更しない場合、 を使用しても構いません. ここに使用例のサンプルがあります.

desktop-file-install                                   \ --dir=${RPM_BUILD_ROOT}%{_datadir}/applications        \ %{SOURCE3}

desktop-file-install                                   \ --add-category="AudioVideo"                            \ --delete-original                                      \ --dir=%{buildroot}%{_datadir}/applications             \ %{buildroot}/%{_datadir}/foo.desktop

desktop-file-validate %{buildroot}/%{_datadir}/applications/foo.desktop


 * 新しいパッケージには、vendor タグを .desktop ファイルへ適用してはいけません. vendor タグを使用する既存パッケージは、パッケージのライフサイクルのために継続して使用しなければなりません. この理由はほとんど (.desktop ファイル/パス名をベースとする)menu-editing のためです.

マクロ
ハードコーディングされたディレクトリ名の代わりにマクロ(Packaging:RPMMacros を参照)を使用してください.

Source: 又は Patch: 行の中にマクロを使用することはスタイルの問題です. マクロなしの方が Source: の可読性が良いと考える人がいます. 一方、人によってはマクロを使用すると新しいバージョンへアップデートが簡単なので好む人もいます. 全てのケースにおいて、spec ファイル内で統一することと、記載した URL が有効かを検証することを覚えておいてください. spectool(rpmdevtools パッケージに含まれる)は URL がマクロを含むかどうかをチェックするのに役立ちます.

もしマクロを含むときに実際の文字列を調べる必要があるなら、rpm コマンドを使用することができます. 例えば、実際の Source: の値を調べるには次のように実行します.

rpm -q --specfile foo.spec --qf "$(grep -i ^Source foo.spec)\n"

%{buildroot} と %{optflags} vs $RPM_BUILD_ROOT と $RPM_OPT_FLAGS の使用
spec ファイル内で rpm の Build Root と最適化フラグを定義する2つのスタイルがあります.

全てのシナリオで同じ値を取得するので、どちらのスタイルを選択するかについてはどちらでも構いません. 一方のスタイルを選択して、パッケージングする際は統一してそのスタイルを使用すべきです.

2つのスタイルを混在させることは、正常には動作しますが、QA やユーザビリティの視点から悪いことです. そして、Fedora パッケージでそれをしてはいけません.

%makeinstall マクロを使用しない理由
Fedora の RPM は  マクロを含みますが、それは make install DESTDIR=%{buildroot} が動作するときに使用しては いけません. %makeinstall は DESTDIR の値を利用しない Makefile で動作する一時解決的な方法ですが、%makeinstall を使用することで次の潜在的問題があります.


 * は "make install" の最中に Make 変数セットを上書きして %{buildroot} パスを先頭に追加します. つまり、それは make prefix="%{buildroot}%{_prefix}" libdir="%{buildroot}%{_libdir} ..." を実行することになります.
 * それはエラーになり易い傾向があり、完全な Makefile ではないものに対して実行すると予期せぬ結果を招きます. 例えば、変数がインストール時に置き換えると buildroot パスはインストールされたファイルに含まれるかもしれません.
 * "make install" を実行するときに、違う値を持った Make 変数が %build セクションで評価されるので、不必要な誤ったリビルドを引き起こすきっかけになります.
 * あるパッケージが libtool アーカイブを含む場合、壊れた *.la ファイルをインストールしてしまうことを引き起こします.

代替方法として、Fedora パッケージは  又は   を使用すべきです.

ソース RPM ビルド時間のマクロ
と  にある全てのマクロは SRPM のビルド時に展開される必要があります. SRPM は、そのパッケージの BuildRequires をインストールせずにビルドされるので、spec ファイルの外側で定義されたマクロに依存することは SRPM をビルドした結果として簡単に展開できないマクロが表示されることになります. 1つの方法として、最小限の chroot を作成して SRPM をビルドすることでチェックすることができます.

mock --init mock --copyin [SRPM] / mock --shell bash rpm -ivh [SRPM] cd /builddir/build/SPECS rpmbuild -bs --nodeps [SRPM] rpm -qpiv /builddir/build/SRPMS/[SRPM]

展開できないマクロ、又は消えてしまった情報(when は空文字列に展開されます)がないかについて   の出力をチェックしてください. spec ファイルの  と   でマクロを定義しないことがより簡単な解決方法です.

間違った %_sourcedir の使用方法
Source# として箇条書きのファイルを使用するパッケージは  マクロ名でそういったファイルを参照しなければなりません. さらにそういったファイルを参照するために  又は   を使用してはいけません. 詳細は Packaging:RPM_Source_Dir を参照してください.

%define よりも %global を優先的に使用する
他のマクロ定義内にローカルに定義されたサブマクロが必要でない限り(とても稀なケースです)、 の代わりに   を使用してください.

その理由は、ステートメントを定義する2つのマクロは rpm のネストされたレベルのトップレベルにある場合も同じように動作するからです.

しかし、 のような構造のネストされたマクロ拡張が使用される場合、  は論理的にローカルスコープの範囲内のみその定義が有効になるのに対して、  定義はグローバルスコープを持ちます.

ロケールファイルを扱う
パッケージが翻訳ファイルを含むなら、

BuildRequires: gettext

を追加してください. そうしないと、そのパッケージは buildroot で翻訳ファイルを生成する際にエラーとなるでしょう.

Fedora には  という rpm マクロがあります. このマクロは(名前から)そのパッケージに属する全てのロケールファイルを配置します. そして、あるファイル内にロケールファイルのリストを保持します. それから、全てのロケールを含めるためにそのファイルを使用することができます. は buildroot へ全てのファイルがインストールされた後、spec ファイルの %install セクションで実行されます. の正しい構文は、通常は次の通りです.

%find_lang %{name}

アプリケーションによっては、そのロケールに違う "名前" を使用するかもしれません. そのため、ロケールファイルを探して、どのような名前が使用されているかを確認する必要があるかもしれません. もし  という名前だったら、 } の代わりに   へ   をオプションとして渡す必要があります. の実行後、ロケールファイルのリストを保持したファイルをアクティブなディレクトリ(デフォルトでは、ソースディレクトリのトップディレクトリ)に生成するでしょう. このファイルは  マクロへオプションとして渡された名前に基づきます. 通常は  という名前になります. このファイルを使用して  が検出したロケールファイルを   リストへ含めます. こうするには、 で -f パラメータと共に   を指定します.

%files -f %{name}.lang %defattr(-,root,root,-) %{_bindir}/foobar ...

もしロケールが存在して  セクションに -f パラメータを既に指定しているなら、  のコンテンツを -f を指定しているファイルの最後へ単純に追加してください. (もしかすると1ファイルしか  に渡せないかもしれません)

ここに  の   の適切な使用例があります.

... %prep %setup -q

%build %configure --with-cheese make %{?_smp_mflags}

%install make DESTDIR=%{buildroot} install %find_lang %{name}

%clean rm -rf %{buildroot}

%files -f %{name}.lang %defattr(-,root,root,-) %doc LICENSE README %{_bindir}/foobar

%changelog - sample spec that uses %%find_lang
 * Thu May 4 2006 Tom "spot" Callaway  0.1-1

%find_lang を使用しなければならない理由
を使用することは spec ファイルをシンプルにすることに役立ちます. そして、幾つかの理由でパッケージングの失敗を防ぐことにも役立ちます.

%{_datadir}/locale/ar/LC_MESSAGES/%{name}.mo %{_datadir}/locale/be/LC_MESSAGES/%{name}.mo %{_datadir}/locale/cs/LC_MESSAGES/%{name}.mo %{_datadir}/locale/de/LC_MESSAGES/%{name}.mo %{_datadir}/locale/es/LC_MESSAGES/%{name}.mo ...
 * 1行で全てのロケールファイルを表すために  を使用するパッケージは、ロケールディレクトリの所有権も持つことになりますが、それは許可されていません.
 * ロケールを持つ大半のパッケージは大量のロケールファイルを持っています.  を使用する方が spec ファイルに次のように記述よりもずっと簡単です.
 * パッケージのバージョンが上がり新たなロケールファイルが追加されると、 は実行時に自動的に追加されたロケールファイルを含めるようになります. 必要以上にロケールに関する内容で spec ファイルを更新する必要はありません.

ロケールを含むパッケージでは  を使用しなければならないことを忘れないでください.

タイムスタンプ
spec ファイルでファイルをコピーするコマンドを追加するとき、ファイルのタイムスタンプを保持するコマンドを使用するように考慮してください. 例えば、 か   になります.

ソースやパッチ等をダウンロードするときは、アップストリームのタイムスタンプを保持するダウンロードツールを使用するように考慮してください. 例えば、 か   になります. wget の設定をグローバルに有効にするには、 に   を追加してください. 同様に、curl には  に   を追加してください.

並行 make
できるだけ  の起動は次のようにすべきです.

make %{?_smp_mflags}

これは一般的にビルド処理が速くなります. 特に SMP マシン上で速くなります.

しかし、並行ビルドをサポートしない make ファイルもあるのでパッケージがこの方法で効率良くビルドできるかを確認してください. そのため、 ファイルに %_smp_mflags -j3 を追加する必要があるかを考慮すべきです. UP マシン上では、この設定がエラーの大半になります.

スクリプトレット
Fedora パッケージ内でスクリプトレットを使用する場合、本当に慎重になって扱うべきです. スクリプトレットが使用されるとき、それは適切に動作するものでなければなりません. Packaging:ScriptletSnippets に一般的なスクリプトレットについて記載されています.

スクリプトレットの要求仕様
スクリプトレットの依存関係のために  スタイルの記述方法を使用しないでください. というのは RPM に2つのバグがあるからです. その代わりに、次のように分割して記述すべきです.

Requires(pre): ... Requires(post): ...

詳細は www.redhat.com を参照してください.

特定状況でのみのスクリプトレットの実行
rpm コマンドがあるパッケージのスクリプトレットを実行するとき、その動作がインストール、削除、アップグレード、又は再インストールのどれかで、次のようにスクリプトに対して与えられる整数の引数が変わります.

install  erase   upgrade  reinstall %pre        1        -         2         2 %post       1        -         2         2 %preun      -        0         1         - %postun     -        0         1         -

例えば、 コマンドで初期化スクリプトをインストールするパッケージは、アップグレードではなく削除のみを行う場合は次のようなスニペットでアンインストールすべきです.

%preun if [ $1 -eq 0 ] ; then /sbin/chkconfig --del %{name} fi

また様々なスクリプトに渡される整数値について、公式の、汎用的な定義は  も参照してください.

特定ディレクトリに書き込みのみが許可されているスクリプトレット
次の表にある /tmp, /var/tmp (又は rpmbuild プロセスによってセットされる $TMPDIR や %{_tmppath})といった有効な一時ファイル置き場や %{buildroot}, %{_builddir} 配下にあるファイル(作成、変更、削除)のみを変更するパッケージのスクリプト(%prep, %build, %install, %check と %clean)を構築してください.

厳密に補足すると、ビルドを実行するユーザの uid に関係なくこの表の通りになるようにすべきです.

条件付きの依存関係
への  のオプション引数が存在して、条件によって選択される依存関係を spec ファイルに含む場合、デフォルトオプション、つまり、  のコマンドラインにこのような引数が与えずに実行されるようにソース RPM をビルドするようにしてください. その理由はそういった要件は結果的にはソース RPM の中に "含めるようにする" からです. つまり、spec ファイルの条件で適用するものではありません.

別のユーザアカウントでパッケージをビルドする
あなたが完全なセキュリティ監査を実施しない状態でソフトウェアをビルドする場合、別のユーザアカウントを使用して自身の機密情報を保護してください. 機密情報とは、例えば、あなたの GPG 秘密鍵のような情報を指します.

機密情報の保護についてはレビューアやテスターにも当てはまります. いかなる機密情報にもアクセスできない別のユーザアカウントで src.rpms をリビルドしてください.

再配置可能なパッケージ
再配置可能なパッケージを生成するために RPM の仕組みを利用しようと思うと本当にがっかりします. 適切に動作させるのが難しく、yum 又はインストーラーから使用するのは不可能であり、他のパッケージガイドラインに従うなら一般的には必要ないからです. 到底起こりそうもないことですが、パッケージを再配置可能な状態にするに足る理由があるなら、パッケージレビューでその要件の意図と理由をはっきりと説明しなければなりません.

コード Vs コンテンツ
コンピュータの実行可能なコードとコンテンツを区別するのは重要です. (もちろん、オープンソース互換ライセンスであり、法的な問題がない等を前提として)コードが許容されるのに対して、コンテンツは数種類のみが許容されます.

そのルールは次のようになります.

コンテンツが OS のユーザエクスペリエンスを拡張するなら、そのコンテンツは Fedora へパッケージングして良いです. 例えば、フォント、テーマ、クリップアートや壁紙のようなコンテンツになります.

それでもコンテンツは含めて良いかどうかをレビューされる必要があります. オープンソース互換ライセンスである必要があり、法的な問題があってはいけません. さらに、コンテンツには追加の制約があります.
 * コンテンツはアニメ、擬似的、写真であるかによらずポルノ又はヌードであってはいけません.
 * コンテンツは不快で、差別や名誉を毀損するようなものであってはいけません. コンテンツの一部がそれに該当するかどうかよく分からないなら、それはおそらく該当します.
 * 全てのコンテンツは含めることが可能かどうかの最終決定権を持つ FESCo によってレビューされて従わなければなりません.

許容されるコンテンツ例は次の通りです.


 * パッケージのドキュメント、又はヘルプファイル
 * Office 製品に使用されるクリップアート
 * 背景画像(不快な気分や差別にならない、フリーに再配布可能)
 * フォント(所有権や法的な懸念事項がないオープンソースライセンス)
 * ゲームレベルはコンテンツと見なされません
 * プログラム又はテーマ(又はドキュメント)が使用するソースの tar ボールに含まれるサウンド又はグラフィックは許容されます
 * そのフォーマットに特許がなくコンテンツがフリーに制約なく配布できる限り、ゲーム音楽コンテンツは許容されます
 * ソースの tar ボールに含まれるサンプルファイルコンテンツとは見なされません

許容されないコンテンツ例は次の通りです.


 * マンガ本のファイル
 * 宗教に関するテキスト
 * mp3 ファイル(専売特許のある)

どんなコンテンツが許容されるかよく分からないなら、fedora-devel-list で尋ねてください.

ファイルとディレクトリの所有者
パッケージは %install セクションでインストールされる全てのファイルを所有すべきです. そして、パッケージは他のパッケージが既に所有しているファイルを所有してはいけません. 基本原則として最初にインストールされるパッケージが、他のパッケージがそのファイルの存在に依存する可能性があるファイルを所有すべきです. 例えば、これは  又は   パッケージによって所有されるファイルであっても所有権を共有するようなパッケージは Fedora にはないということです. もし他のパッケージが所有しているファイルを所有するための適切な理由があるなら、パッケージレビューのときに連絡してください.

ディレクトリの所有者はファイルの所有者よりも少し複雑です. パッケージは自分が追加したファイルがある全てのディレクトリを所有しなければなりません. 但し、次のディレクトリは除外されます.


 * や  又はその他に明示的に作成された   が所有するディレクトリ


 * パッケージの自然な依存関係のつながりで他のパッケージが所有するディレクトリ

この文脈で言う、パッケージの "自然な依存関係のつながり" というのは、普通にそのパッケージが機能を提供するために必要なパッケージセットと定義されます. 具体的に言うと、あなたのパッケージが追加するファイルのディレクトリを所有するという、ただそれだけのためにパッケージを要求する必要はありません. また、もしあなたのパッケージが別の理由でそのパッケージを既に要求しているなら、そのディレクトリを所有すべきではありません.

全てのケースにおいて、システム上に存在するどのパッケージにも所有されていないディレクトリは保護しています. 詳細は Packaging:UnownedDirectories を参照してください.

ほとんどのディレクトリの所有に関連するケースにおいて、どのように取り扱うかを例で説明します.

パッケージ全体に含まれる、又はコア機能によって使用されるディレクトリ
例:

gnucash は /usr/share/gnucash directory 配下に多くのファイルを置きます

解決方法:  パッケージは   ディレクトリを所有すべきです

要求されたパッケージの機能を実装するパッケージにも所有されるディレクトリ
例:

pam は /etc/pam.d directory を所有します gdm は /etc/pam.d 配下にファイルを置きます

解決方法:  パッケージは   ディレクトリを所有すべきです. そして、 は   とします.

あなたのパッケージが機能を提供するために必要ではないパッケージがディレクトリを所有する
Some packages create and own directories with the intention of permitting other packages to store appropriate files, but those other packages do not need that original package to be present to function properly.

適切なファイルを格納するために他のパッケージを許容する目的でディレクトリを作成、所有しますが、そういった他のパッケージは正常に機能を提供するためにそのオリジナルのパッケージを必要としません.

例:

gtk-doc は /usr/share/gtk-doc/ を所有します evolution は /usr/share/gtk-doc/ にファイルを置きます evolution は正常に機能を提供するために gtk-doc を必要としません evolution の依存関係の繋がりには /usr/share/gtk-doc/ を所有するパッケージはありません

解決方法:  パッケージは   ディレクトリを所有すべきです. gtk-doc をディレクトリの所有権のためだけに明示的に Require: へ追加する必要はありません.

別の例:

bash-completion は /etc/bash_completion.d ディレクトリを所有して、そこに置かれたファイルを自身の設定のために使用します. git は /etc/bash_completion.d にファイルを置きます bzr は /etc/bash_completion.d にファイルを置きます

解決方法: git と bzr パッケージの両方とも bash-completion がオプション機能であるかのように /etc/bash_completion.d ディレクトリを所有すべきです. そして、git や bzr のインストールは bash-completion のインストールを強制しないようにします.

あるディレクトリの提供に依存するパッケージは、その後のバージョンで違うディレクトリを所有するように変更されるかもしれません、そして、あなたのパッケージはその後のバージョンで何の変更もなく実行されます
一般的な例の1つとして Perl モジュールがあります.

perl-A-B が perl-A に依存して、/usr/lib/perl5/vendor_perl/5.8.8/i386-linux-thread-multi/A/B にファイルをインストールすると仮定してください. ベースとなる Perl パッケージはバージョン 5.8.8 で互換性を維持する限り /usr/lib/perl5/vendor_perl/5.8.8/i386-linux-thread-multi を所有することを保証します. しかし、将来 perl-A パッケージのアップグレードパッケージが /usr/lib/perl5/vendor_perl/5.9.0/i386-linux-thread-multi/A (このディレクトリを所有する)にファイルをインストールするかもしれません. そのため、perl-A-B パッケージは適切な所有者情報を維持するために /usr/lib/perl5/vendor_perl/5.8.8/i386-linux-thread-multi/A/B と同様に /usr/lib/perl5/vendor_perl/5.8.8/i386-linux-thread-multi/A を所有する必要があります.

ユーザとグループ
パッケージによってはユーザとグループの両方またはどちらか一方を実行時に指定するように要求したり、又はその方が利点があったりするものがあります. そういったケースを扱うガイドラインはユーザとグループにあります.

ウェブアプリケーション
Fedora のウェブアプリケーションは /var/www/ の中ではなく、/usr/share/%{name} の中にコンテンツを保存すべきです. その理由は以下になります.


 * /var は様々なデータファイルやログの保存をサポートしています. コンテンツは /usr/share の方がより適切です.
 * 多くのユーザは既に /var/www にコンテンツを保存しています. どのような Fedora パッケージにおいても /var/www のトップに誤って上書きしてしまうようなことは望んでいません.
 * /var/www は今ではファイルシステム階層標準(FHS)ではありません.

競合
できるだけ Fedora パッケージはお互いに競合しないようにすべきです. しかし、不幸にも常にそうであるとは限りません. Fedora の競合ポリシーの詳細については 競合 を参照してください.

また、代替ツールや環境モジュールのようなツールもパッケージが競合しないように使用することができます.

代替ツール
代替ツールは、シンボリックリンクセットを維持することで同じ機能を提供するパッケージの並行インストールを行う方法を提供します. 代替ツールの使用方法の詳細については代替ツールを参照してください.

環境モジュール
それぞれがユーザのニーズを提供していて、且つ同時に利用可能でなければならない複数の要因がある場合、システム全体に渡るので代替ツールは十分ではありません. そのような状況では、環境モジュールを使用すると競合を避けることができます. 環境モジュールの使用方法の詳細については環境モジュールを参照してください.

/srv 配下のファイルやディレクトリはありません
FHS によると

"/srv 配下の階層における特定サブディレクトリが存在していることや /srv 内に格納しなければならない データに依存するようなプログラムはありません. しかし、/srv は FHS 準拠のシステムとしては存在する 必要があるので、データのためにデフォルトの場所として使用されるべきです.

Linux ディストリビューションは、管理者権限なしで /srv 配下に置かれたファイルを削除しないように 注意しなければなりません. "

/srv は FHS のセクションとしては曖昧な実装であり、その意図された使用方法はよく分かりません. 現時点では、Fedora のパッケージは /srv 配下にファイルやディレクトリを置くことはできません.

Fedora パッケージをインストールしてユーザが実行したら /srv はデータのためのデフォルトの場所として使用できるということに注意しなくてはいけません. 但し、パッケージは /srv 配下にあるディレクトリやファイルを所有してはいけません.

複数プロジェクトのビルド
Fedora パッケージは1つのパッケージ内に複数の、独立した、アップストリームのプロジェクトをまとめて含めないように最大限の努力をするべきです.

他のパッケージにあるフォントを1つにまとめない
Type1、OpenType TT (TTF) や OpenType CFF (OTF) のような汎用フォーマットのフォントは特殊なパッケージングガイドライン(1)に従います. そういったフォントは、個別のアプリケーションディレクトリではなく、システム全体のフォントリポジトリにパッケージングされます. 詳細についてはPackaging:FontsPolicyを参照してください.

全てのパッチはアップストリームのバグへのリンクかコメントを持つようにする
Fedora の spec ファイルに含まれる全てのパッチは、そのパッチの上にアップストリームの状況に関するコメントを 記載するべき です. パッチを作成するときは常に、作成したパッチをアップストリームのバグトラッカーへ登録するようにするのがベストプラクティスです. そして、そのパッチの上にコメントとして、バグトラッカーのバグ情報へのリンクを含めます. 例えば、次の通りです.

Patch0: gnome-panel-fix-frobnicator.patch
 * 1) http://bugzilla.gnome.org/show_bug.cgi?id=12345

この例の記載内容で全く問題はありません. しかし、もっと良いのは、バグトラッカーのリンクの上にそのパッチがどういったものかの簡潔なコメントがあると分かり易いです.

Patch0: gnome-panel-fix-frobnicator.patch
 * 1) Don't crash with frobnicator applet
 * 2) http://bugzilla.gnome.org/show_bug.cgi?id=12345

アップストリームへパッチを送ることやこのコメントを追加することは、Fedora が良い FLOSS 市民(なぜアップストリーム？を参照)であることの証明になります. そうすることで、他の人(やあなたも)がアップストリームの新たなリリースで適用されそうなパッチがどういったものかを知ることによって、完全なパッケージメンテナンスを維持することに役立ちます.

アップストリームがバグトラッキングシステムを持っていない場合
アップストリームへパッチを送ったという事実とその状況を提示しましょう.

Patch0: foobar-fix-the-bar.patch
 * 1) Sent upstream via email 20080407

Patch0: foobar-fix-the-baz.patch
 * 1) Upstream has applied this in SVN trunk

Fedora に特化した(アップストリームで拒否された)パッチ
パッチによっては Fedora に特化した修正もあるかもしれません. そのような場合は次のように記載します.

Patch0: jna-jni-path.patch
 * 1) This patch is temporary until we land the long term System.loadLibrary fix in OpenJDK

Epoch の使用
RPM の Epoch タグは、できるだけ使用しないようにすべきで、最後の手段としてのみ使用されます. とは言え、アップストリームのバージョン番号ルールの変更、又はサードパーティリポジトリから簡単に移行するために Epoch を使用するなど必要になるときがあります.

サードパーティリポジトリの Epoch
あるパッケージがインポートされる、又は既にリポジトリで公開されていた場合、パッケージャはサードパーティパッケージの最新バージョンと同じ Epoch タグを任意で設定することができます.

シンボリックリンク
シンボリックリンクを作成するときに相対パスか絶対パスかのどちらかで作成することができます. Fedora では、どちらか一方の方法のみに限定していません. パッケージャはシンボリックリンクの作成について必要なときに最適な方法を選択すべきです.

相対パスのシンボリックリンク
相対パスのシンボリックリンクはファイルやディレクトリを相対パスで指すシンボリックリンクです. 例えば、次のコマンドは相対パスのシンボリックを作成します. ln -s ../..%{_bindir}/foo %{buildroot}/bin/foo

良い点:
 * 相対パスのシンボリックリンクは chroot の内外で同じファイルを指します.

悪い点:
 * 絶対パスのシンボリックリンクの作成と比較するとずっと複雑です.
 * 相対パスのシンボリックリンクはファイルシステムの一部が特別な場所にマウントされていると壊れたり、予想もしない動作を引き起こす可能性があります
 * 相対パスのシンボリックリンクはバインドマウントやディレクトリを指すときに壊れる可能性があります
 * 相対パスのシンボリックリンクの作成に rpm のシステムマクロを使用するのはかなり難しいです.

絶対パスのシンボリックリンク
絶対パスのシンボリックリンクはファイルやディレクトリを絶対パスで指すシンボリックリンクです. 例えば、次のコマンドは絶対パスのシンボリックリンクを作成します. ln -s %{_bindir}/foo %{buildroot}/bin/foo

良い点:
 * 相対パスのシンボリックリンクの作成と比較すると簡単です.
 * 絶対パスのシンボリックリンクはバインドマウントやディレクトリを指すときに正常に動作します.
 * rpm のシステムマクロを使用して正常に動作します.

悪い点:
 * 絶対パスのシンボリックリンクは chroot を使用すると壊れる可能性があります.

man ページ
man ページは unix システムにおけるヘルプを見る伝統的な方法です. パッケージの全てのバイナリ/スクリプトのために man ページを作成すべきです. もし man ページがないなら、アップストリームで man ページを追加するように働きかけてください. 時々、他のディストリビューション(特に Debian)では、man ページで問題が発生します. そういったことに遭遇したら、問題解決のための出発点にしましょう.

アプリケーションに特化したガイドライン
Packaging:Namespace に個々のページを持つアプリケーションに特化したガイドラインがあります.

Eclipse
Eclipse プラグインパッケージのためのガイドライン: Packaging:EclipsePlugins

Emacs
Emacs/X-Emacs パッケージのためのガイドライン: Packaging:Emacs

Fonts
font パッケージのためのガイドライン: Packaging:FontsPolicy

Fortran
Fortran パッケージのためのガイドライン: Packaging:Fortran

Globus Toolkit
Globus Toolkit のパッケージのためのガイドライン: Packaging:Globus

Haskell
Haskell パッケージのためのガイドライン: Packaging:Haskell

Java
java パッケージのためのガイドライン: Packaging:Java

Lisp
lisp パッケージのためのガイドライン: Packaging:Lisp

Mono
Mono パッケージのためのガイドライン: Packaging:Mono

MPI
MPI パッケージのためのガイドライン: Packaging:MPI

OCaml
OCaml パッケージのためのガイドライン: Packaging:OCaml

OpenOffice.org
OpenOffice.org の拡張パッケージのためのガイドライン: Packaging:OpenOffice.orgExtensions

Perl
Perl パッケージのためのガイドライン: Packaging:Perl

PHP
PHP パッケージのためのガイドライン: Packaging:PHP

Python
Python アドインモジュールのためのガイドライン: Packaging:Python

R
R モジュールパッケージのためのガイドライン: Packaging:R

Ruby
Ruby パッケージのためのガイドライン: Packaging:Ruby

Sugar
Sugar Activity パッケージのためのガイドライン: Packaging:SugarActivityGuidelines

Tcl/Tk
Tcl/Tk 拡張パッケージのためのガイドライン: Packaging:Tcl

Wordpress
Wordpress 拡張パッケージのためのガイドライン: Packaging:WordPress plugin packaging guidelines