From Fedora Project Wiki
m (差分を追加)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<!-- page was renamed from PackageReviewGuidelines
<!-- page was renamed from PackageReviewGuidelines
-->
-->
= Package Review Guidelines =
= パッケージレビューガイドライン =
This is a set of guidelines for Package Reviews. Note that a complete list of things to check for would be impossible, but every attempt has been made to make this document as comprehensive as possible. Reviewers and contributors (packagers) should use their best judgement whenever items are unclear, and if in doubt, ask on the [https://www.redhat.com/mailman/listinfo/fedora-packaging fedora-packaging list] .
 
これはパッケージレビューのためのガイドラインです。できるだけ包括的に分かり易いようこのレビューガイドラインを作成しようとはしていますが、完璧なチェックリストを作成することは不可能だということに注意してください。レビューアと貢献者(パッケージャ)は、何らかの内容が不明確で疑わしいときは必ず[https://www.redhat.com/mailman/listinfo/fedora-packaging fedora-packaging メーリングリスト]へ質問して、最も良い判断を行うべきです。


'''Author:''' [[TomCallaway|  Tom 'spot' Callaway]] <BR>
'''Author:''' [[TomCallaway|  Tom 'spot' Callaway]] <BR>
Line 9: Line 10:
'''Last Revised:''' Thursday, Jul 8, 2010<BR>
'''Last Revised:''' Thursday, Jul 8, 2010<BR>


== Package Review Process ==
== パッケージレビュープロセス ==
Contributors and reviewers should follow the [[Package Review Process]].
 
貢献者とレビューアは[[Package Review Process|パッケージレビュープロセス]]に従います。


{{Anchor|ThingsToCheckOnReview}}
{{Anchor|ThingsToCheckOnReview}}


== Things To Check On Review ==
== レビュー時にチェックすること ==
 
レビューにはとってもとっても多くのチェック項目があります。このチェックリストは、新人レビューアが探す範囲のカテゴリを明確にして彼らを支援するために提供されていますが、この内容を満たせば完璧という意味ではありません。レビューアはパッケージのレビュー時に自分たちで優れた判断を行うべきです。チェックリストの各項目は2つのカテゴリ '''SHOULD''' と '''MUST''' に分類されます。
 
{{admon/warning|MUST 項目|'''MUST''' に該当する項目はパッケージャ(又はレビューア)が '''行わなければならない''' ことです。あるパッケージが '''MUST''' 項目を満たしていない場合、それは blocker と見なされます。blocker のパッケージがレビューで承認されることはありません。そういった項目は承認プロセスの前に修正されなければなりません。}}
 
* '''MUST''': 全てのパッケージに rpmlint を実行しなければなりません。そして、その出力をレビューで提示します。<ref>[[Packaging/Guidelines/ja#rpmlint|パッケージングガイドライン: rpmlint の使用]]</ref> <BR>
 
* '''MUST''': パッケージは[[Packaging/NamingGuidelines/ja|パッケージネーミングガイドライン]]に従って名前を付けなければなりません。<BR>
 
* '''MUST''': spec ファイルの名前はベースパッケージの <code>%{name}</code> と同じでなければなりません。特別な免除がない限り <code>%{name}.spec</code> のフォーマットになります。<ref>[[Packaging/NamingGuidelines/ja#Spec_file_name|ネーミングガイドライン: spec ファイルの名前付け]]</ref> <BR>
 
* '''MUST''': パッケージは[[Packaging/Guidelines/ja|パッケージングガイドライン]]に準拠しなければなりません。<BR>
 
* '''MUST''': パッケージは Fedora が承認したライセンスで[[Packaging/LicensingGuidelines/ja|ライセンスガイドライン]]に準拠しなければなりません。<BR>
 
* '''MUST''': spec ファイルのライセンスフィールドは実際のライセンスと一致しなければなりません。<ref>[[Packaging/LicensingGuidelines/ja#ValidLicenseShortNames|ライセンスガイドライン: 無効なライセンス短縮名]]</ref><BR>
 
* '''MUST''': ソースパッケージ(のみ)が独自のライセンスファイルを持っている場合、そのパッケージのライセンスのテキストファイルを <code>%doc</code> に追加しなければなりません。<ref>[[Packaging/LicensingGuidelines/ja#License Text |ライセンスガイドライン: ライセンステキスト]]</ref><BR>
 
* '''MUST''': spec ファイルはアメリカ英語で書かなければなりません。<ref>[[Packaging/Guidelines/ja#summary|パッケージングガイドライン: 要約とパッケージ説明]]</ref><BR>
 
* '''MUST''': パッケージの spec ファイルは読み易いものでなければなりません。<ref>[[Packaging/Guidelines/ja#Spec_Legibility|パッケージングガイドライン: spec ファイルの読み易さ]]</ref><BR>
 
* '''MUST''': パッケージのビルドに使用するソースは spec ファイルの URL で提供されているアップストリームのソースと同じでなければなりません。レビューアはこの確認作業に md5sum を使用すべきです。もし、このパッケージで指定したアップストリームの URL が存在しないなら、このパッケージをどう扱うかについて[[Packaging/SourceURL|ソース URL ガイドライン]]を参照してください。<BR>
 
* '''MUST''': パッケージは少なくとも1つの主要なアーキテクチャでコンパイルしてビルドに成功しなければなりません。<ref>[[Packaging/Guidelines/ja#Architecture_Support|Packaging Guidelines: アーキテクチャサポート]]</ref><BR>
 
* '''MUST''': パッケージをあるアーキテクチャでビルドしようとしてコンパイルに成功しないなら、そういったアーキテクチャは spec ファイルで <code>ExcludeArch</code> に設定すべきです。<code>ExcludeArch</code> に設定された各アーキテクチャは bugzilla に登録されなければなりません。登録したバグ ID は対応する ExcludeArch 行の隣にコメントとして記載すべきです。<ref>[[Packaging/Guidelines/ja#Architecture_Build_Failures|Packaging Guidelines: アーキテクチャの違いによるビルドの失敗]]</ref><BR>
 
* '''MUST''': [[Packaging/Guidelines#Exceptions_2|パッケージングガイドラインの例外事項]]に記載されているパッケージを除いて、ビルドをするための全ての依存関係は <code>BuildRequires</code> に定義されなければなりません。例外として記載されている <code>BuildRequires</code> を定義するかどうかは任意です。良識的に考えてください。<BR>
 
* '''MUST''': spec ファイルはロケールを適切に扱わなければなりません。これは <code>%find_lang</code> マクロを使用するこで行われます。<code>%{_datadir}/locale/*</code> を使用することは厳密に言えば禁止されています。<ref>[[Packaging/Guidelines/ja#Handling_Locale_Files|Packaging Guidelines: ロケールファイルを扱う]]</ref><BR>
 
* '''MUST''': 動的リンカのデフォルトパスに共有ライブラリ(ただのシンボリックリンクではない)を含む全てのバイナリ RPM パッケージ(又はサブパッケージ)は <code>%post</code> や <code>%postun</code> で ldconfig を実行しなければなりません。<ref>[[Packaging/Guidelines/ja#Shared_Libraries|Packaging Guidelines: 共有ライブラリ]]</ref><BR>
 
* '''MUST''': パッケージはシステムライブラリのコピーを含めてはいけません。<ref name="no_bundle">[[Packaging:Guidelines#Duplication_of_system_libraries|Packaging Guidelines: システムライブラリの重複]]</ref><BR>
 
* '''MUST''': パッケージを再配置可能であるように設計するなら、パッケージャはレビュー時にその要件、つまりその特別なパッケージの再配置を正当化する理由をはっきりと説明しなければなりません。この説明を行わずに /usr のパスを使用することは blocker と見なされます。<ref>[[Packaging/Guidelines/ja#RelocatablePackages|Packaging Guidelines: 再配置可能なパッケージ]]</ref><BR>
 
* '''MUST''': パッケージは作成するディレクトリを全て所有しなければなりません。もしあなたのパッケージが使用するディレクトリを作成しないなら、そのディレクトリを作成するパッケージに依存すべきです。<ref>[[Packaging/Guidelines/ja#FileAndDirectoryOwnership|Packaging Guidelines: ファイルとディレクトリの所有者]]</ref><BR>
 
* '''MUST''': Fedora パッケージは spec ファイルの %files セクションにリストされているファイルを1回以上リストしてはいけません(有名な例外: 特殊な状況でのライセンステキスト)。<ref>[[Packaging/Guidelines/ja#DuplicateFiles|Packaging Guidelines: 重複ファイル]]</ref><BR>
 
* '''MUST''': ファイルのパーミッションは適切にセットされなければなりません。例えば、実行プログラムは実行権限をセットします。全ての <code>%files</code> セクションは <code>%defattr(...)</code> 行を含めなればなりません。<ref>[[Packaging/Guidelines#FilePermissions|Packaging Guidelines: ファイルパーミッション]]</ref><BR>
 
* '''MUST''': パッケージは一貫性を持ってマクロを使用しなければなりません。<ref>[[Packaging/Guidelines#macros|Packaging Guidelines: マクロ]]</ref><BR>


There are many many things to check for a review. This list is provided to assist new reviewers in identifying areas that they should look for, but is by no means complete. Reviewers should use their own good judgement when reviewing packages. The items listed fall into two categories: '''SHOULD''' and '''MUST'''.
* '''MUST''': パッケージはコード、又は許容されるコンテンツを含まなければなりません。<ref>[[Packaging/Guidelines#CodeVsContent|Packaging Guidelines: コード Vs. コンテンツ]]</ref><BR>


{{admon/warning|MUST Items|Items marked as '''MUST''' are things that the package (or reviewer) '''MUST''' do. If a package fails a '''MUST''' item, that is considered a blocker. No package with blockers can be approved on a review. Those items must be fixed before approval can be given. }}
* '''MUST''': 大きなドキュメントファイルは -doc サブパッケージに分割されなければなりません(大きいの定義はパッケージャの判断に一任されますが、サイズに対しての制限はありません。大きいはサイズか分量のどちらか一方でも構いません)。<ref name="docs">[[Packaging/Guidelines#PackageDocumentation|Packaging Guidelines: ドキュメント]]</ref><BR>


* '''MUST''': rpmlint must be run on every package. The output should be posted in the review.<ref>[[Packaging/Guidelines#rpmlint|Packaging Guidelines: Use rpmlint]]</ref> <BR>
* '''MUST''': あるパッケージが %doc にドキュメントを含んでいるなら、アプリケーションの実行に影響を与えてはいけません。要約すると、ドキュメントが %doc にあるなら、そのプログラムはそこにドキュメントがなかったとしても正常に実行されなければなりません。<ref name="docs">[[Packaging/Guidelines#PackageDocumentation|Packaging Guidelines: ドキュメント]]</ref><BR>
* '''MUST''': The package must be named according to the [[Packaging/NamingGuidelines| Package Naming Guidelines]] .<BR>
 
* '''MUST''': The spec file name must match the base package <code>%{name}</code>, in the format <code>%{name}.spec</code> unless your package has an exemption. <ref>[[Packaging/NamingGuidelines#Spec_file_name| Naming Guidelines: Spec File Naming]]</ref> . <BR>
* '''MUST''': ヘッダファイルは -devel パッケージに含めなければなりません。<ref name="devel">[[Packaging/Guidelines#DevelPackages|Packaging Guidelines: Devel パッケージ]]</ref><BR>
* '''MUST''': The package must meet the [[Packaging/Guidelines|  Packaging Guidelines]] .<BR>
 
* '''MUST''': The package must be licensed with a Fedora approved license and meet the [[Packaging/LicensingGuidelines|  Licensing Guidelines]] .<BR>
* '''MUST''': 静的ライブラリは -static パッケージに含めなければなりません。<ref name="static">[[Packaging/Guidelines#StaticLibraries|Packaging Guidelines: 静的ライブラリのパッケージング]]</ref><BR>
* '''MUST''': The License field in the package spec file must match the actual license. <ref>[[Packaging/LicensingGuidelines#ValidLicenseShortNames| Licensing Guidelines: Valid License Short Names]]</ref><BR>
 
* '''MUST''': If (and only if) the source package includes the text of the license(s) in its own file, then that file, containing the text of the license(s) for the package must be included in <code>%doc</code>.<ref>[[Packaging/LicensingGuidelines#License Text |Licensing Guidelines: License Text]]</ref><BR>
* '''MUST''': あるパッケージがバージョン指定のある共有ライブラリ(例 libfoo.so.1.1)を含むなら、.so(バージョン指定がない)のライブラリファイルを -devel パッケージに含めなければなりません。<ref name="devel">[[Packaging/Guidelines#DevelPackages|Packaging Guidelines: Devel パッケージ]]</ref><BR>
* '''MUST''': The spec file must be written in American English. <ref>[[Packaging/Guidelines#summary|Packaging Guidelines: Summary]]</ref><BR>
 
* '''MUST''': The spec file for the package '''MUST''' be legible. <ref>[[Packaging/Guidelines#Spec_Legibility|Packaging Guidelines: Spec Legibility]]</ref><BR>
* '''MUST''': 大半のケースでは -devel パッケージは <code>Requires: %{name} = %{version}-%{release}</code> のようにフルバージョンの依存関係を使用してベースパッケージを要求しなければなりません。<ref name="requirebase">[[Packaging/Guidelines#RequiringBasePackage|Packaging Guidelines: ベースパッケージの要求]]</ref><BR>
* '''MUST''': The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use md5sum for this task.  If no upstream URL can be specified for this package, please see the [[Packaging/SourceURL|  Source URL Guidelines]]  for how to deal with this.<BR>
 
* '''MUST''': The package '''MUST''' successfully compile and build into binary rpms on at least one primary architecture. <ref>[[Packaging/Guidelines#Architecture_Support|Packaging Guidelines: Architecture Support]]</ref><BR>
* '''MUST''': パッケージは libtool のアーカイブ .la ファイルを含めてはいけません。.la ファイルはビルド時に spec ファイルで削除されなければなりません。<ref name="static">[[Packaging/Guidelines#StaticLibraries|Packaging Guidelines: 静的ライブラリのパッケージング]]</ref><BR>
* '''MUST''': If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in <code>ExcludeArch</code>. Each architecture listed in <code>ExcludeArch</code> '''MUST''' have a bug filed in bugzilla, describing the reason that the package does not compile/build/work on that architecture. The bug number '''MUST''' be placed in a comment, next to the corresponding <code>ExcludeArch</code> line. <ref>[[Packaging/Guidelines#Architecture_Build_Failures|Packaging Guidelines: Architecture Build Failures]]</ref><BR>
 
* '''MUST''': All build dependencies must be listed in <code>BuildRequires</code>, except for any that are listed in the [[Packaging/Guidelines#Exceptions_2|exceptions section of the Packaging Guidelines]] ; inclusion of those as <code>BuildRequires</code> is optional. Apply common sense.<BR>
* '''MUST''': GUI アプリケーションを含むパッケージは %{name}.desktop ファイルを含めなければなりません。そして %{name}.desktop ファイルは %install セクションの desktop-file-install で適切にインストールされなければなりません。あなたの GUI アプリケーションが .desktop ファイルを必要ないと思うなら、その理由をコメントで spec ファイルに記載しなければなりません。<ref>[[Packaging/Guidelines#desktop|Packaging Guidelines: デスクトップファイル]]</ref><BR>
* '''MUST''': The spec file MUST handle locales properly. This is done by using the <code>%find_lang</code> macro. Using <code>%{_datadir}/locale/*</code> is strictly forbidden.<ref>[[Packaging/Guidelines#Handling_Locale_Files|Packaging Guidelines: Handling Locale Files]]</ref><BR>
 
* '''MUST''': Every binary RPM package (or subpackage) which stores shared library files (not just symlinks) in any of the dynamic linker's default paths, must call ldconfig in <code>%post</code> and <code>%postun</code>. <ref>[[Packaging/Guidelines#Shared_Libraries|Packaging Guidelines: Shared Libraries]]</ref><BR>
* '''MUST''': パッケージは他のパッケージが既に所有しているファイルを所有してはいけません。基本原則として最初にインストールされるパッケージが、他のパッケージがそのファイルの存在に依存する可能性があるファイルを所有すべきです。例えば、これは <code>filesystem</code> 又は <code>man</code> パッケージによって所有されるファイルであっても所有権を共有するようなパッケージは Fedora にはないということです。もし他のパッケージが所有しているファイルを所有するための適切な理由があるなら、パッケージレビューのときに連絡してください。<ref>[[Packaging/Guidelines#FileAndDirectoryOwnership|Packaging Guidelines: ファイルとディレクトリの所有者]]</ref><BR>
* '''MUST''': Packages must NOT bundle copies of system libraries.<ref name="no_bundle">[[Packaging:Guidelines#Duplication_of_system_libraries|Packaging Guidelines: Duplication of System Libraries]]</ref><BR>
 
* '''MUST''': If the package is designed to be relocatable, the packager must state this fact in the request for review, along with the rationalization for relocation of that specific package. Without this, use of Prefix: /usr is considered a blocker. <ref>[[Packaging/Guidelines#RelocatablePackages|Packaging Guidelines: Relocatable Packages]]</ref><BR>
* '''MUST''': rpm パッケージの全てのファイル名は UTF-8 でエンコードされなければなりません。<ref>[[Packaging/Guidelines#FilenameEncoding|Packaging Guidelines: ファイル名のエンコーディング]]</ref><BR>
* '''MUST''': A package must own all directories that it creates. If it does not create a directory that it uses, then it should require a package which does create that directory.  <ref>[[Packaging/Guidelines#FileAndDirectoryOwnership|Packaging Guidelines: File And Directory Ownership]]</ref><BR>
* '''MUST''': A Fedora package must not list a file more than once in the spec file's %files listings. (Notable exception: license texts in specific situations)<ref>[[Packaging/Guidelines#DuplicateFiles|Packaging Guidelines: Duplicate Files]]</ref><BR>
* '''MUST''': Permissions on files must be set properly. Executables should be set with executable permissions, for example. Every <code>%files</code> section must include a <code>%defattr(...)</code> line. <ref>[[Packaging/Guidelines#FilePermissions|Packaging Guidelines: File Permissions]]</ref><BR>
* '''MUST''': Each package must consistently use macros. <ref>[[Packaging/Guidelines#macros|Packaging Guidelines: Macros]]</ref><BR>
* '''MUST''': The package must contain code, or permissable content. <ref>[[Packaging/Guidelines#CodeVsContent|Packaging Guidelines: Code Vs. Content]]</ref><BR>
* '''MUST''': Large documentation files must go in a -doc subpackage. (The definition of large is left up to the packager's best judgement, but is not restricted to size. Large can refer to either size or quantity). <ref name="docs">[[Packaging/Guidelines#PackageDocumentation|Packaging Guidelines: Package Documentation]]</ref><BR>
* '''MUST''': If a package includes something as %doc, it must not affect the runtime of the application. To summarize: If it is in %doc, the program must run properly if it is not present. <ref name="docs">[[Packaging/Guidelines#PackageDocumentation|Packaging Guidelines: Package Documentation]]</ref><BR>
* '''MUST''': Header files must be in a -devel package. <ref name="devel">[[Packaging/Guidelines#DevelPackages|Packaging Guidelines: Devel Packages]]</ref><BR>
* '''MUST''': Static libraries must be in a -static package. <ref name="static">[[Packaging/Guidelines#StaticLibraries|Packaging Guidelines: Packaging Static Libraries]]</ref><BR>
* '''MUST''': If a package contains library files with a suffix (e.g. libfoo.so.1.1), then library files that end in .so (without suffix) must go in a -devel package. <ref name="devel">[[Packaging/Guidelines#DevelPackages|Packaging Guidelines: Devel Packages]]</ref><BR>
* '''MUST''': In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: <code>Requires: %{name} = %{version}-%{release} </code> <ref name="requirebase">[[Packaging/Guidelines#RequiringBasePackage|Packaging Guidelines: Requiring Base Package]]</ref><BR>
* '''MUST''': Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.<ref name="static">[[Packaging/Guidelines#StaticLibraries|Packaging Guidelines: Packaging Static Libraries]]</ref><BR>
* '''MUST''': Packages containing GUI applications must include a %{name}.desktop file, and that file must be properly installed with desktop-file-install in the %install section. If you feel that your packaged GUI application does not need a .desktop file, you must put a comment in the spec file with your explanation. <ref>[[Packaging/Guidelines#desktop|Packaging Guidelines: Desktop files]]</ref><BR>
* '''MUST''': Packages must not own files or directories already owned by other packages. The rule of thumb here is that the first package to be installed should own the files or directories that other packages may rely upon. This means, for example, that no package in Fedora should ever share ownership with any of the files or directories owned by the <code>filesystem</code> or <code>man</code> package. If you feel that you have a good reason to own a file or directory that another package owns, then please present that at package review time. <ref>[[Packaging/Guidelines#FileAndDirectoryOwnership|Packaging Guidelines: File And Directory Ownership]]</ref><BR>
* '''MUST''': All filenames in rpm packages must be valid UTF-8. <ref>[[Packaging/Guidelines#FilenameEncoding|Packaging Guidelines: Filename Encoding]]</ref><BR>


<BR>
<BR>
Line 57: Line 90:
<BR>
<BR>


{{admon/important|SHOULD Items:|Items marked as '''SHOULD''' are things that the package (or reviewer) '''SHOULD''' do, but is not required to do.}}
{{admon/important|SHOULD 項目:| '''SHOULD''' に該当する項目はパッケージャ(又はレビューア)が '''行うべき''' ことですが、義務付けられているわけではありません。}}
 
* '''SHOULD''': ソースパッケージがアップストリームに由来する独立したライセンスファイルを持っていないなら、パッケージャはアップストリームへライセンスファイルを含めるように尋ねるべきです。<ref>[[Packaging/LicensingGuidelines#License_Text|ライセンスガイドライン: ライセンス]]</ref><BR>
 
* '''SHOULD''': spec ファイルの要約やパッケージ説明のセクションは、可能なら非英語圏のために翻訳された内容を含めるべきです。<ref>[[Packaging/Guidelines#summary|Packaging Guidelines: 要約とパッケージ説明]]</ref><BR>
 
* '''SHOULD''': レビューアは mock でパッケージをビルドするテストをすべきです。<ref>[[PackageMaintainers/MockTricks|Mock Tricks]]</ref><BR>
 
* '''SHOULD''': パッケージャは全てのサポートされたアーキテクチャでバイナリ RPMS をコンパイルしてビルドすべきです。<ref>[[Packaging/Guidelines#ArchitectureSupport|Packaging Guidelines: アーキテクチャサポート]]</ref><BR>
 
* '''SHOULD''': レビューアは記載されているパッケージ機能をテストすべきです。例えば、実行するとセグメンテーションフォールトしてはいけません。<BR>
 
* '''SHOULD''': スクリプトレットを使用するなら分かり易いものでなければなりません。曖昧な場合、レビューアに分かり易いものに決定することが一任されます。<ref>[[Packaging/Guidelines#Scriptlets|Packaging Guidelines: スクリプトレット]]</ref><BR>
 
* '''SHOULD''': 通常 devel 以外のサブパッケージは完全にバージョン指定でベースパッケージに依存すべきです。 <ref name="requirebase">[[Packaging/Guidelines#RequiringBasePackage|Packaging Guidelines: ベースパッケージの要求]]</ref><BR>
 
* '''SHOULD''': pkgconfig(.pc) ファイルをどのパッケージに含めるかは、その使用方法に依存します。pkgconfig ファイルは、ほとんど開発の目的のために使用されるので、-devel パッケージに含められます。分かり易い例外としては、メインパッケージそのものがユーザ向けのランタイムをインストールしない開発向けのツールがあります。例えば、gcc や gdb になります。 <ref name="pkgconfig">[[Packaging/Guidelines#PkgconfigFiles|Packaging Guidelines: Pkgconfig ファイル]]</ref><BR>
 
* '''SHOULD''': パッケージが /etc, /bin, /sbin, /usr/bin 又は /usr/sbin 以外でファイルの依存関係を持つなら、ファイルそのものではなく、そのファイルを提供するパッケージに依存関係があるものと見なしてください。<ref>[[Packaging/Guidelines#FileDeps|Packaging Guidelines: ファイルの依存関係]]</ref><BR>


* '''SHOULD''': If the source package does not include license text(s) as a separate file from upstream, the packager SHOULD query upstream to include it. <ref>[[Packaging/LicensingGuidelines#License_Text|Licensing Guidelines: License Text]]</ref><BR>
* '''SHOULD''': パッケージの全てのバイナリ/スクリプトのために man ページを作成すべきです。もし man ページがないなら、アップストリームで man ページを追加するように働きかけてください。<ref name="manpages">[[Packaging/Guidelines#Man_pages|Packaging Guidelines: man ページ]]</ref><BR>
* '''SHOULD''': The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available. <ref>[[Packaging/Guidelines#summary|Packaging Guidelines: Summary and description]]</ref><BR>
* '''SHOULD''': The reviewer should test that the package builds in mock. <ref>[[PackageMaintainers/MockTricks|Mock Tricks]]</ref><BR>
* '''SHOULD''': The package should compile and build into binary rpms on all supported architectures. <ref>[[Packaging/Guidelines#ArchitectureSupport|Packaging Guidelines: Architecture Support]]</ref><BR>
* '''SHOULD''': The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.<BR>
* '''SHOULD''': If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity. <ref>[[Packaging/Guidelines#Scriptlets|Packaging Guidelines: Scriptlets]]</ref><BR>
* '''SHOULD''': Usually, subpackages other than devel should require the base package using a fully versioned dependency. <ref name="requirebase">[[Packaging/Guidelines#RequiringBasePackage|Packaging Guidelines: Requiring Base Package]]</ref><BR>
* '''SHOULD''': The placement of pkgconfig(.pc) files depends on their usecase, and this is usually for development purposes, so should be placed in a -devel pkg.  A reasonable exception is that the main pkg itself is a devel tool not installed in a user runtime, e.g. gcc or gdb. <ref name="pkgconfig">[[Packaging/Guidelines#PkgconfigFiles|Packaging Guidelines: Pkgconfig Files]]</ref><BR>
* '''SHOULD''': If the package has file dependencies outside of /etc, /bin, /sbin, /usr/bin, or /usr/sbin consider requiring the package which provides the file instead of the file itself. <ref>[[Packaging/Guidelines#FileDeps|Packaging Guidelines: File Dependencies]]</ref><BR>
* '''SHOULD''': your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.<ref name="manpages">[[Packaging/Guidelines#Man_pages|Packaging Guidelines: Man Pages]]</ref><BR>


== References to the Fedora Packaging Guidelines ==
== Fedora パッケージングガイドラインのリファレンス ==
<references/>
<references/>

Latest revision as of 18:35, 4 August 2010

パッケージレビューガイドライン

これはパッケージレビューのためのガイドラインです。できるだけ包括的に分かり易いようこのレビューガイドラインを作成しようとはしていますが、完璧なチェックリストを作成することは不可能だということに注意してください。レビューアと貢献者(パッケージャ)は、何らかの内容が不明確で疑わしいときは必ずfedora-packaging メーリングリストへ質問して、最も良い判断を行うべきです。

Author: Tom 'spot' Callaway
Revision: 0.30
Initial Draft: Monday Jun 27, 2005
Last Revised: Thursday, Jul 8, 2010

パッケージレビュープロセス

貢献者とレビューアはパッケージレビュープロセスに従います。

レビュー時にチェックすること

レビューにはとってもとっても多くのチェック項目があります。このチェックリストは、新人レビューアが探す範囲のカテゴリを明確にして彼らを支援するために提供されていますが、この内容を満たせば完璧という意味ではありません。レビューアはパッケージのレビュー時に自分たちで優れた判断を行うべきです。チェックリストの各項目は2つのカテゴリ SHOULD と MUST に分類されます。

MUST 項目
MUST に該当する項目はパッケージャ(又はレビューア)が 行わなければならない ことです。あるパッケージが MUST 項目を満たしていない場合、それは blocker と見なされます。blocker のパッケージがレビューで承認されることはありません。そういった項目は承認プロセスの前に修正されなければなりません。
  • MUST: 全てのパッケージに rpmlint を実行しなければなりません。そして、その出力をレビューで提示します。[1]
  • MUST: spec ファイルの名前はベースパッケージの %{name} と同じでなければなりません。特別な免除がない限り %{name}.spec のフォーマットになります。[2]
  • MUST: spec ファイルのライセンスフィールドは実際のライセンスと一致しなければなりません。[3]
  • MUST: ソースパッケージ(のみ)が独自のライセンスファイルを持っている場合、そのパッケージのライセンスのテキストファイルを %doc に追加しなければなりません。[4]
  • MUST: spec ファイルはアメリカ英語で書かなければなりません。[5]
  • MUST: パッケージの spec ファイルは読み易いものでなければなりません。[6]
  • MUST: パッケージのビルドに使用するソースは spec ファイルの URL で提供されているアップストリームのソースと同じでなければなりません。レビューアはこの確認作業に md5sum を使用すべきです。もし、このパッケージで指定したアップストリームの URL が存在しないなら、このパッケージをどう扱うかについてソース URL ガイドラインを参照してください。
  • MUST: パッケージは少なくとも1つの主要なアーキテクチャでコンパイルしてビルドに成功しなければなりません。[7]
  • MUST: パッケージをあるアーキテクチャでビルドしようとしてコンパイルに成功しないなら、そういったアーキテクチャは spec ファイルで ExcludeArch に設定すべきです。ExcludeArch に設定された各アーキテクチャは bugzilla に登録されなければなりません。登録したバグ ID は対応する ExcludeArch 行の隣にコメントとして記載すべきです。[8]
  • MUST: パッケージングガイドラインの例外事項に記載されているパッケージを除いて、ビルドをするための全ての依存関係は BuildRequires に定義されなければなりません。例外として記載されている BuildRequires を定義するかどうかは任意です。良識的に考えてください。
  • MUST: spec ファイルはロケールを適切に扱わなければなりません。これは %find_lang マクロを使用するこで行われます。%{_datadir}/locale/* を使用することは厳密に言えば禁止されています。[9]
  • MUST: 動的リンカのデフォルトパスに共有ライブラリ(ただのシンボリックリンクではない)を含む全てのバイナリ RPM パッケージ(又はサブパッケージ)は %post や %postun で ldconfig を実行しなければなりません。[10]
  • MUST: パッケージはシステムライブラリのコピーを含めてはいけません。[11]
  • MUST: パッケージを再配置可能であるように設計するなら、パッケージャはレビュー時にその要件、つまりその特別なパッケージの再配置を正当化する理由をはっきりと説明しなければなりません。この説明を行わずに /usr のパスを使用することは blocker と見なされます。[12]
  • MUST: パッケージは作成するディレクトリを全て所有しなければなりません。もしあなたのパッケージが使用するディレクトリを作成しないなら、そのディレクトリを作成するパッケージに依存すべきです。[13]
  • MUST: Fedora パッケージは spec ファイルの %files セクションにリストされているファイルを1回以上リストしてはいけません(有名な例外: 特殊な状況でのライセンステキスト)。[14]
  • MUST: ファイルのパーミッションは適切にセットされなければなりません。例えば、実行プログラムは実行権限をセットします。全ての %files セクションは %defattr(...) 行を含めなればなりません。[15]
  • MUST: パッケージは一貫性を持ってマクロを使用しなければなりません。[16]
  • MUST: パッケージはコード、又は許容されるコンテンツを含まなければなりません。[17]
  • MUST: 大きなドキュメントファイルは -doc サブパッケージに分割されなければなりません(大きいの定義はパッケージャの判断に一任されますが、サイズに対しての制限はありません。大きいはサイズか分量のどちらか一方でも構いません)。[18]
  • MUST: あるパッケージが %doc にドキュメントを含んでいるなら、アプリケーションの実行に影響を与えてはいけません。要約すると、ドキュメントが %doc にあるなら、そのプログラムはそこにドキュメントがなかったとしても正常に実行されなければなりません。[18]
  • MUST: ヘッダファイルは -devel パッケージに含めなければなりません。[19]
  • MUST: 静的ライブラリは -static パッケージに含めなければなりません。[20]
  • MUST: あるパッケージがバージョン指定のある共有ライブラリ(例 libfoo.so.1.1)を含むなら、.so(バージョン指定がない)のライブラリファイルを -devel パッケージに含めなければなりません。[19]
  • MUST: 大半のケースでは -devel パッケージは Requires: %{name} = %{version}-%{release} のようにフルバージョンの依存関係を使用してベースパッケージを要求しなければなりません。[21]
  • MUST: パッケージは libtool のアーカイブ .la ファイルを含めてはいけません。.la ファイルはビルド時に spec ファイルで削除されなければなりません。[20]
  • MUST: GUI アプリケーションを含むパッケージは %{name}.desktop ファイルを含めなければなりません。そして %{name}.desktop ファイルは %install セクションの desktop-file-install で適切にインストールされなければなりません。あなたの GUI アプリケーションが .desktop ファイルを必要ないと思うなら、その理由をコメントで spec ファイルに記載しなければなりません。[22]
  • MUST: パッケージは他のパッケージが既に所有しているファイルを所有してはいけません。基本原則として最初にインストールされるパッケージが、他のパッケージがそのファイルの存在に依存する可能性があるファイルを所有すべきです。例えば、これは filesystem 又は man パッケージによって所有されるファイルであっても所有権を共有するようなパッケージは Fedora にはないということです。もし他のパッケージが所有しているファイルを所有するための適切な理由があるなら、パッケージレビューのときに連絡してください。[23]
  • MUST: rpm パッケージの全てのファイル名は UTF-8 でエンコードされなければなりません。[24]



SHOULD 項目:
SHOULD に該当する項目はパッケージャ(又はレビューア)が 行うべき ことですが、義務付けられているわけではありません。
  • SHOULD: ソースパッケージがアップストリームに由来する独立したライセンスファイルを持っていないなら、パッケージャはアップストリームへライセンスファイルを含めるように尋ねるべきです。[25]
  • SHOULD: spec ファイルの要約やパッケージ説明のセクションは、可能なら非英語圏のために翻訳された内容を含めるべきです。[26]
  • SHOULD: レビューアは mock でパッケージをビルドするテストをすべきです。[27]
  • SHOULD: パッケージャは全てのサポートされたアーキテクチャでバイナリ RPMS をコンパイルしてビルドすべきです。[28]
  • SHOULD: レビューアは記載されているパッケージ機能をテストすべきです。例えば、実行するとセグメンテーションフォールトしてはいけません。
  • SHOULD: スクリプトレットを使用するなら分かり易いものでなければなりません。曖昧な場合、レビューアに分かり易いものに決定することが一任されます。[29]
  • SHOULD: 通常 devel 以外のサブパッケージは完全にバージョン指定でベースパッケージに依存すべきです。 [21]
  • SHOULD: pkgconfig(.pc) ファイルをどのパッケージに含めるかは、その使用方法に依存します。pkgconfig ファイルは、ほとんど開発の目的のために使用されるので、-devel パッケージに含められます。分かり易い例外としては、メインパッケージそのものがユーザ向けのランタイムをインストールしない開発向けのツールがあります。例えば、gcc や gdb になります。 [30]
  • SHOULD: パッケージが /etc, /bin, /sbin, /usr/bin 又は /usr/sbin 以外でファイルの依存関係を持つなら、ファイルそのものではなく、そのファイルを提供するパッケージに依存関係があるものと見なしてください。[31]
  • SHOULD: パッケージの全てのバイナリ/スクリプトのために man ページを作成すべきです。もし man ページがないなら、アップストリームで man ページを追加するように働きかけてください。[32]

Fedora パッケージングガイドラインのリファレンス

  1. ↑ パッケージングガイドライン: rpmlint の使用
  2. ↑ ネーミングガイドライン: spec ファイルの名前付け
  3. ↑ ライセンスガイドライン: 無効なライセンス短縮名
  4. ↑ ライセンスガイドライン: ライセンステキスト
  5. ↑ パッケージングガイドライン: 要約とパッケージ説明
  6. ↑ パッケージングガイドライン: spec ファイルの読み易さ
  7. ↑ Packaging Guidelines: アーキテクチャサポート
  8. ↑ Packaging Guidelines: アーキテクチャの違いによるビルドの失敗
  9. ↑ Packaging Guidelines: ロケールファイルを扱う
  10. ↑ Packaging Guidelines: 共有ライブラリ
  11. ↑ Packaging Guidelines: システムライブラリの重複
  12. ↑ Packaging Guidelines: 再配置可能なパッケージ
  13. ↑ Packaging Guidelines: ファイルとディレクトリの所有者
  14. ↑ Packaging Guidelines: 重複ファイル
  15. ↑ Packaging Guidelines: ファイルパーミッション
  16. ↑ Packaging Guidelines: マクロ
  17. ↑ Packaging Guidelines: コード Vs. コンテンツ
  18. ↑ 18.0 18.1 Packaging Guidelines: ドキュメント
  19. ↑ 19.0 19.1 Packaging Guidelines: Devel パッケージ
  20. ↑ 20.0 20.1 Packaging Guidelines: 静的ライブラリのパッケージング
  21. ↑ 21.0 21.1 Packaging Guidelines: ベースパッケージの要求
  22. ↑ Packaging Guidelines: デスクトップファイル
  23. ↑ Packaging Guidelines: ファイルとディレクトリの所有者
  24. ↑ Packaging Guidelines: ファイル名のエンコーディング
  25. ↑ ライセンスガイドライン: ライセンス
  26. ↑ Packaging Guidelines: 要約とパッケージ説明
  27. ↑ Mock Tricks
  28. ↑ Packaging Guidelines: アーキテクチャサポート
  29. ↑ Packaging Guidelines: スクリプトレット
  30. ↑ Packaging Guidelines: Pkgconfig ファイル
  31. ↑ Packaging Guidelines: ファイルの依存関係
  32. ↑ Packaging Guidelines: man ページ
Retrieved from "https://fedoraproject.org/w/index.php?title=Packaging/ReviewGuidelines/ja&oldid=190643"