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.

Sign up for GitHub

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

Add links to subtopics to Spec page in manual #3510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
437b032
Downgrade headings of examples
ffesti Jan 8, 2025
c9d777d
Add table of contents to Spec page in manual
ffesti Jan 8, 2025
332a110
Drop Spec syntax related pages from index
ffesti Jan 13, 2025
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
8 changes: 4 additions & 4 deletions docs/manual/autosetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ options are

Some examples:

# Apply patches with number >= 100
### Apply patches with number >= 100
`%autopatch -m 100`
# Apply patches with number <= 400
### Apply patches with number <= 400
`%autopatch -M 400`
# Apply patches 80 to 99, inclusive
### Apply patches 80 to 99, inclusive
`%autopatch -m 80 -M 99`
# Apply patches 1, 4 and 6
### Apply patches 1, 4 and 6
`%autopatch 1 4 6`

## Automating patch (and source) declarations
Expand Down
16 changes: 0 additions & 16 deletions docs/manual/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,6 @@ title: rpm.org - RPM Reference Manual
## Package Building
* [Build Process](buildprocess.md)
* [Spec Syntax](spec.md)
* [Declarative builds](buildsystem.md)
* [Autosetup](autosetup.md)
* 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)
* Install scriptlets
* [Triggers](triggers.md)
* [File Triggers](file_triggers.md)
* [Scriptlet Expansion](scriptlet_expansion.md)
* [Users and Groups](users_and_groups.md)
* [Conditional Builds](conditionalbuilds.md)
* [Relocatable Packages](relocatable.md)
* [Dynamic Spec Generation](dynamic_specs.md)

## Developer Information
Expand Down
50 changes: 49 additions & 1 deletion docs/manual/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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>`
Expand Down