From b33814e194ec267a20abe9a260a5dd92e63613c4 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Sep 29 2018 08:18:19 +0000 Subject: Enable Tables of Contents on pages that want them. --- diff --git a/guidelines/modules/ROOT/pages/Alternatives.adoc b/guidelines/modules/ROOT/pages/Alternatives.adoc index 7a8f899..4f38258 100644 --- a/guidelines/modules/ROOT/pages/Alternatives.adoc +++ b/guidelines/modules/ROOT/pages/Alternatives.adoc @@ -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+` diff --git a/guidelines/modules/ROOT/pages/AppData.adoc b/guidelines/modules/ROOT/pages/AppData.adoc index 5fac137..77d71e7 100644 --- a/guidelines/modules/ROOT/pages/AppData.adoc +++ b/guidelines/modules/ROOT/pages/AppData.adoc @@ -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]. diff --git a/guidelines/modules/ROOT/pages/DefaultServices.adoc b/guidelines/modules/ROOT/pages/DefaultServices.adoc index f925549..d69cf69 100644 --- a/guidelines/modules/ROOT/pages/DefaultServices.adoc +++ b/guidelines/modules/ROOT/pages/DefaultServices.adoc @@ -1,4 +1,4 @@ -__TOC__ +:toc: == What is a Service? diff --git a/guidelines/modules/ROOT/pages/Deprecating_Packages.adoc b/guidelines/modules/ROOT/pages/Deprecating_Packages.adoc index 001b14f..8fab5b6 100644 --- a/guidelines/modules/ROOT/pages/Deprecating_Packages.adoc +++ b/guidelines/modules/ROOT/pages/Deprecating_Packages.adoc @@ -1,4 +1,4 @@ -__TOC__ +: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*. diff --git a/guidelines/modules/ROOT/pages/GAP.adoc b/guidelines/modules/ROOT/pages/GAP.adoc index b7298c2..0fa3450 100644 --- a/guidelines/modules/ROOT/pages/GAP.adoc +++ b/guidelines/modules/ROOT/pages/GAP.adoc @@ -1,4 +1,4 @@ -__TOC__ +: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. diff --git a/guidelines/modules/ROOT/pages/Java.adoc b/guidelines/modules/ROOT/pages/Java.adoc index f3e80bb..13e687d 100644 --- a/guidelines/modules/ROOT/pages/Java.adoc +++ b/guidelines/modules/ROOT/pages/Java.adoc @@ -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. diff --git a/guidelines/modules/ROOT/pages/Meson.adoc b/guidelines/modules/ROOT/pages/Meson.adoc index 175ecf0..b3bc974 100644 --- a/guidelines/modules/ROOT/pages/Meson.adoc +++ b/guidelines/modules/ROOT/pages/Meson.adoc @@ -1,4 +1,4 @@ -__TOC__ +: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. diff --git a/guidelines/modules/ROOT/pages/Mono.adoc b/guidelines/modules/ROOT/pages/Mono.adoc index 04ddd39..38517ee 100644 --- a/guidelines/modules/ROOT/pages/Mono.adoc +++ b/guidelines/modules/ROOT/pages/Mono.adoc @@ -1,6 +1,5 @@ = Mono Packaging Guidelines - -__TOC__ +:toc: == File Locations and Architectures diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 6d9ed93..57c6e9b 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -1,4 +1,4 @@ -__TOC__ +:toc: == Versioning guidelines have moved diff --git a/guidelines/modules/ROOT/pages/PHP.adoc b/guidelines/modules/ROOT/pages/PHP.adoc index db807cc..d726f09 100644 --- a/guidelines/modules/ROOT/pages/PHP.adoc +++ b/guidelines/modules/ROOT/pages/PHP.adoc @@ -1,6 +1,5 @@ = PHP Packaging Guidelines - -__TOC__ +:toc: Fedora Packaging Guidelines for PHP addon modules diff --git a/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc b/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc index b20faec..251c0f8 100644 --- a/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc +++ b/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc @@ -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. diff --git a/guidelines/modules/ROOT/pages/Perl.adoc b/guidelines/modules/ROOT/pages/Perl.adoc index 004c78b..c91c966 100644 --- a/guidelines/modules/ROOT/pages/Perl.adoc +++ b/guidelines/modules/ROOT/pages/Perl.adoc @@ -1,6 +1,5 @@ = Perl Packaging Guidelines - -__TOC__ +:toc: == License tag diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index 22d36e2..eb56cec 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -1,6 +1,5 @@ = Python Packaging Guidelines - -__TOC__ +:toc: == Python Version Support diff --git a/guidelines/modules/ROOT/pages/Python_Eggs.adoc b/guidelines/modules/ROOT/pages/Python_Eggs.adoc index f6b9031..55fd9ca 100644 --- a/guidelines/modules/ROOT/pages/Python_Eggs.adoc +++ b/guidelines/modules/ROOT/pages/Python_Eggs.adoc @@ -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. diff --git a/guidelines/modules/ROOT/pages/R.adoc b/guidelines/modules/ROOT/pages/R.adoc index cd445f9..b2c2a6d 100644 --- a/guidelines/modules/ROOT/pages/R.adoc +++ b/guidelines/modules/ROOT/pages/R.adoc @@ -1,6 +1,5 @@ = R Packaging Guidelines - -__TOC__ +:toc: == What is R? diff --git a/guidelines/modules/ROOT/pages/Ruby.adoc b/guidelines/modules/ROOT/pages/Ruby.adoc index 1cc1c85..61e754d 100644 --- a/guidelines/modules/ROOT/pages/Ruby.adoc +++ b/guidelines/modules/ROOT/pages/Ruby.adoc @@ -1,6 +1,5 @@ = Ruby Packaging Guidelines - -__TOC__ +:toc: There are three basic categories of ruby packages: link:#RubyGems[ ruby gems], link:#Non-Gem_Packages[ non-gem ruby packages], and link:#ruby_applications[ applications written in ruby]. These guidelines contain sections common to all of these as well as sections which apply to each one individually. Be sure to read all the guidelines relevant to the type of ruby package you are building. diff --git a/guidelines/modules/ROOT/pages/Scriptlets.adoc b/guidelines/modules/ROOT/pages/Scriptlets.adoc index ad78ab1..16fbaf1 100644 --- a/guidelines/modules/ROOT/pages/Scriptlets.adoc +++ b/guidelines/modules/ROOT/pages/Scriptlets.adoc @@ -1,4 +1,4 @@ -__TOC__ +: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]. diff --git a/guidelines/modules/ROOT/pages/Versioning.adoc b/guidelines/modules/ROOT/pages/Versioning.adoc index 1ce6fcf..22a9f91 100644 --- a/guidelines/modules/ROOT/pages/Versioning.adoc +++ b/guidelines/modules/ROOT/pages/Versioning.adoc @@ -1,4 +1,4 @@ -__TOC__ +:toc: In Fedora, the package versioning scheme (which encompasses both the `+Version:+` and `+Release:+` tags, as well as `+Epoch:+`) balances two separate goals: diff --git a/guidelines/modules/ROOT/pages/What_Can_Be_Packaged.adoc b/guidelines/modules/ROOT/pages/What_Can_Be_Packaged.adoc index 9d9540d..c2d0737 100644 --- a/guidelines/modules/ROOT/pages/What_Can_Be_Packaged.adoc +++ b/guidelines/modules/ROOT/pages/What_Can_Be_Packaged.adoc @@ -1,4 +1,4 @@ -__TOC__ +: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.