Skip to content

Commit db81144

Browse files
committed
tree-wide: BLS and DPS are now on uapi-group website
1 parent 244c2a8 commit db81144

28 files changed

+88
-85
lines changed

docs/AUTOMATIC_BOOT_ASSESSMENT.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
99

1010
systemd provides support for automatically reverting back to the previous
1111
version of the OS or kernel in case the system consistently fails to boot. The
12-
[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting)
12+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting)
1313
describes how to annotate boot loader entries with a counter that specifies how
1414
many attempts should be made to boot it. This document describes how systemd
1515
implements this scheme.
@@ -28,7 +28,7 @@ Here's a brief overview of the complete set of components:
2828
* The
2929
[`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)
3030
boot loader optionally maintains a per-boot-loader-entry counter described by
31-
the [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting)
31+
the [Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting)
3232
that is decreased by one on each attempt to boot the entry, prioritizing
3333
entries that have non-zero counters over those which already reached a
3434
counter of zero when choosing the entry to boot.
@@ -60,7 +60,8 @@ Here's a brief overview of the complete set of components:
6060

6161
## Details
6262

63-
As described in [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting),
63+
As described in the
64+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting),
6465
the boot counting data is stored in the file name of the boot loader entries as
6566
a plus (`+`), followed by a number, optionally followed by `-` and another
6667
number, right before the file name suffix (`.conf` or `.efi`).

docs/BOOT_LOADER_INTERFACE.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,11 @@ the identifiers as passed in `LoaderEntries`, `LoaderEntryDefault`,
119119
`LoaderEntryOneShot`, `LoaderEntrySelected`, and possibly show nicely localized
120120
names for them in UIs.
121121

122-
1. When boot loader entries are defined through
123-
[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md) drop-in files
124-
the identifier should be derived directly from the drop-in snippet name, but
125-
with the `.conf` (or `.efi` in case of Type #2 entries) suffix removed.
122+
1. When boot loader entries are defined through the
123+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/)
124+
drop-in files the identifier should be derived directly from the drop-in
125+
snippet name, but with the `.conf` (or `.efi` in case of Type #2 entries)
126+
suffix removed.
126127

127128
2. Entries automatically discovered by the boot loader (as opposed to being
128129
configured in configuration files) should generally have an identifier
@@ -150,8 +151,8 @@ names for them in UIs.
150151

151152
## Links
152153

153-
[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md)<br>
154-
[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md)<br>
154+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)<br>
155+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)<br>
155156
[`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)<br>
156157
[`bootctl(1)`](https://www.freedesktop.org/software/systemd/man/bootctl.html)<br>
157158
[`systemd-gpt-auto-generator(8)`](https://www.freedesktop.org/software/systemd/man/systemd-gpt-auto-generator.html)

docs/BUILDING_IMAGES.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,14 @@ boot. For that it's essential to:
6767
The
6868
[`kernel-install(8)`](https://www.freedesktop.org/software/systemd/man/kernel-install.html)
6969
logic used to generate
70-
[Boot Loader Specification Type 1](BOOT_LOADER_SPECIFICATION.md) entries by
71-
default uses the machine ID as stored in `/etc/machine-id` for naming boot menu
72-
entries and the directories in the ESP to place kernel images in. This is done
73-
in order to allow multiple installations of the same OS on the same system
74-
without conflicts. However, this is problematic if the machine ID shall be
75-
generated automatically on first boot: if the ID is not known before the first
76-
boot it cannot be used to name the most basic resources required for the boot
77-
process to complete.
70+
[Boot Loader Specification Type #1](https://uapi-group.org/specifications/specs/boot_loader_specification/#type-1-boot-loader-specification-entries)
71+
entries by default uses the machine ID as stored in `/etc/machine-id` for
72+
naming boot menu entries and the directories in the ESP to place kernel images
73+
in. This is done in order to allow multiple installations of the same OS on the
74+
same system without conflicts. However, this is problematic if the machine ID
75+
shall be generated automatically on first boot: if the ID is not known before
76+
the first boot it cannot be used to name the most basic resources required for
77+
the boot process to complete.
7878

7979
Thus, for images that shall acquire their identity on first boot only, it is
8080
required to use a different identifier for naming boot menu entries. To allow
@@ -203,8 +203,8 @@ it, then format it.
203203
in. The `x-systemd.growfs` mount option in `/etc/fstab` is sufficient to
204204
enable this logic for specific mounts. Alternatively appropriately set up
205205
partitions can set GPT partition flag 59 to request this behaviour, see the
206-
[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md) for
207-
details. If the file system is already grown it executes no operation.
206+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)
207+
for details. If the file system is already grown it executes no operation.
208208

209209
3. Similar, the `systemd-makefs@.service` and `systemd-makeswap@.service`
210210
services can format file systems and swap spaces before first use, if they
@@ -267,8 +267,8 @@ fields.
267267
[`machine-id(5)`](https://www.freedesktop.org/software/systemd/man/machine-id.html)<br>
268268
[`systemd-random-seed(8)`](https://www.freedesktop.org/software/systemd/man/systemd-random-seed.service.html)<br>
269269
[`os-release(5)`](https://www.freedesktop.org/software/systemd/man/os-release.html)<br>
270-
[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md)<br>
271-
[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md)<br>
270+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)<br>
271+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)<br>
272272
[`mkosi`](https://github.com/systemd/mkosi)<br>
273273
[`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)<br>
274274
[`systemd-repart(8)`](https://www.freedesktop.org/software/systemd/man/systemd-repart.service.html)<br>

docs/ENVIRONMENT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,12 @@ All tools:
188188
file may be checked for by services run during system shutdown in order to
189189
request the appropriate operation from the boot loader in an alternative
190190
fashion. Note that by default only boot loader entries which follow the
191-
[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md) and are
192-
placed in the ESP or the Extended Boot Loader partition may be selected this
193-
way. However, if a directory `/run/boot-loader-entries/` exists, the entries
194-
are loaded from there instead. The directory should contain the usual
195-
directory hierarchy mandated by the Boot Loader Specification, i.e. the entry
196-
drop-ins should be placed in
191+
[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)
192+
and are placed in the ESP or the Extended Boot Loader partition may be
193+
selected this way. However, if a directory `/run/boot-loader-entries/`
194+
exists, the entries are loaded from there instead. The directory should
195+
contain the usual directory hierarchy mandated by the Boot Loader
196+
Specification, i.e. the entry drop-ins should be placed in
197197
`/run/boot-loader-entries/loader/entries/*.conf`, and the files referenced by
198198
the drop-ins (including the kernels and initrds) somewhere else below
199199
`/run/boot-loader-entries/`. Note that all these files may be (and are
@@ -384,7 +384,7 @@ disk images with `--image=` or similar:
384384
to load the embedded Verity signature data. If enabled (which is the
385385
default), Verity root hash information and a suitable signature is
386386
automatically acquired from a signature partition, following the
387-
[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md).
387+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification).
388388
If disabled any such partition is ignored. Note that this only disables
389389
discovery of the root hash and its signature, the Verity data partition
390390
itself is still searched in the GPT image.

docs/PORTABLE_SERVICES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ requirements are made for an image that can be attached/detached with
169169
an image with a partition table understood by the Linux kernel with only a
170170
single partition defined, or alternatively, a GPT partition table with a set
171171
of properly marked partitions following the
172-
[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md).
172+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification).
173173

174174
3. The image must at least contain one matching unit file, with the right name
175175
prefix and suffix (see above). The unit file is searched in the usual paths,

docs/PORTING_TO_NEW_ARCHITECTURES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ architecture.
2727
partitions. Use `systemd-id128 new -p` to generate new suitable UUIDs you
2828
can use for this. Make sure to register your new types in the various
2929
functions in `gpt.c`. Also make sure to update the tables in
30-
`docs/DISCOVERABLE_PARTITIONS.md` and `man/systemd-gpt-auto-generator.xml`
31-
accordingly.
30+
[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)
31+
and `man/systemd-gpt-auto-generator.xml` accordingly.
3232

3333
3. If your architecture supports UEFI, make sure to update the `efi_arch`
3434
variable logic in `meson.build` to be set to the right architecture string

man/bootctl.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
<title>Boot Loader Specification Commands</title>
8787

8888
<para>These commands are available for all boot loaders that implement the <ulink
89-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> and/or the <ulink
89+
url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> and/or the <ulink
9090
url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, such as
9191
<command>systemd-boot</command>.</para>
9292

@@ -95,7 +95,7 @@
9595
<term><option>list</option></term>
9696

9797
<listitem><para>Shows all available boot loader entries implementing the <ulink
98-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>, as well as any
98+
url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>, as well as any
9999
other entries discovered or automatically generated by a boot loader implementing the <ulink
100100
url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>.
101101
JSON output may be requested with <option>--json=</option>.</para>
@@ -120,7 +120,7 @@
120120
entry for all future boots, the current default boot loader entry for the next boot, and the currently booted
121121
boot loader entry. These special IDs are resolved to the current values of the EFI variables
122122
<varname>LoaderEntryDefault</varname>, <varname>LoaderEntryOneShot</varname> and <varname>LoaderEntrySelected</varname>,
123-
see <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> for details.
123+
see <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> for details.
124124
These special IDs are primarily useful as a quick way to persistently make the currently booted boot loader
125125
entry the default choice, or to upgrade the default boot loader entry for the next boot to the default boot
126126
loader entry for all future boots, but may be used for other operations too.</para>
@@ -232,7 +232,7 @@
232232
<varlistentry>
233233
<term><option>--boot-path=</option></term>
234234
<listitem><para>Path to the Extended Boot Loader partition, as defined in the <ulink
235-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>. If not
235+
url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>. If not
236236
specified, <filename>/boot/</filename> is checked. It is recommended to mount the Extended Boot
237237
Loader partition to <filename>/boot/</filename>, if possible.</para></listitem>
238238
</varlistentry>
@@ -252,7 +252,7 @@
252252
are applied to file system in the indicated disk image. This option is similar to
253253
<option>--root=</option>, but operates on file systems stored in disk images or block devices. The
254254
disk image should either contain just a file system or a set of file systems within a GPT partition
255-
table, following the <ulink url="https://systemd.io/DISCOVERABLE_PARTITIONS">Discoverable Partitions
255+
table, following the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
256256
Specification</ulink>. For further information on supported disk images, see
257257
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
258258
switch of the same name.</para></listitem>
@@ -318,7 +318,7 @@
318318
<varlistentry>
319319
<term><option>--make-entry-directory=yes|no</option></term>
320320
<listitem><para>Controls creation and deletion of the <ulink
321-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> Type #1 entry
321+
url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> Type #1 entry
322322
directory on the file system containing resources such as kernel and initrd images during
323323
<option>install</option> and <option>remove</option>, respectively. The directory is named after the
324324
entry token, as specified with <option>--entry-token=</option> parameter described below, and is
@@ -529,7 +529,7 @@ Boot Loader Entries:
529529
<title>See Also</title>
530530
<para>
531531
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
532-
<ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>,
532+
<ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>,
533533
<ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>,
534534
<citerefentry><refentrytitle>systemd-boot-system-token.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
535535
</para>

man/coredumpctl.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@
262262
are applied to file system in the indicated disk image. This option is similar to
263263
<option>--root=</option>, but operates on file systems stored in disk images or block devices. The
264264
disk image should either contain just a file system or a set of file systems within a GPT partition
265-
table, following the <ulink url="https://systemd.io/DISCOVERABLE_PARTITIONS">Discoverable Partitions
265+
table, following the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
266266
Specification</ulink>. For further information on supported disk images, see
267267
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
268268
switch of the same name.</para></listitem>

man/journalctl.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
option is similar to <option>--root=</option>, but operates on file systems stored in disk images or
169169
block devices, thus providing an easy way to extract log data from disk images. The disk image should
170170
either contain just a file system or a set of file systems within a GPT partition table, following
171-
the <ulink url="https://systemd.io/DISCOVERABLE_PARTITIONS">Discoverable Partitions
171+
the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
172172
Specification</ulink>. For further information on supported disk images, see
173173
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
174174
switch of the same name.</para></listitem>

man/kernel-install.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>ENTRY-TOKEN</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</programlisting>
7979

8080
<para>The third argument directly refers to the path where to place kernel images, initrd
81-
images and other resources for <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot
81+
images and other resources for <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot
8282
Loader Specification</ulink> Type #1 entries (the "entry directory"). If other boot loader schemes
8383
are used the parameter may be ignored. The <replaceable>ENTRY-TOKEN</replaceable> string is
8484
typically the machine ID and is supposed to identify the local installation on the system. For
@@ -101,7 +101,7 @@
101101
If <replaceable>INITRD-FILE</replaceable>s are provided, it also copies them to
102102
<filename>$BOOT/<replaceable>ENTRY-TOKEN</replaceable>/<replaceable>KERNEL_VERSION</replaceable>/<replaceable>INITRD-FILE</replaceable></filename>.
103103
It also creates a boot loader entry according to the <ulink
104-
url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> (Type #1) in
104+
url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> (Type #1) in
105105
<filename>$BOOT/loader/entries/<replaceable>ENTRY-TOKEN</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.
106106
The title of the entry is the <replaceable>PRETTY_NAME</replaceable> parameter specified in
107107
<filename>/etc/os-release</filename> or <filename>/usr/lib/os-release</filename> (if the former
@@ -150,7 +150,7 @@
150150
<refsect1>
151151
<title>The <varname>$BOOT</varname> partition</title>
152152

153-
<para>The partition where the kernels and <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot
153+
<para>The partition where the kernels and <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot
154154
Loader Specification</ulink> snippets are located is called <varname>$BOOT</varname>.
155155
<command>kernel-install</command> determines the location of this partition by checking
156156
<filename>/efi/</filename>, <filename>/boot/</filename>, and <filename>/boot/efi/</filename> in turn. The
@@ -225,7 +225,7 @@
225225
<varlistentry>
226226
<term>bls</term>
227227
<listitem>
228-
<para>Standard <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader
228+
<para>Standard <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader
229229
Specification</ulink> Type #1 layout, compatible with
230230
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>:
231231
entries in
@@ -385,7 +385,7 @@
385385
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
386386
<citerefentry project='man-pages'><refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
387387
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
388-
<ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>
388+
<ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>
389389
</para>
390390
</refsect1>
391391

0 commit comments

Comments
 (0)