Packaging:ReviewGuidelines

This is an old copy of a packaging guideline, preserved here in the wiki while we complete the transition to the Fedora documentation system. The current version is located at https://docs.fedoraproject.org/en-US/packaging-guidelines/ReviewGuidelines/. Please update your bookmarks.

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 Fedora packaging list .

Package Review Process

Contributors and reviewers MUST follow the Package Review Process, with the following exceptions:

• FPC grants an explicit exemption from the process, as indicated here.
• The package is being created so that multiple versions of the same package can coexist in the distribution. The package MUST be properly named according to the naming guidelines and MUST NOT conflict with all other versions of the same package. If these requirements are not met, an exemption is required as above.

Things To Check On Review

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 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: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.
  
• MUST: The package must be named according to the Package Naming Guidelines .
  
• MUST: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption. .
  
• MUST: The package must meet the Packaging Guidelines .
  
• MUST: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines .
  
• MUST: The License field in the package spec file must match the actual license.
  
• 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 %license.
  
• MUST: The spec file must be written in American English.
  
• MUST: The spec file for the package MUST be legible.
  
• MUST: The sources used to build the package must match the upstream source, as provided in the spec URL. Reviewers should use sha256sum for this task as it is used by the sources file once imported into git. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.
  
• MUST: The package MUST successfully compile and build into binary rpms on at least one primary architecture.
  
• 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.
  
• 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.
  
• 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.
  
• MUST: Packages must NOT bundle copies of system libraries.
  
• 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.
  
• 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.
  
• 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)
  
• MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example.
  
• MUST: Each package must consistently use macros.
  
• MUST: The package must contain code, or permissible content.
  
• 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).
  
• 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.
  
• MUST: Static libraries must be in a -static package.
  
• MUST: Development files must be in a -devel package.
  
• MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name}%{?_isa} = %{version}-%{release}
  
• MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.
  
• 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.
  
• 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.
  
• MUST: All filenames in rpm packages must be valid UTF-8.
  
• MUST: Packages being added to the distribution MUST NOT depend on any packages which have been marked as being deprecated.
  

---

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.
  
• SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available.
  
• SHOULD: The reviewer should test that the package builds in mock.
  
• SHOULD: The package should compile and build into binary rpms on all supported architectures.
  
• 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.
  
• SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency.
  
• 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.
  
• 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.
  
• SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.
  

A note on dependencies

It is often useful to submit a package for review along with its dependencies in separate tickets. As long as the submitter sets up the Depends on: and Blocks: fields in bugzilla properly, this is not an issue, and it is perfectly possible to review these packages before the full dependency chain is in the distribution (by maintaining a local repository, building and installing the packages locally, or maintaining a Copr).

However, please keep in mind that you cannot do koji builds if all of the build dependencies are not met (because you cannot provide additional dependencies to koji) and when the time comes to build these packages, they must be built in order and you must wait between builds for the dependencies to make it into the appropriate branch of the distribution. For the devel branch (Rawhide) this happens frequently and can be automated using chain builds, but for release branches each package must make it all the way to stable before the next package in the chain can be built.

Please also note that while you may actually be able to build a package because all of its build-time dependencies are met, the package may still be non-installable (and thus useless) if its runtime dependencies are not met. A package MUST not be built if any of its runtime dependencies are unsatisfied.