From Fedora Project Wiki
(Drafted for easier future reviews) |
(Updated requirements) |
||
Line 1: | Line 1: | ||
== MUST requirements == | == MUST requirements == | ||
<pre> | <pre> | ||
[ ] MUST: rpmlint must be run on | [ ] MUST: rpmlint must be run on the source rpm and all binary rpms the | ||
[ ] MUST: The package must be named according to the | build produces. The output should be posted in the review.(refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#rpmlint) <BR> | |||
[ ] MUST: The spec file name must match the base package %{name} | [ ] MUST: The package must be named according to the | ||
[ ] MUST: The package must meet the Packaging Guidelines | http://fedoraproject.org/wiki/Packaging/NamingGuidelinesge Naming Guidelines | ||
[ ] MUST: The package must be licensed with a Fedora approved license | .<BR> | ||
[ ] MUST: The spec file name must match the base package | |||
[ ] MUST: The License field in the package spec file must match the | <code>%{name}</code>, in the format <code>%{name}.spec</code> unless your | ||
package has an exemption. (refer to | |||
[ ] MUST: If (and only if) the source package includes the text of the | http://fedoraproject.org/wiki/Packaging/NamingGuidelines#Spec_file_name). <BR> | ||
license(s) in its own file, then that file, containing the text of | [ ] MUST: The package must meet the | ||
http://fedoraproject.org/wiki/Packaging/Guidelines.<BR> | |||
[ ] MUST: The spec file must be written in American English. | [ ] MUST: The package must be licensed with a Fedora approved license and | ||
[ ] MUST: The spec file for the package MUST be legible. | meet the http://fedoraproject.org/wiki/Packaging/LicensingGuidelines.<BR> | ||
[ ] MUST: The sources used to build the package must match the upstream | [ ] MUST: The License field in the package spec file must match the actual | ||
source, as provided in the spec URL. Reviewers should use md5sum for | license. (refer to | ||
http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#ValidLicenseShortNames)<BR> | |||
[ ] MUST: If (and only if) the source package includes the text of the | |||
[ ] MUST: The package MUST successfully compile and build into | license(s) in its own file, then that file, containing the text of the | ||
rpms on at least one primary architecture | license(s) for the package must be included in <code>%doc</code>.(refer to | ||
[ ] MUST: If the package does not successfully compile, build or work on | http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License Text)<BR> | ||
an architecture, then those architectures should be listed in the | [ ] MUST: The spec file must be written in American English. (refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#summary)<BR> | |||
have a bug filed in bugzilla, describing the reason that the package | [ ] MUST: The spec file for the package '''MUST''' be legible. (refer to | ||
does not compile/build/work on that architecture. The bug number MUST | http://fedoraproject.org/wiki/Packaging/Guidelines#Spec_Legibility)<BR> | ||
[ ] MUST: The sources used to build the package must match the upstream | |||
[ ] MUST: All build dependencies must be listed in BuildRequires, except | 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 | |||
Guidelines ; inclusion of those as BuildRequires is optional. Apply | http://fedoraproject.org/wiki/Packaging/SourceURL for how to deal with | ||
this.<BR> | |||
[ ] MUST: The spec file MUST handle locales properly. This is done by | [ ] MUST: The package '''MUST''' successfully compile and build into | ||
using the %find_lang macro. Using %{_datadir}/locale/* is strictly | binary rpms on at least one primary architecture. (refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Support)<BR> | |||
[ ] MUST: Every binary RPM package (or subpackage) which stores shared | [ ] MUST: If the package does not successfully compile, build or work on | ||
library files (not just symlinks) in any of the dynamic linker's | an architecture, then those architectures should be listed in the spec in | ||
<code>ExcludeArch</code>. Each architecture listed in <code>ExcludeArch</code> | |||
[ ] MUST: If the package is designed to be relocatable, the packager must | '''MUST''' have a bug filed in bugzilla, describing the reason that the package | ||
state this fact in the request for review, along with the | 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. | |||
(refer to | |||
[ ] MUST: A package must own all directories that it creates. If it does | http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Build_Failures)<BR> | ||
not create a directory that it uses, then it should require a package | [ ] MUST: All build dependencies must be listed in | ||
<code>BuildRequires</code>, except for any that are listed in the | |||
[ ] MUST: A package must not | http://fedoraproject.org/wiki/Packaging/Guidelines#Exceptions_2 section of the | ||
Packaging Guidelines ; inclusion of those as <code>BuildRequires</code> is | |||
[ ] MUST: Permissions on files must be set properly. Executables should | optional. Apply common sense.<BR> | ||
[ ] MUST: The spec file MUST handle locales properly. This is done by | |||
using the <code>%find_lang</code> macro. Using | |||
[ ] MUST: Each package must | <code>%{_datadir}/locale/*</code> is strictly forbidden.(refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#Handling_Locale_Files)<BR> | |||
[ ] MUST: Every binary RPM package (or subpackage) which stores shared | |||
[ ] MUST: The package must contain code, or permissable content. | library files (not just symlinks) in any of the dynamic linker's default paths, | ||
[ ] MUST: Large documentation files must go in a -doc subpackage. (The | must call ldconfig in <code>%post</code> and <code>%postun</code>. (refer to | ||
definition of large is left up to the packager's best judgement, but | http://fedoraproject.org/wiki/Packaging/Guidelines#Shared_Libraries)<BR> | ||
[ ] MUST: Packages must NOT bundle copies of system libraries.(refer to | |||
http://fedoraproject.org/wiki/Packaging:Guidelines#Duplication_of_system_libraries)<BR> | |||
[ ] MUST: If a package includes something as %doc, it must not affect the | [ ] MUST: If the package is designed to be relocatable, the packager must | ||
runtime of the application. To summarize: If it is in %doc, the | 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 | |||
[ ] MUST: Header files must be in a -devel package. | considered a blocker. (refer to | ||
[ ] MUST: Static libraries must be in a -static package. | http://fedoraproject.org/wiki/Packaging/Guidelines#RelocatablePackages)<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 | |||
[ ] MUST: If a package contains library files with a suffix (e.g. | does create that directory. (refer to | ||
libfoo.so.1.1), then library files that end in .so (without suffix) | http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)<BR> | ||
[ ] MUST: A Fedora package must not list a file more than once in the spec | |||
[ ] MUST: In the vast majority of cases, devel packages must require the | file's %files listings. (Notable exception: license texts in specific | ||
base package using a fully versioned dependency: Requires: %{name} = | situations)(refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#DuplicateFiles)<BR> | |||
[ ] MUST: Packages must NOT contain any .la libtool archives, these must | [ ] MUST: Permissions on files must be set properly. Executables should be | ||
be removed in the spec if they are built. | set with executable permissions, for example. (refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#FilePermissions)<BR> | |||
[ ] MUST: Each package must consistently use macros. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#macros)<BR> | |||
[ ] MUST: The package must contain code, or permissable content. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#CodeVsContent)<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). (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)<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. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)<BR> | |||
[ ] MUST: Header files must be in a -devel package. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)<BR> | |||
[ ] MUST: Static libraries must be in a -static package. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)<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. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)<BR> | |||
[ ] MUST: In the vast majority of cases, devel packages must require the | |||
base package using a fully versioned dependency: <code>Requires: | |||
%{name}%{?_isa} = %{version}-%{release} </code> (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)<BR> | |||
[ ] MUST: Packages must NOT contain any .la libtool archives, these must | |||
be removed in the spec if they are built.(refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)<BR> | |||
[ ] MUST: Packages containing GUI applications must include a | [ ] MUST: Packages containing GUI applications must include a | ||
%{name}.desktop file, and that file must be properly installed with | %{name}.desktop file, and that file must be properly installed with | ||
desktop-file-install in the %install section. If you feel that your | 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. (refer to | |||
[ ] MUST: Packages must not own files or directories already owned by | http://fedoraproject.org/wiki/Packaging/Guidelines#desktop)<BR> | ||
other packages. The rule of thumb here is that the first package to | [ ] 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 | |||
good reason to own a file or directory that another package owns, | <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. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)<BR> | |||
[ ] MUST: All filenames in rpm packages must be valid UTF-8. | [ ] MUST: All filenames in rpm packages must be valid UTF-8. (refer to | ||
http://fedoraproject.org/wiki/Packaging/Guidelines#FilenameEncoding)<BR> | |||
</pre> | </pre> | ||
== SHOULD requirements == | == SHOULD requirements == | ||
<pre> | <pre> | ||
[ ] SHOULD query upstream to include it. | [ ] 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. | |||
(refer to | |||
http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License_Text)<BR> | |||
[ ] SHOULD: The description and summary sections in the package spec file | [ ] SHOULD: The description and summary sections in the package spec file | ||
should contain translations for supported Non-English languages, if available. | |||
(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#summary)<BR> | |||
[ ] SHOULD: The reviewer should test that the package builds in mock. | [ ] SHOULD: The reviewer should test that the package builds in mock. | ||
(refer to http://fedoraproject.org/wiki/PackageMaintainers/MockTricks)<BR> | |||
[ ] SHOULD: The package should compile and build into binary rpms on all | [ ] SHOULD: The package should compile and build into binary rpms on all | ||
supported architectures. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#ArchitectureSupport)<BR> | |||
[ ] SHOULD: The reviewer should test that the package functions as | [ ] 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 | [ ] SHOULD: If scriptlets are used, those scriptlets must be sane. This is | ||
vague, and left up to the reviewers judgement to determine sanity. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#Scriptlets)<BR> | |||
[ ] SHOULD: Usually, subpackages other than devel should require the base | [ ] SHOULD: Usually, subpackages other than devel should require the base | ||
package using a fully versioned dependency. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)<BR> | |||
[ ] SHOULD: The placement of pkgconfig(.pc) files depends on their | [ ] 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. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#PkgconfigFiles)<BR> | |||
[ ] SHOULD: If the package has file dependencies outside of /etc, /bin, | [ ] 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. (refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#FileDeps)<BR> | |||
[ ] SHOULD: your package should contain man pages for binaries/scripts. If | [ ] SHOULD: your package should contain man pages for binaries/scripts. If | ||
it doesn't, work with upstream to add them where they make sense.(refer to | |||
http://fedoraproject.org/wiki/Packaging/Guidelines#Man_pages)<BR> | |||
</pre> | </pre> |
Revision as of 13:41, 17 October 2011
MUST requirements
[ ] MUST: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#rpmlint) <BR> [ ] MUST: The package must be named according to the http://fedoraproject.org/wiki/Packaging/NamingGuidelinesge 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. (refer to http://fedoraproject.org/wiki/Packaging/NamingGuidelines#Spec_file_name). <BR> [ ] MUST: The package must meet the http://fedoraproject.org/wiki/Packaging/Guidelines.<BR> [ ] MUST: The package must be licensed with a Fedora approved license and meet the http://fedoraproject.org/wiki/Packaging/LicensingGuidelines.<BR> [ ] MUST: The License field in the package spec file must match the actual license. (refer to http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#ValidLicenseShortNames)<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>.(refer to http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License Text)<BR> [ ] MUST: The spec file must be written in American English. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#summary)<BR> [ ] MUST: The spec file for the package '''MUST''' be legible. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Spec_Legibility)<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 http://fedoraproject.org/wiki/Packaging/SourceURL for how to deal with this.<BR> [ ] MUST: The package '''MUST''' successfully compile and build into binary rpms on at least one primary architecture. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Support)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Architecture_Build_Failures)<BR> [ ] MUST: All build dependencies must be listed in <code>BuildRequires</code>, except for any that are listed in the http://fedoraproject.org/wiki/Packaging/Guidelines#Exceptions_2 section of the Packaging Guidelines ; inclusion of those as <code>BuildRequires</code> is optional. Apply common sense.<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.(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Handling_Locale_Files)<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>. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Shared_Libraries)<BR> [ ] MUST: Packages must NOT bundle copies of system libraries.(refer to http://fedoraproject.org/wiki/Packaging:Guidelines#Duplication_of_system_libraries)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#RelocatablePackages)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)<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)(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#DuplicateFiles)<BR> [ ] MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#FilePermissions)<BR> [ ] MUST: Each package must consistently use macros. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#macros)<BR> [ ] MUST: The package must contain code, or permissable content. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#CodeVsContent)<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). (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation)<BR> [ ] MUST: Header files must be in a -devel package. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)<BR> [ ] MUST: Static libraries must be in a -static package. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#DevelPackages)<BR> [ ] MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: <code>Requires: %{name}%{?_isa} = %{version}-%{release} </code> (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)<BR> [ ] MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#StaticLibraries)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#desktop)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#FileAndDirectoryOwnership)<BR> [ ] MUST: All filenames in rpm packages must be valid UTF-8. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#FilenameEncoding)<BR>
SHOULD requirements
[ ] 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. (refer to http://fedoraproject.org/wiki/Packaging/LicensingGuidelines#License_Text)<BR> [ ] SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#summary)<BR> [ ] SHOULD: The reviewer should test that the package builds in mock. (refer to http://fedoraproject.org/wiki/PackageMaintainers/MockTricks)<BR> [ ] SHOULD: The package should compile and build into binary rpms on all supported architectures. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#ArchitectureSupport)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Scriptlets)<BR> [ ] SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#RequiringBasePackage)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#PkgconfigFiles)<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. (refer to http://fedoraproject.org/wiki/Packaging/Guidelines#FileDeps)<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.(refer to http://fedoraproject.org/wiki/Packaging/Guidelines#Man_pages)<BR>