From Fedora Project Wiki
Line 22: Line 22:
 
{{admon/warning|MUST 項目|'''MUST''' に該当する項目はパッケージャ(又はレビューア)が '''行わなければならない''' ことです。あるパッケージが '''MUST''' 項目を満たしていない場合、それは blocker と見なされます。blocker のパッケージがレビューで承認されることはありません。そういった項目は承認プロセスの前に修正されなければなりません。}}
 
{{admon/warning|MUST 項目|'''MUST''' に該当する項目はパッケージャ(又はレビューア)が '''行わなければならない''' ことです。あるパッケージが '''MUST''' 項目を満たしていない場合、それは blocker と見なされます。blocker のパッケージがレビューで承認されることはありません。そういった項目は承認プロセスの前に修正されなければなりません。}}
  
* '''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''': 全てのパッケージに rpmlint を実行しなければなりません。そして、その出力をレビューで提示します。<ref>[[Packaging/Guidelines#rpmlint|パッケージングガイドライン: rpmlint の使用]]</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''': パッケージは[[Packaging/NamingGuidelines|パッケージネーミングガイドライン]]に従って名前を付けなければなりません。<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''': spec ファイルの名前はベースパッケージの <code>%{name}</code> と同じでなければなりません。特別な免除がない限り <code>%{name}.spec</code> のフォーマットになります。<ref>[[Packaging/NamingGuidelines#Spec_file_name|ネーミングガイドライン: spec ファイルの名前付け]]</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''': パッケージは[[Packaging/Guidelines|パッケージングガイドライン]]に準拠しなければなりません。<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''': パッケージは Fedora が承認したライセンスで[[Packaging/LicensingGuidelines|ライセンスガイドライン]]に準拠しなければなりません。<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''': spec ファイルのライセンスフィールドは実際のライセンスと一致しなければなりません。<ref>[[Packaging/LicensingGuidelines#ValidLicenseShortNames|ライセンスガイドライン: 無効なライセンス短縮名]]</ref><BR>
 +
 
 +
* '''MUST''': ソースパッケージ(のみ)が独自のライセンスファイルを持っている場合、そのパッケージのライセンスのテキストファイルを <code>%doc</code> に追加しなければなりません。<ref>[[Packaging/LicensingGuidelines#License Text |ライセンスガイドライン: ライセンステキスト]]</ref><BR>
 +
 
 +
* '''MUST''': spec ファイルはアメリカ英語で書かなければなりません。<ref>[[Packaging/Guidelines#summary|パッケージングガイドライン: 要約とパッケージ説明]]</ref><BR>
 +
 
 +
* '''MUST''': パッケージの spec ファイルは読み易いものでなければなりません。<ref>[[Packaging/Guidelines#Spec_Legibility|パッケージングガイドライン: spec ファイルの読み易さ]]</ref><BR>
 +
 
 +
* '''MUST''': パッケージのビルドに使用するソースは spec ファイルの URL で提供されているアップストリームのソースと同じでなければなりません。レビューアはこの確認作業に md5sum を使用すべきです。もし、このパッケージで指定したアップストリームの URL が存在しないなら、このパッケージをどう扱うかについて[[Packaging/SourceURL|ソース URL ガイドライン]]を参照してください。<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''': 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''': 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''': 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>

Revision as of 13:38, 28 July 2010

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

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

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

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

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

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

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

Warning.png
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: The package MUST successfully compile and build into binary rpms on at least one primary architecture. [7]
  • MUST: If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in ExcludeArch. Each architecture listed in ExcludeArch 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 ExcludeArch line. [8]
  • MUST: All build dependencies must be listed in BuildRequires, except for any that are listed in the exceptions section of the Packaging Guidelines ; inclusion of those as BuildRequires is optional. Apply common sense.
  • MUST: The spec file MUST handle locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.[9]
  • 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 %post and %postun. [10]
  • MUST: Packages must NOT bundle copies of system libraries.[11]
  • 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. [12]
  • 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. [13]
  • 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)[14]
  • MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example. Every %files section must include a %defattr(...) line. [15]
  • MUST: Each package must consistently use macros. [16]
  • MUST: The package must contain code, or permissable content. [17]
  • 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). [18]
  • 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. [18]
  • MUST: Header files must be in a -devel package. [19]
  • MUST: Static libraries must be in a -static package. [20]
  • 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. [19]
  • MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name} = %{version}-%{release} [21]
  • MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.[20]
  • 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. [22]
  • 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 filesystem or man 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. [23]
  • MUST: All filenames in rpm packages must be valid UTF-8. [24]




Important.png
SHOULD Items:
Items marked as SHOULD are things that the package (or reviewer) SHOULD do, but is not required to do.
  • 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. [25]
  • SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available. [26]
  • SHOULD: The reviewer should test that the package builds in mock. [27]
  • SHOULD: The package should compile and build into binary rpms on all supported architectures. [28]
  • SHOULD: The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.
  • SHOULD: If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity. [29]
  • SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency. [21]
  • 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. [30]
  • 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. [31]
  • SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.[32]

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

  1. パッケージングガイドライン: rpmlint の使用
  2. ネーミングガイドライン: spec ファイルの名前付け
  3. ライセンスガイドライン: 無効なライセンス短縮名
  4. ライセンスガイドライン: ライセンステキスト
  5. パッケージングガイドライン: 要約とパッケージ説明
  6. パッケージングガイドライン: spec ファイルの読み易さ
  7. Packaging Guidelines: Architecture Support
  8. Packaging Guidelines: Architecture Build Failures
  9. Packaging Guidelines: Handling Locale Files
  10. Packaging Guidelines: Shared Libraries
  11. Packaging Guidelines: Duplication of System Libraries
  12. Packaging Guidelines: Relocatable Packages
  13. Packaging Guidelines: File And Directory Ownership
  14. Packaging Guidelines: Duplicate Files
  15. Packaging Guidelines: File Permissions
  16. Packaging Guidelines: Macros
  17. Packaging Guidelines: Code Vs. Content
  18. 18.0 18.1 Packaging Guidelines: Package Documentation
  19. 19.0 19.1 Packaging Guidelines: Devel Packages
  20. 20.0 20.1 Packaging Guidelines: Packaging Static Libraries
  21. 21.0 21.1 Packaging Guidelines: Requiring Base Package
  22. Packaging Guidelines: Desktop files
  23. Packaging Guidelines: File And Directory Ownership
  24. Packaging Guidelines: Filename Encoding
  25. Licensing Guidelines: License Text
  26. Packaging Guidelines: Summary and description
  27. Mock Tricks
  28. Packaging Guidelines: Architecture Support
  29. Packaging Guidelines: Scriptlets
  30. Packaging Guidelines: Pkgconfig Files
  31. Packaging Guidelines: File Dependencies
  32. Packaging Guidelines: Man Pages