Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to subtopics to Spec page in manual #3510

Merged
merged 3 commits into from
Jan 14, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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
ffesti authored and dmnks committed Jan 14, 2025
commit c9d777d3a1b9d779b3f2cb2bf2901192c6ff8a48
2 changes: 1 addition & 1 deletion docs/manual/index.md
Original file line number Diff line number Diff line change
@@ -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)
50 changes: 49 additions & 1 deletion docs/manual/spec.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,37 @@ 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)
* [→ Conditional Builds](conditionalbuilds.md)
* [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
@@ -82,6 +113,14 @@ other conditionals.
%if-conditionals are not macros, and are unlikely to yield expected results
if used in them.


### Conditional Builds ###

Conditionals can be made available for users building the package.
[Conditional Builds](conditionalbuilds.md) add `--with` and `--without`
command line options to `rpmbuild` that can be used inside the spec
file.

### Sections ###

The spec file is divided in several sections. Except of the preamble
@@ -453,7 +492,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

@@ -470,6 +510,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>`