Skip to content

Commit

Permalink
Add table of contents to Spec page in manual
Browse files Browse the repository at this point in the history
Include links to the sub topics there.
Add links to Dependency sub topics to the Dependency section.

Resolves: #3359
  • Loading branch information
ffesti committed Jan 13, 2025
1 parent 437b032 commit ea76ecc
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
41 changes: 40 additions & 1 deletion docs/manual/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,36 @@ 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)
* [→ Relocatable Packages](relocatable.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)
* [→ Users and Groups](users_and_groups.md)
* [%changelog section](changelog-section)

## Generic syntax

### Macros
Expand Down Expand Up @@ -453,7 +483,8 @@ unexpected results, in particular with `%global`.
#### Prefixes (or Prefix)

Specify prefixes this package may be installed into, used to make
packages relocatable. Very few packages are.
packages relocatable. Very few packages are. See [Relocatable Packages](relocatable.md) for details.


#### DocDir

Expand All @@ -470,6 +501,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]<name>`
Expand Down

0 comments on commit ea76ecc

Please sign in to comment.