enable Tables of Contents on pages that want them

Merges: https://pagure.io/packaging-committee/pull-request/804
This commit is contained in:
Elliott Sales de Andrade 2018-10-05 17:45:05 +02:00 committed by Igor Gnatenko
commit 60ba24ee23
20 changed files with 27 additions and 24 deletions

View file

@ -1,4 +1,4 @@
__TOC__
:toc:
Alternatives provide means for parallel installation of packages which provide the same functionality by maintaining sets of symlinks (one per package) pointing to alternativized files like this:
`+/path/original-file -> /etc/alternatives/packagename-original-file -> /path/original-file.suffix+`

View file

@ -1,4 +1,4 @@
__TOC__
:toc:
If a package contains a GUI application, then it SHOULD also install a `+.appdata.xml+` file into `+%{_metainfodir}+`. Installed `+.appdata.xml+` files MUST follow the http://people.freedesktop.org/~hughsient/appdata/[AppData specification page].

View file

@ -1,4 +1,4 @@
__TOC__
:toc:
== What is a Service?

View file

@ -1,4 +1,5 @@
__TOC__
= GAP Packaging Guidelines
:toc:
This document describes the conventions and customs surrounding the proper packaging of http://gap-system.org/[GAP] add-on packages in Fedora. Throughout this document, we use the word _add-on_ to substitute for GAP upstream's use of the word _package_, to avoid confusion with RPM packages.

View file

@ -1,6 +1,5 @@
= Java Packaging Guidelines
__TOC__
:toc:
This page represents Fedora guidelines for packaging libraries and applications written in Java and related languages using Java Virtual Machine as bytecode interpreter. It does not aim to extensively describe packaging techniques and tips. RPM macros and commands used here are documented in man pages. Furthermore a separate https://fedora-java.github.io/howto/latest/[Java Packaging HOWTO] describes Java packaging techniques in detail and includes examples, templates and documentation aimed at packagers and Java developers who are taking their first steps in Java RPM packaging.

View file

@ -1,4 +1,5 @@
__TOC__
= Meson Packaging Guidelines
:toc:
This document provides best practices for the usage of http://mesonbuild.com/[the Meson build system] in Fedora packages. Meson is a build system (similar to automake) which can generate code for other lower-level build systems. For example, it can generate code for https://ninja-build.org/[ninja]. When packaging software which builds using Meson it's important to use the `+%meson+` macros instead of `+%ninja+` or other lower-level build system macros directly. The backend used by Meson could change.

View file

@ -1,6 +1,5 @@
= Mono Packaging Guidelines
__TOC__
:toc:
== File Locations and Architectures

View file

@ -1,4 +1,5 @@
__TOC__
= Naming Guidelines
:toc:
== Versioning guidelines have moved

View file

@ -1,6 +1,5 @@
= PHP Packaging Guidelines
__TOC__
:toc:
Fedora Packaging Guidelines for PHP addon modules

View file

@ -1,4 +1,4 @@
__TOC__
:toc:
In the Fedora.next world, we have a set of curated Fedora Products as well as the availability of classic Fedora. Historically, we have maintained a single set of configuration defaults for all Fedora installs, but different target use-cases have different needs. The goal of this document is to set out the guidelines for creating per-Product configuration defaults.

View file

@ -1,6 +1,5 @@
= Perl Packaging Guidelines
__TOC__
:toc:
== License tag

View file

@ -1,4 +1,5 @@
= Python Packaging Guidelines
:toc:
== Python Version Support

View file

@ -1,4 +1,4 @@
__TOC__
:toc:
Python packages provide extra metadata about the package in the form of egg metadata. This document explains how to package those metadata.

View file

@ -1,6 +1,5 @@
= R Packaging Guidelines
__TOC__
:toc:
== What is R?

View file

@ -1,4 +1,5 @@
= Ruby Packaging Guidelines
:toc:
NOTE: *JRuby Gems*: Although Fedora has fully functioning JRuby integrated with system RubyGems, we have decided to not include the JRuby specific packaging guidelines here, as they need some more work. They will appear here as soon as we feel that we've got everything covered properly. You can contact us on https://lists.fedoraproject.org/archives/list/ruby-sig@lists.fedoraproject.org/[Ruby-SIG mailing list] in case of any questions about the prepared JRuby packaging guidelines.

View file

@ -1,4 +1,5 @@
__TOC__
= Scriptlets
:toc:
RPM spec files have several sections which allow packages to run code on installation and removal. These bits of code are called scriptlets and are mostly used to update the running system with information from the package. This page offers a quick overview of RPM scriptlets and a number of common recipes for scriptlets in packages. For a more complete treatment of scriptlets, please see the http://www.rpm.org/max-rpm-snapshot/[Maximum RPM book].

View file

@ -1,4 +1,5 @@
__TOC__
= Versioning Guidelines
:toc:
In Fedora, the package versioning scheme (which encompasses both the `+Version:+` and `+Release:+` tags, as well as `+Epoch:+`) balances two separate goals:

View file

@ -1,4 +1,5 @@
__TOC__
= What can be packaged
:toc:
Not everything can be packaged in Fedora. Most things considered to be "free software" or "open source software" are permitted, but definitions of these are not always consistent and Fedora has a few specific requirements and exceptions. This is an overview of some specific requirements and exceptions, but it is not intended to be exhaustive. If questions arise, the link:Packaging_Committee[Packaging Committee] and the Legal:Main[Legal Team] are the primary places to receive answers.

View file

@ -1,4 +1,5 @@
__TOC__
= Deprecating Packages
:toc:
Sometimes a package is intended to be link:How_to_remove_a_package_at_end_of_life[removed from Fedora], but it is kept in Fedora for some additional (often indeterminate) time for various reasons including maintaining backwards compatibility. In order to prevent new packages from depending on such a package, it can be marked as *deprecated*.

View file

@ -1,11 +1,10 @@
= Fedora Packaging Guidelines
:abi-comparison-tool: https://fedoraproject.org/wiki/How_to_check_for_ABI_changes_in_a_package[ABI comparison tool]
:packaging-committee: https://pagure.io/packaging-committee[Fedora Packaging Committee]
:scl-guidelines: https://fedoraproject.org/wiki/User:Toshio/SCL_Guidelines_(draft)[Software Collections]
:updates-policy: https://fedoraproject.org/wiki/Updates_Policy[Updates Policy]
:toc: macro
= Fedora Packaging Guidelines
The Packaging Guidelines are a collection of common issues and the severity that should be placed on them. While these guidelines should not be ignored, they should also not be blindly followed. If you think that your package should be exempt from part of the Guidelines, please bring the issue to the {packaging-committee}.
It is the package reviewer's responsibility to point out specific problems with a package and a packager's responsibility to deal with those issues. The reviewer and packager work together to determine the severity of the issues (whether they block a package or can be worked on after the package is in the repository.) Please remember that any package that you submit must also conform to the xref:ReviewGuidelines.adoc[Review Guidelines].