From 6c9d9c08da1bc4018651a12e58312c95178a9023 Mon Sep 17 00:00:00 2001 From: Carl George Date: Feb 01 2023 03:57:45 +0000 Subject: Remove duplicate tables of contents The Fedora docs theme now defaults to placing a table of contents on the right hand side, so we don't need to set these attributes. --- diff --git a/guidelines/modules/ROOT/pages/Ada.adoc b/guidelines/modules/ROOT/pages/Ada.adoc index 94bfc82..30f69c5 100644 --- a/guidelines/modules/ROOT/pages/Ada.adoc +++ b/guidelines/modules/ROOT/pages/Ada.adoc @@ -1,7 +1,6 @@ = Ada Packaging Guidelines :last-reviewed: 2019-04-04 -:toc: This document describes the current policies for packaging Ada programs and libraries for Fedora. diff --git a/guidelines/modules/ROOT/pages/Alternatives.adoc b/guidelines/modules/ROOT/pages/Alternatives.adoc index 68fb0a1..a3aba3f 100644 --- a/guidelines/modules/ROOT/pages/Alternatives.adoc +++ b/guidelines/modules/ROOT/pages/Alternatives.adoc @@ -1,7 +1,6 @@ = Alternatives :last-reviewed: 2019-04-04 -:toc: Alternatives provide means for parallel installation of packages which provide the same functionality by maintaining sets of symlinks diff --git a/guidelines/modules/ROOT/pages/Ansible_collections.adoc b/guidelines/modules/ROOT/pages/Ansible_collections.adoc index 5053721..19158b3 100644 --- a/guidelines/modules/ROOT/pages/Ansible_collections.adoc +++ b/guidelines/modules/ROOT/pages/Ansible_collections.adoc @@ -1,6 +1,5 @@ = Ansible Collection Packaging Guidelines :last-reviewed: 2022-09-25 -:toc: == Forward diff --git a/guidelines/modules/ROOT/pages/AppData.adoc b/guidelines/modules/ROOT/pages/AppData.adoc index 8c2f15d..18da9d9 100644 --- a/guidelines/modules/ROOT/pages/AppData.adoc +++ b/guidelines/modules/ROOT/pages/AppData.adoc @@ -1,6 +1,5 @@ = Packaging Guidelines for AppData Files :last-reviewed: 2021-01-18 -:toc: If a package contains a GUI application, then it SHOULD install a `+.metainfo.xml+` file diff --git a/guidelines/modules/ROOT/pages/AutoProvidesAndRequiresFiltering.adoc b/guidelines/modules/ROOT/pages/AutoProvidesAndRequiresFiltering.adoc index ff83d88..f054df8 100644 --- a/guidelines/modules/ROOT/pages/AutoProvidesAndRequiresFiltering.adoc +++ b/guidelines/modules/ROOT/pages/AutoProvidesAndRequiresFiltering.adoc @@ -1,7 +1,6 @@ = Automatic Filtering of Provides and Requires :last-reviewed: 2019-04-04 -:toc: == Summary diff --git a/guidelines/modules/ROOT/pages/BLAS_LAPACK.adoc b/guidelines/modules/ROOT/pages/BLAS_LAPACK.adoc index 5638522..3ea9c28 100644 --- a/guidelines/modules/ROOT/pages/BLAS_LAPACK.adoc +++ b/guidelines/modules/ROOT/pages/BLAS_LAPACK.adoc @@ -1,5 +1,4 @@ = Linear Algebra Libraries -:toc: == Introduction diff --git a/guidelines/modules/ROOT/pages/CMake.adoc b/guidelines/modules/ROOT/pages/CMake.adoc index 2e45a5e..b2c0602 100644 --- a/guidelines/modules/ROOT/pages/CMake.adoc +++ b/guidelines/modules/ROOT/pages/CMake.adoc @@ -1,7 +1,6 @@ :last-reviewed: 2020-07-18 = CMake Packaging Guidelines -:toc: This document provides best practices for the usage of https://cmake.org/[the CMake build system] diff --git a/guidelines/modules/ROOT/pages/DefaultServices.adoc b/guidelines/modules/ROOT/pages/DefaultServices.adoc index 46e4302..eab7c6a 100644 --- a/guidelines/modules/ROOT/pages/DefaultServices.adoc +++ b/guidelines/modules/ROOT/pages/DefaultServices.adoc @@ -1,5 +1,4 @@ = Default Services -:toc: == What is a Service? diff --git a/guidelines/modules/ROOT/pages/FontsPolicy.adoc b/guidelines/modules/ROOT/pages/FontsPolicy.adoc index 77a406c..f037bbe 100644 --- a/guidelines/modules/ROOT/pages/FontsPolicy.adoc +++ b/guidelines/modules/ROOT/pages/FontsPolicy.adoc @@ -1,6 +1,4 @@ = Fonts -:toc: -:toclevels: 4 == Foreword diff --git a/guidelines/modules/ROOT/pages/GAP.adoc b/guidelines/modules/ROOT/pages/GAP.adoc index 90feeed..a135953 100644 --- a/guidelines/modules/ROOT/pages/GAP.adoc +++ b/guidelines/modules/ROOT/pages/GAP.adoc @@ -1,5 +1,4 @@ = GAP Packaging Guidelines -:toc: This document describes the conventions and customs surrounding the proper packaging of https://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/Golang.adoc b/guidelines/modules/ROOT/pages/Golang.adoc index f6b8954..bf4b870 100644 --- a/guidelines/modules/ROOT/pages/Golang.adoc +++ b/guidelines/modules/ROOT/pages/Golang.adoc @@ -1,6 +1,5 @@ = Golang Packaging Guidelines :last-reviewed: 2019-06-19 -:toc: This document details best practices for packaging Golang packages. Most of it is automated by an extensive use of macros. diff --git a/guidelines/modules/ROOT/pages/Golang_advanced.adoc b/guidelines/modules/ROOT/pages/Golang_advanced.adoc index 1052334..0ce8c79 100644 --- a/guidelines/modules/ROOT/pages/Golang_advanced.adoc +++ b/guidelines/modules/ROOT/pages/Golang_advanced.adoc @@ -1,6 +1,5 @@ = Advanced uses cases :last-reviewed: 2019-06-19 -:toc: == Shipping additional files diff --git a/guidelines/modules/ROOT/pages/Golang_templates.adoc b/guidelines/modules/ROOT/pages/Golang_templates.adoc index 157bff7..7f1a017 100644 --- a/guidelines/modules/ROOT/pages/Golang_templates.adoc +++ b/guidelines/modules/ROOT/pages/Golang_templates.adoc @@ -1,6 +1,5 @@ = Additional annotated templates :last-reviewed: 2019-03-22 -:toc: == Minimal source package diff --git a/guidelines/modules/ROOT/pages/Java.adoc b/guidelines/modules/ROOT/pages/Java.adoc index ceec760..4f7ffa4 100644 --- a/guidelines/modules/ROOT/pages/Java.adoc +++ b/guidelines/modules/ROOT/pages/Java.adoc @@ -1,6 +1,5 @@ = Java Packaging Guidelines :last-reviewed: 2022-07-01 -:toc: This page represents Fedora guidelines for packaging libraries and applications diff --git a/guidelines/modules/ROOT/pages/Meson.adoc b/guidelines/modules/ROOT/pages/Meson.adoc index 967f04c..1db13df 100644 --- a/guidelines/modules/ROOT/pages/Meson.adoc +++ b/guidelines/modules/ROOT/pages/Meson.adoc @@ -1,5 +1,4 @@ = Meson Packaging Guidelines -:toc: This document provides best practices for the usage of https://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/MinGW.adoc b/guidelines/modules/ROOT/pages/MinGW.adoc index 65353e0..cc5fbb3 100644 --- a/guidelines/modules/ROOT/pages/MinGW.adoc +++ b/guidelines/modules/ROOT/pages/MinGW.adoc @@ -1,5 +1,4 @@ = Packaging Guidelines for MinGW Cross Compilers -:toc: == Introduction diff --git a/guidelines/modules/ROOT/pages/Mono.adoc b/guidelines/modules/ROOT/pages/Mono.adoc index 6bb61e4..454f402 100644 --- a/guidelines/modules/ROOT/pages/Mono.adoc +++ b/guidelines/modules/ROOT/pages/Mono.adoc @@ -1,5 +1,4 @@ = Mono Packaging Guidelines -:toc: == File Locations and Architectures diff --git a/guidelines/modules/ROOT/pages/Naming.adoc b/guidelines/modules/ROOT/pages/Naming.adoc index 5d4f59c..7ff5ec1 100644 --- a/guidelines/modules/ROOT/pages/Naming.adoc +++ b/guidelines/modules/ROOT/pages/Naming.adoc @@ -1,5 +1,4 @@ = Naming Guidelines -:toc: [NOTE] .Versioning guidelines have moved diff --git a/guidelines/modules/ROOT/pages/PHP.adoc b/guidelines/modules/ROOT/pages/PHP.adoc index c8f4ba5..899cc04 100644 --- a/guidelines/modules/ROOT/pages/PHP.adoc +++ b/guidelines/modules/ROOT/pages/PHP.adoc @@ -1,5 +1,4 @@ = PHP Packaging Guidelines -: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 6786ff7..6b94199 100644 --- a/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc +++ b/guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc @@ -1,5 +1,3 @@ -: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. We want to ensure that all packages have sensible defaults for whichever Product on which they are installed, while also avoiding situations where users would have some packages installed with one Product's defaults and some packages with another. diff --git a/guidelines/modules/ROOT/pages/Perl.adoc b/guidelines/modules/ROOT/pages/Perl.adoc index 785fc4d..e782c76 100644 --- a/guidelines/modules/ROOT/pages/Perl.adoc +++ b/guidelines/modules/ROOT/pages/Perl.adoc @@ -1,5 +1,4 @@ = Perl Packaging Guidelines -:toc: == License tag diff --git a/guidelines/modules/ROOT/pages/Pkcs11Support.adoc b/guidelines/modules/ROOT/pages/Pkcs11Support.adoc index 687fba8..a7022ae 100644 --- a/guidelines/modules/ROOT/pages/Pkcs11Support.adoc +++ b/guidelines/modules/ROOT/pages/Pkcs11Support.adoc @@ -1,5 +1,4 @@ = PKCS#11 / Smart-Card Support Guidelines -:toc: These guidelines are relevant to maintainers of packages with smart cards drivers (PKCS#11 modules), or smart card related tooling. Its purpose is to bring a consistency in smart card handling on the OS; for background and motivation see the https://fedoraproject.org/wiki/User:Nmav/Pkcs11Status[current status of PKCS#11 in Fedora]. diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index f4e117e..7ec93ce 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -1,6 +1,5 @@ = Python Packaging Guidelines :last-reviewed: 2021-06-04 -:toc: //// diff --git a/guidelines/modules/ROOT/pages/Python_201x.adoc b/guidelines/modules/ROOT/pages/Python_201x.adoc index 88b6c12..65b9e41 100644 --- a/guidelines/modules/ROOT/pages/Python_201x.adoc +++ b/guidelines/modules/ROOT/pages/Python_201x.adoc @@ -1,6 +1,5 @@ = Python Packaging Guidelines (201x-era) :last-reviewed: 2020-08-05 -:toc: [IMPORTANT] ==== diff --git a/guidelines/modules/ROOT/pages/Python_Appendix.adoc b/guidelines/modules/ROOT/pages/Python_Appendix.adoc index bd686f0..c2a5895 100644 --- a/guidelines/modules/ROOT/pages/Python_Appendix.adoc +++ b/guidelines/modules/ROOT/pages/Python_Appendix.adoc @@ -1,6 +1,5 @@ = Additional Python Guidelines :last-reviewed: 2020-01-01 -:toc: Here are some additional Python-related guidelines, moved here in order to keep the main page manageable. diff --git a/guidelines/modules/ROOT/pages/R.adoc b/guidelines/modules/ROOT/pages/R.adoc index 9f662a8..2b470b2 100644 --- a/guidelines/modules/ROOT/pages/R.adoc +++ b/guidelines/modules/ROOT/pages/R.adoc @@ -1,5 +1,4 @@ = R Packaging Guidelines -:toc: == What is R? diff --git a/guidelines/modules/ROOT/pages/Ruby.adoc b/guidelines/modules/ROOT/pages/Ruby.adoc index 86757d9..4d15aa1 100644 --- a/guidelines/modules/ROOT/pages/Ruby.adoc +++ b/guidelines/modules/ROOT/pages/Ruby.adoc @@ -1,5 +1,4 @@ = Ruby Packaging Guidelines -:toc: NOTE: *JRuby Gems*: Although Fedora has fully functioning JRuby diff --git a/guidelines/modules/ROOT/pages/SSLCertificateHandling.adoc b/guidelines/modules/ROOT/pages/SSLCertificateHandling.adoc index 1fb8d3e..c73badc 100644 --- a/guidelines/modules/ROOT/pages/SSLCertificateHandling.adoc +++ b/guidelines/modules/ROOT/pages/SSLCertificateHandling.adoc @@ -1,5 +1,4 @@ = Certificate Handling Guidelines -:toc: These guidelines are relevant to maintainers of packages which utilize smart cards for loading certificate or private key. Its purpose is to bring a consistency in smart card handling on the OS; for background and motivation see the link:https://fedoraproject.org/wiki/User:Nmav/Pkcs11Status[current status of PKCS#11 in Fedora]. diff --git a/guidelines/modules/ROOT/pages/Scriptlets.adoc b/guidelines/modules/ROOT/pages/Scriptlets.adoc index 61c906d..cac2ccd 100644 --- a/guidelines/modules/ROOT/pages/Scriptlets.adoc +++ b/guidelines/modules/ROOT/pages/Scriptlets.adoc @@ -1,5 +1,4 @@ = Scriptlets -:toc: RPM spec files have several sections which allow packages to run code on installation and removal. diff --git a/guidelines/modules/ROOT/pages/Systemd.adoc b/guidelines/modules/ROOT/pages/Systemd.adoc index 4a699dd..ae7bfd9 100644 --- a/guidelines/modules/ROOT/pages/Systemd.adoc +++ b/guidelines/modules/ROOT/pages/Systemd.adoc @@ -1,5 +1,4 @@ = Fedora systemd Services -:toc: This document describes the guidelines for systemd services, for use and inclusion in Fedora packages. diff --git a/guidelines/modules/ROOT/pages/Tmpfiles.d.adoc b/guidelines/modules/ROOT/pages/Tmpfiles.d.adoc index eff8777..d915937 100644 --- a/guidelines/modules/ROOT/pages/Tmpfiles.d.adoc +++ b/guidelines/modules/ROOT/pages/Tmpfiles.d.adoc @@ -1,5 +1,4 @@ = Tmpfiles.d -:toc: == Overview diff --git a/guidelines/modules/ROOT/pages/Versioning.adoc b/guidelines/modules/ROOT/pages/Versioning.adoc index fcddde8..6eaa069 100644 --- a/guidelines/modules/ROOT/pages/Versioning.adoc +++ b/guidelines/modules/ROOT/pages/Versioning.adoc @@ -1,7 +1,6 @@ include::{partialsdir}/versions.adoc[] = Versioning Guidelines -:toc: Fedora's package versioning scheme encompasses both the `+Version:+` diff --git a/guidelines/modules/ROOT/pages/deprecating-packages.adoc b/guidelines/modules/ROOT/pages/deprecating-packages.adoc index 804b66a..3dbb9ea 100644 --- a/guidelines/modules/ROOT/pages/deprecating-packages.adoc +++ b/guidelines/modules/ROOT/pages/deprecating-packages.adoc @@ -1,5 +1,4 @@ = Deprecating Packages -:toc: Sometimes a package is intended to be https://docs.fedoraproject.org/en-US/package-maintainers/Package_Retirement_Process/[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/index.adoc b/guidelines/modules/ROOT/pages/index.adoc index 8b3b609..0ae108c 100644 --- a/guidelines/modules/ROOT/pages/index.adoc +++ b/guidelines/modules/ROOT/pages/index.adoc @@ -3,7 +3,6 @@ :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://docs.fedoraproject.org/en-US/fesco/Updates_Policy/[Updates Policy] -:toc: macro The Packaging Guidelines are a collection of common issues and the severity that should be placed on them. @@ -44,8 +43,6 @@ by many members of the Packaging Committee. Report issues with these guidelines, including typos, https://pagure.io/packaging-committee[here]. -toc::[] - == Applicability In general, diff --git a/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc b/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc index 0a7be23..38cca68 100644 --- a/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc +++ b/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc @@ -2,7 +2,6 @@ :packaging-committee: https://fedoraproject.org/wiki/Packaging_Committee[Packaging Committee] :legal-team: https://fedoraproject.org/wiki/Legal:Main[Legal Team] :kernel-team: https://fedoraproject.org/wiki/Kernel[Kernel Team] -: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 {packaging-committee} and the {legal-team} are the primary places to receive answers.