#1246 Remove duplicate tables of contents
Merged a year ago by tibbs. Opened a year ago by carlwgeorge.
carlwgeorge/packaging-committee no-double-toc  into  master

@@ -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.

@@ -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

@@ -1,6 +1,5 @@ 

  = Ansible Collection Packaging Guidelines

  :last-reviewed: 2022-09-25

- :toc:

  

  == Forward

  

@@ -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

@@ -1,7 +1,6 @@ 

  = Automatic Filtering of Provides and Requires

  

  :last-reviewed: 2019-04-04

- :toc:

  

  == Summary

  

@@ -1,5 +1,4 @@ 

  = Linear Algebra Libraries

- :toc:

  

  == Introduction

  

@@ -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]

@@ -1,5 +1,4 @@ 

  = Default Services

- :toc:

  

  == What is a Service?

  

@@ -1,6 +1,4 @@ 

  = Fonts

- :toc:

- :toclevels: 4

  

  == Foreword

  

@@ -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.

  

@@ -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.

@@ -1,6 +1,5 @@ 

  = Advanced uses cases

  :last-reviewed: 2019-06-19

- :toc:

  

  == Shipping additional files

  

@@ -1,6 +1,5 @@ 

  = Additional annotated templates

  :last-reviewed: 2019-03-22

- :toc:

  

  == Minimal source package

  

@@ -1,6 +1,5 @@ 

  = Java Packaging Guidelines

  :last-reviewed: 2022-07-01

- :toc:

  

  This page represents Fedora guidelines

  for packaging libraries and applications

@@ -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.

  

@@ -1,5 +1,4 @@ 

  = Packaging Guidelines for MinGW Cross Compilers

- :toc:

   

  == Introduction

  

@@ -1,5 +1,4 @@ 

  = Mono Packaging Guidelines

- :toc:

  

  == File Locations and Architectures

  

@@ -1,5 +1,4 @@ 

  = Naming Guidelines

- :toc:

  

  [NOTE]

  .Versioning guidelines have moved

@@ -1,5 +1,4 @@ 

  = PHP Packaging Guidelines

- :toc:

  

  Fedora Packaging Guidelines for PHP addon modules

  

@@ -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.

@@ -1,5 +1,4 @@ 

  = Perl Packaging Guidelines

- :toc:

  

  == License tag

  

@@ -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].

  

@@ -1,6 +1,5 @@ 

  = Python Packaging Guidelines

  :last-reviewed: 2021-06-04

- :toc:

  

  ////

  

@@ -1,6 +1,5 @@ 

  = Python Packaging Guidelines (201x-era)

  :last-reviewed: 2020-08-05

- :toc:

  

  [IMPORTANT]

  ====

@@ -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.

  

@@ -1,5 +1,4 @@ 

  = R Packaging Guidelines

- :toc:

  

  == What is R?

  

@@ -1,5 +1,4 @@ 

  = Ruby Packaging Guidelines

- :toc:

  

  NOTE: *JRuby Gems*:

  Although Fedora has fully functioning JRuby

@@ -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].

  

@@ -1,5 +1,4 @@ 

  = Scriptlets

- :toc:

  

  RPM spec files have several sections

  which allow packages to run code on installation and removal.

@@ -1,5 +1,4 @@ 

  = Fedora systemd Services

- :toc:

  

  This document describes the guidelines for systemd services,

  for use and inclusion in Fedora packages.

@@ -1,5 +1,4 @@ 

  = Tmpfiles.d

- :toc:

  

  == Overview

  

@@ -1,7 +1,6 @@ 

  include::{partialsdir}/versions.adoc[]

  

  = Versioning Guidelines

- :toc:

  

  Fedora's package versioning scheme

  encompasses both the `+Version:+`

@@ -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*.

  

@@ -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 @@ 

  Report issues with these guidelines, including typos,

  https://pagure.io/packaging-committee[here].

  

- toc::[]

- 

  == Applicability

  

  In general,

@@ -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.

  

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.

Pull-Request has been merged by tibbs

a year ago
Metadata
Changes Summary 35
+0 -1
file changed
guidelines/modules/ROOT/pages/Ada.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Alternatives.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Ansible_collections.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/AppData.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/AutoProvidesAndRequiresFiltering.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/BLAS_LAPACK.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/CMake.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/DefaultServices.adoc
+0 -2
file changed
guidelines/modules/ROOT/pages/FontsPolicy.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/GAP.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Golang.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Golang_advanced.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Golang_templates.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Java.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Meson.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/MinGW.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Mono.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Naming.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/PHP.adoc
+0 -2
file changed
guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Perl.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Pkcs11Support.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Python.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Python_201x.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Python_Appendix.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/R.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Ruby.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/SSLCertificateHandling.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Scriptlets.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Systemd.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Tmpfiles.d.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/Versioning.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/deprecating-packages.adoc
+0 -3
file changed
guidelines/modules/ROOT/pages/index.adoc
+0 -1
file changed
guidelines/modules/ROOT/pages/what-can-be-packaged.adoc