From b583c8039760cc84f4b63f6e1392715cdd4ef047 Mon Sep 17 00:00:00 2001 From: Florian Festi Date: Wed, 8 Jan 2025 15:23:30 +0100 Subject: [PATCH] Add table of contents to Spec page in manual Include links to the sub topics there. Add links to Dependency sub topics to the Dependency section. Resolves: #3359 --- docs/manual/index.md | 2 +- docs/manual/spec.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/manual/index.md b/docs/manual/index.md index 0cba180498..2d793ecab8 100644 --- a/docs/manual/index.md +++ b/docs/manual/index.md @@ -21,8 +21,8 @@ title: rpm.org - RPM Reference Manual ## Package Building * [Build Process](buildprocess.md) * [Spec Syntax](spec.md) - * [Declarative builds](buildsystem.md) * [Autosetup](autosetup.md) + * [Declarative builds](buildsystem.md) * Dependencies * [Dependencies Basics](dependencies.md) * [More on Dependencies](more_dependencies.md) diff --git a/docs/manual/spec.md b/docs/manual/spec.md index 8be520c46c..4d56e643e6 100644 --- a/docs/manual/spec.md +++ b/docs/manual/spec.md @@ -4,6 +4,34 @@ title: rpm.org - Spec file format --- # Spec file format +Spec files describe how software is build and packaged. + +### Contents and Links + +* [Generic syntax](#generic-syntax) + * [→ Macro syntax](macros.md) + * [Comments](#comments) + * [Conditionals](#conditionals) + * [Sections](#sections) +* [Preamble](#preamble) + * [Dependencies](#dependencies) + * [→ Dependencies Basics](dependencies.md) + * [→ More on Dependencies](more_dependencies.md) + * [→ Boolean Dependencies](boolean_dependencies.md) + * [→ Architecture Dependencies](arch_dependencies.md) + * [→ Installation Order](tsort.md) + * [→ Automatic Dependency Generation](dependency_generators.md) + * [→ Declarative builds](buildsystem.md) +* [Sub-sections](#sub-sections) +* [Build scriptlets](#build-scriptlets) + * [→ Autosetup](autosetup.md) +* [Runtime scriptlets](#runtime-scriptlets) + * [→ Triggers](triggers.md) + * [→ File Triggers](file_triggers.md) + * [→ Scriptlet Expansion](scriptlet_expansion.md) +* [%files section](#files-section) +* [%changelog section](changelog-section) + ## Generic syntax ### Macros @@ -470,6 +498,14 @@ Used for creating sub-packages with conflicting files, such as different variants of the same content (eg minimal and full versions of the same software). +#### More Dependencies related Topics + * [Dependencies Basics](dependencies.md) + * [More on Dependencies](more_dependencies.md) + * [Boolean Dependencies](boolean_dependencies.md) + * [Architecture Dependencies](arch_dependencies.md) + * [Installation Order](tsort.md) + * [Automatic Dependency Generation](dependency_generators.md) + ### Sub-sections #### `%package [-n]`