From db81144428d7af1b10eb332dde9708e8d136ebe1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Mon, 14 Nov 2022 09:44:39 +0100 Subject: [PATCH] tree-wide: BLS and DPS are now on uapi-group website --- docs/AUTOMATIC_BOOT_ASSESSMENT.md | 7 ++++--- docs/BOOT_LOADER_INTERFACE.md | 13 +++++++------ docs/BUILDING_IMAGES.md | 24 ++++++++++++------------ docs/ENVIRONMENT.md | 14 +++++++------- docs/PORTABLE_SERVICES.md | 2 +- docs/PORTING_TO_NEW_ARCHITECTURES.md | 4 ++-- man/bootctl.xml | 14 +++++++------- man/coredumpctl.xml | 2 +- man/journalctl.xml | 2 +- man/kernel-install.xml | 10 +++++----- man/loader.conf.xml | 4 ++-- man/repart.d.xml | 4 ++-- man/systemctl.xml | 2 +- man/systemd-bless-boot.service.xml | 2 +- man/systemd-boot.xml | 12 ++++++------ man/systemd-dissect.xml | 10 +++++----- man/systemd-firstboot.xml | 2 +- man/systemd-gpt-auto-generator.xml | 6 +++--- man/systemd-nspawn.xml | 2 +- man/systemd-stub.xml | 2 +- man/systemd-sysext.xml | 2 +- man/systemd-sysusers.xml | 2 +- man/systemd-tmpfiles.xml | 2 +- man/systemd.exec.xml | 6 +++--- man/sysupdate.d.xml | 16 ++++++++-------- src/basic/efivars.c | 2 +- src/nspawn/nspawn.c | 2 +- tools/list-discoverable-partitions.py | 3 ++- 28 files changed, 88 insertions(+), 85 deletions(-) diff --git a/docs/AUTOMATIC_BOOT_ASSESSMENT.md b/docs/AUTOMATIC_BOOT_ASSESSMENT.md index c2a53f48dcf..91e2c5b094c 100644 --- a/docs/AUTOMATIC_BOOT_ASSESSMENT.md +++ b/docs/AUTOMATIC_BOOT_ASSESSMENT.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later systemd provides support for automatically reverting back to the previous version of the OS or kernel in case the system consistently fails to boot. The -[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting) +[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting) describes how to annotate boot loader entries with a counter that specifies how many attempts should be made to boot it. This document describes how systemd implements this scheme. @@ -28,7 +28,7 @@ Here's a brief overview of the complete set of components: * The [`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html) boot loader optionally maintains a per-boot-loader-entry counter described by - the [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting) + the [Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting) that is decreased by one on each attempt to boot the entry, prioritizing entries that have non-zero counters over those which already reached a counter of zero when choosing the entry to boot. @@ -60,7 +60,8 @@ Here's a brief overview of the complete set of components: ## Details -As described in [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md#boot-counting), +As described in the +[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/#boot-counting), the boot counting data is stored in the file name of the boot loader entries as a plus (`+`), followed by a number, optionally followed by `-` and another number, right before the file name suffix (`.conf` or `.efi`). diff --git a/docs/BOOT_LOADER_INTERFACE.md b/docs/BOOT_LOADER_INTERFACE.md index fc9336085bd..cc519085e9b 100644 --- a/docs/BOOT_LOADER_INTERFACE.md +++ b/docs/BOOT_LOADER_INTERFACE.md @@ -119,10 +119,11 @@ the identifiers as passed in `LoaderEntries`, `LoaderEntryDefault`, `LoaderEntryOneShot`, `LoaderEntrySelected`, and possibly show nicely localized names for them in UIs. -1. When boot loader entries are defined through - [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md) drop-in files - the identifier should be derived directly from the drop-in snippet name, but - with the `.conf` (or `.efi` in case of Type #2 entries) suffix removed. +1. When boot loader entries are defined through the + [Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification/) + drop-in files the identifier should be derived directly from the drop-in + snippet name, but with the `.conf` (or `.efi` in case of Type #2 entries) + suffix removed. 2. Entries automatically discovered by the boot loader (as opposed to being configured in configuration files) should generally have an identifier @@ -150,8 +151,8 @@ names for them in UIs. ## Links -[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md)
-[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md)
+[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)
+[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)
[`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)
[`bootctl(1)`](https://www.freedesktop.org/software/systemd/man/bootctl.html)
[`systemd-gpt-auto-generator(8)`](https://www.freedesktop.org/software/systemd/man/systemd-gpt-auto-generator.html) diff --git a/docs/BUILDING_IMAGES.md b/docs/BUILDING_IMAGES.md index 955dd90e553..1a96ed00834 100644 --- a/docs/BUILDING_IMAGES.md +++ b/docs/BUILDING_IMAGES.md @@ -67,14 +67,14 @@ boot. For that it's essential to: The [`kernel-install(8)`](https://www.freedesktop.org/software/systemd/man/kernel-install.html) logic used to generate -[Boot Loader Specification Type 1](BOOT_LOADER_SPECIFICATION.md) entries by -default uses the machine ID as stored in `/etc/machine-id` for naming boot menu -entries and the directories in the ESP to place kernel images in. This is done -in order to allow multiple installations of the same OS on the same system -without conflicts. However, this is problematic if the machine ID shall be -generated automatically on first boot: if the ID is not known before the first -boot it cannot be used to name the most basic resources required for the boot -process to complete. +[Boot Loader Specification Type #1](https://uapi-group.org/specifications/specs/boot_loader_specification/#type-1-boot-loader-specification-entries) +entries by default uses the machine ID as stored in `/etc/machine-id` for +naming boot menu entries and the directories in the ESP to place kernel images +in. This is done in order to allow multiple installations of the same OS on the +same system without conflicts. However, this is problematic if the machine ID +shall be generated automatically on first boot: if the ID is not known before +the first boot it cannot be used to name the most basic resources required for +the boot process to complete. Thus, for images that shall acquire their identity on first boot only, it is required to use a different identifier for naming boot menu entries. To allow @@ -203,8 +203,8 @@ it, then format it. in. The `x-systemd.growfs` mount option in `/etc/fstab` is sufficient to enable this logic for specific mounts. Alternatively appropriately set up partitions can set GPT partition flag 59 to request this behaviour, see the - [Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md) for - details. If the file system is already grown it executes no operation. + [Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification) + for details. If the file system is already grown it executes no operation. 3. Similar, the `systemd-makefs@.service` and `systemd-makeswap@.service` services can format file systems and swap spaces before first use, if they @@ -267,8 +267,8 @@ fields. [`machine-id(5)`](https://www.freedesktop.org/software/systemd/man/machine-id.html)
[`systemd-random-seed(8)`](https://www.freedesktop.org/software/systemd/man/systemd-random-seed.service.html)
[`os-release(5)`](https://www.freedesktop.org/software/systemd/man/os-release.html)
-[Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md)
-[Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md)
+[Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification)
+[Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification)
[`mkosi`](https://github.com/systemd/mkosi)
[`systemd-boot(7)`](https://www.freedesktop.org/software/systemd/man/systemd-boot.html)
[`systemd-repart(8)`](https://www.freedesktop.org/software/systemd/man/systemd-repart.service.html)
diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md index 61ad0750854..58f7026b34c 100644 --- a/docs/ENVIRONMENT.md +++ b/docs/ENVIRONMENT.md @@ -188,12 +188,12 @@ All tools: file may be checked for by services run during system shutdown in order to request the appropriate operation from the boot loader in an alternative fashion. Note that by default only boot loader entries which follow the - [Boot Loader Specification](BOOT_LOADER_SPECIFICATION.md) and are - placed in the ESP or the Extended Boot Loader partition may be selected this - way. However, if a directory `/run/boot-loader-entries/` exists, the entries - are loaded from there instead. The directory should contain the usual - directory hierarchy mandated by the Boot Loader Specification, i.e. the entry - drop-ins should be placed in + [Boot Loader Specification](https://uapi-group.org/specifications/specs/boot_loader_specification) + and are placed in the ESP or the Extended Boot Loader partition may be + selected this way. However, if a directory `/run/boot-loader-entries/` + exists, the entries are loaded from there instead. The directory should + contain the usual directory hierarchy mandated by the Boot Loader + Specification, i.e. the entry drop-ins should be placed in `/run/boot-loader-entries/loader/entries/*.conf`, and the files referenced by the drop-ins (including the kernels and initrds) somewhere else below `/run/boot-loader-entries/`. Note that all these files may be (and are @@ -384,7 +384,7 @@ disk images with `--image=` or similar: to load the embedded Verity signature data. If enabled (which is the default), Verity root hash information and a suitable signature is automatically acquired from a signature partition, following the - [Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md). + [Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification). If disabled any such partition is ignored. Note that this only disables discovery of the root hash and its signature, the Verity data partition itself is still searched in the GPT image. diff --git a/docs/PORTABLE_SERVICES.md b/docs/PORTABLE_SERVICES.md index 4f02ddb4778..7a9c7f512df 100644 --- a/docs/PORTABLE_SERVICES.md +++ b/docs/PORTABLE_SERVICES.md @@ -169,7 +169,7 @@ requirements are made for an image that can be attached/detached with an image with a partition table understood by the Linux kernel with only a single partition defined, or alternatively, a GPT partition table with a set of properly marked partitions following the - [Discoverable Partitions Specification](DISCOVERABLE_PARTITIONS.md). + [Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification). 3. The image must at least contain one matching unit file, with the right name prefix and suffix (see above). The unit file is searched in the usual paths, diff --git a/docs/PORTING_TO_NEW_ARCHITECTURES.md b/docs/PORTING_TO_NEW_ARCHITECTURES.md index 5c61481486c..10383360103 100644 --- a/docs/PORTING_TO_NEW_ARCHITECTURES.md +++ b/docs/PORTING_TO_NEW_ARCHITECTURES.md @@ -27,8 +27,8 @@ architecture. partitions. Use `systemd-id128 new -p` to generate new suitable UUIDs you can use for this. Make sure to register your new types in the various functions in `gpt.c`. Also make sure to update the tables in - `docs/DISCOVERABLE_PARTITIONS.md` and `man/systemd-gpt-auto-generator.xml` - accordingly. + [Discoverable Partitions Specification](https://uapi-group.org/specifications/specs/discoverable_partitions_specification) + and `man/systemd-gpt-auto-generator.xml` accordingly. 3. If your architecture supports UEFI, make sure to update the `efi_arch` variable logic in `meson.build` to be set to the right architecture string diff --git a/man/bootctl.xml b/man/bootctl.xml index dfc56d61259..3083f356e8e 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -86,7 +86,7 @@ Boot Loader Specification Commands These commands are available for all boot loaders that implement the Boot Loader Specification and/or the Boot Loader Specification and/or the Boot Loader Interface, such as systemd-boot. @@ -95,7 +95,7 @@ Shows all available boot loader entries implementing the Boot Loader Specification, as well as any + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification, as well as any other entries discovered or automatically generated by a boot loader implementing the Boot Loader Interface. JSON output may be requested with . @@ -120,7 +120,7 @@ entry for all future boots, the current default boot loader entry for the next boot, and the currently booted boot loader entry. These special IDs are resolved to the current values of the EFI variables LoaderEntryDefault, LoaderEntryOneShot and LoaderEntrySelected, - see Boot Loader Specification for details. + see Boot Loader Specification for details. These special IDs are primarily useful as a quick way to persistently make the currently booted boot loader entry the default choice, or to upgrade the default boot loader entry for the next boot to the default boot loader entry for all future boots, but may be used for other operations too. @@ -232,7 +232,7 @@ Path to the Extended Boot Loader partition, as defined in the Boot Loader Specification. If not + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification. If not specified, /boot/ is checked. It is recommended to mount the Extended Boot Loader partition to /boot/, if possible. @@ -252,7 +252,7 @@ are applied to file system in the indicated disk image. This option is similar to , but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition - table, following the Discoverable Partitions + table, following the Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. @@ -318,7 +318,7 @@ Controls creation and deletion of the Boot Loader Specification Type #1 entry + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification Type #1 entry directory on the file system containing resources such as kernel and initrd images during and , respectively. The directory is named after the entry token, as specified with parameter described below, and is @@ -529,7 +529,7 @@ Boot Loader Entries: See Also systemd-boot7, - Boot Loader Specification, + Boot Loader Specification, Boot Loader Interface, systemd-boot-system-token.service8 diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 8002549f7d8..79632eb2d4f 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -262,7 +262,7 @@ are applied to file system in the indicated disk image. This option is similar to , but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition - table, following the Discoverable Partitions + table, following the Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/journalctl.xml b/man/journalctl.xml index 5bf895fce44..5ca5bc97407 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -168,7 +168,7 @@ option is similar to , but operates on file systems stored in disk images or block devices, thus providing an easy way to extract log data from disk images. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following - the Discoverable Partitions + the Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/kernel-install.xml b/man/kernel-install.xml index b8ea2b16b26..29b0d8eb54f 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -78,7 +78,7 @@ add KERNEL-VERSION $BOOT/ENTRY-TOKEN/KERNEL-VERSION/ KERNEL-IMAGE [INITRD-FILE ...] The third argument directly refers to the path where to place kernel images, initrd - images and other resources for Boot + images and other resources for Boot Loader Specification Type #1 entries (the "entry directory"). If other boot loader schemes are used the parameter may be ignored. The ENTRY-TOKEN string is typically the machine ID and is supposed to identify the local installation on the system. For @@ -101,7 +101,7 @@ If INITRD-FILEs are provided, it also copies them to $BOOT/ENTRY-TOKEN/KERNEL_VERSION/INITRD-FILE. It also creates a boot loader entry according to the Boot Loader Specification (Type #1) in + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification (Type #1) in $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION.conf. The title of the entry is the PRETTY_NAME parameter specified in /etc/os-release or /usr/lib/os-release (if the former @@ -150,7 +150,7 @@ The <varname>$BOOT</varname> partition - The partition where the kernels and Boot + The partition where the kernels and Boot Loader Specification snippets are located is called $BOOT. kernel-install determines the location of this partition by checking /efi/, /boot/, and /boot/efi/ in turn. The @@ -225,7 +225,7 @@ bls - Standard Boot Loader + Standard Boot Loader Specification Type #1 layout, compatible with systemd-boot7: entries in @@ -385,7 +385,7 @@ os-release5, depmod8, systemd-boot7, - Boot Loader Specification + Boot Loader Specification diff --git a/man/loader.conf.xml b/man/loader.conf.xml index 7f173aec610..cf84119df0c 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -36,7 +36,7 @@ .conf extension under ESP/loader/entries/ on the EFI system partition (ESP), and XBOOTLDR/loader/entries/ on the extended boot loader - partition (XBOOTLDR) as defined by Boot Loader + partition (XBOOTLDR) as defined by Boot Loader Specification. @@ -57,7 +57,7 @@ The configuration options supported by ESP/loader/entries/*.conf and XBOOTLDR/loader/entries/*.conf files are defined as part - of the Boot Loader + of the Boot Loader Specification. The following configuration are supported by the loader.conf configuration diff --git a/man/repart.d.xml b/man/repart.d.xml index ebbb31cc20e..25c5b35449a 100644 --- a/man/repart.d.xml +++ b/man/repart.d.xml @@ -237,7 +237,7 @@ This setting defaults to linux-generic. Most of the partition type UUIDs listed above are defined in the Discoverable Partitions + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. @@ -542,7 +542,7 @@ Configures the No-Auto, Read-Only and Grow-File-System partition flags (bit 63, 60 and 59) of the partition table entry, as defined by the Discoverable Partitions Specification. Only + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. Only available for partition types supported by the specification. This option is a friendly way to set bits 63, 60 and 59 of the partition flags value without setting any of the other bits, and may be set via Flags= too, see above. diff --git a/man/systemctl.xml b/man/systemctl.xml index 997925892d5..1d91c8a7262 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -2208,7 +2208,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err are applied to file system in the indicated disk image. This option is similar to , but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition - table, following the Discoverable Partitions + table, following the Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd-bless-boot.service.xml b/man/systemd-bless-boot.service.xml index 53a58b3a1cc..484f072352e 100644 --- a/man/systemd-bless-boot.service.xml +++ b/man/systemd-bless-boot.service.xml @@ -39,7 +39,7 @@ Internally, the service operates based on the LoaderBootCountPath EFI variable (of the vendor UUID 4a67b082-0a4c-41cf-b6c7-440b29bb8c4), which is passed from the boot loader to the OS. It contains a file system path (relative to the EFI system partition) of the Boot Loader Specification compliant boot loader entry + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification compliant boot loader entry file or unified kernel image file that was used to boot up the system. systemd-bless-boot.service removes the two 'tries done' and 'tries left' numeric boot counters from the filename, which indicates to future invocations of the boot loader that the entry has completed diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index 0eee532f90a..2e2a675ec22 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -39,12 +39,12 @@ Boot entries defined with Boot Loader Specification Type #1 + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification Type #1 description files located in /loader/entries/ on the ESP and the Extended Boot Loader Partition. These usually describe Linux kernel images with associated initrd images, but alternatively may also describe other arbitrary EFI executables. - Unified kernel images, Boot + Unified kernel images, Boot Loader Specification Type #2, which are executable EFI binaries in /EFI/Linux/ on the ESP and the Extended Boot Loader Partition. @@ -304,11 +304,11 @@ loader.conf5. Boot entry description files following the Boot Loader Specification are read from + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification are read from /loader/entries/ on the ESP and the Extended Boot Loader partition. Unified kernel boot entries following the Boot Loader Specification are read from + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification are read from /EFI/Linux/ on the ESP and the Extended Boot Loader partition. Optionally, a random seed for early boot entropy pool provisioning is stored in @@ -474,7 +474,7 @@ Boot Counting systemd-boot implements a simple boot counting mechanism on top of the Boot Loader Specification, for automatic and unattended + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification, for automatic and unattended fallback to older kernel versions/boot loader entries when a specific entry continuously fails. Any boot loader entry file and unified kernel image file that contains a + followed by one or two numbers (if two they need to be separated by a -), before the .conf or @@ -534,7 +534,7 @@ systemd-boot-system-token.service8, kernel-install8, systemd-stub7, - Boot Loader Specification, + Boot Loader Specification, Boot Loader Interface diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml index b9404082671..2eb8972feed 100644 --- a/man/systemd-dissect.xml +++ b/man/systemd-dissect.xml @@ -74,7 +74,7 @@ OS disk images containing a GPT partition table envelope, with partitions marked - according to the Discoverable Partitions + according to the Discoverable Partitions Specification. OS disk images containing just a plain file-system without an enveloping partition @@ -115,7 +115,7 @@ Mount the specified OS image to the specified directory. This will dissect the image, determine the OS root file system — as well as possibly other partitions — and mount them to the specified directory. If the OS image contains multiple partitions marked with the Discoverable Partitions Specification + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification multiple nested mounts are established. This command expects two arguments: a path to an image file and a path to a directory where to mount the image. @@ -270,7 +270,7 @@ or ) the file systems contained in the OS image are automatically grown to their partition sizes, if bit 59 in the GPT partition flags is set for partition types that are defined by the Discoverable Partitions Specification. This + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. This behavior may be switched off using . File systems are grown automatically on access if all of the following conditions are met: @@ -322,7 +322,7 @@ specifies a path to a file with the Verity data to use for the OS image, in case it is stored in a detached file. It is recommended to embed the Verity data directly in the image, using the Verity mechanisms in the Discoverable Partitions Specification. + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. @@ -356,7 +356,7 @@ systemd1, systemd-nspawn1, systemd.exec5, - Discoverable Partitions Specification, + Discoverable Partitions Specification, umount8, fdisk8 diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index 66d829941b8..3f01836ddda 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -104,7 +104,7 @@ are applied to file system in the indicated disk image. This is similar to but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the - Discoverable Partitions + Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml index 8ad249ec5d9..3b166b87f90 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -34,7 +34,7 @@ /var/tmp/, the EFI System Partition, the Extended Boot Loader Partition and swap partitions and creates mount and swap units for them, based on the partition type GUIDs of GUID partition tables (GPT), see UEFI Specification, chapter 5. It - implements the Discoverable Partitions + implements the Discoverable Partitions Specification. Note that this generator has no effect on non-GPT systems, and on specific mount points that are directories already containing files. Also, on systems where the units are explicitly configured (for example, listed in root partitions for other architectures / - The first partition with the type UUID matching the architecture, located on the same disk as the ESP, is used as the root file system /. For the full list and constant values, see Discoverable Partitions Specification. + The first partition with the type UUID matching the architecture, located on the same disk as the ESP, is used as the root file system /. For the full list and constant values, see Discoverable Partitions Specification. SD_GPT_HOME 933ac7e1-2eb4-4f13-b844-0e14e2aef915 @@ -211,7 +211,7 @@ are generated. If the disk contains an Extended Boot Loader partition, as defined in the Boot Loader Specification, it is made + url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification, it is made available at /boot/ (by means of an automount point, similar to the ESP, see above). If both an EFI System Partition and an Extended Boot Loader partition exist the latter is preferably mounted to /boot/. Make sure to create both /efi/ diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 16e2286ed08..053efdb8073 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -288,7 +288,7 @@ a server data partition which are mounted to the appropriate places in the container. All these partitions must be identified by the partition types defined by the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. No partition table, and a single file system spanning the whole image. diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml index 415d663f53e..fcb0c24ce80 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -430,7 +430,7 @@ systemd.exec5, systemd-creds1, systemd-sysext8, - Boot Loader Specification, + Boot Loader Specification, Boot Loader Interface, objcopy1, sbsign1, diff --git a/man/systemd-sysext.xml b/man/systemd-sysext.xml index aa0d42d83c6..1de1627850a 100644 --- a/man/systemd-sysext.xml +++ b/man/systemd-sysext.xml @@ -72,7 +72,7 @@ Plain directories or btrfs subvolumes containing the OS tree Disk images with a GPT disk label, following the Discoverable Partitions Specification + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification Disk images lacking a partition table, with a naked Linux file system (e.g. squashfs or ext4) diff --git a/man/systemd-sysusers.xml b/man/systemd-sysusers.xml index b399b3b04c9..aba275024f9 100644 --- a/man/systemd-sysusers.xml +++ b/man/systemd-sysusers.xml @@ -74,7 +74,7 @@ are applied to file system in the indicated disk image. This is similar to but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the - Discoverable Partitions + Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index 92ab322ba0e..c2e32f9f3df 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -192,7 +192,7 @@ are applied to file system in the indicated disk image. This is similar to but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the - Discoverable Partitions + Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 29666b102bc..d003ab18386 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -156,7 +156,7 @@ or loopback file instead of a directory. The device node or file system image file needs to contain a file system without a partition table, or a file system within an MBR/MS-DOS or GPT partition table with only a single Linux-compatible partition, or a set of file systems within a GPT partition table - that follows the Discoverable Partitions + that follows the Discoverable Partitions Specification. When DevicePolicy= is set to closed or @@ -188,7 +188,7 @@ Valid partition names follow the Discoverable Partitions Specification: + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification: root, usr, home, srv, esp, xbootldr, tmp, var. @@ -255,7 +255,7 @@ This option is supported only for disk images that contain a single file system, without an enveloping partition table. Images that contain a GPT partition table should instead include both root file system and matching Verity data in the same image, implementing the Discoverable Partitions Specification. + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml index d57fbf0442b..3540b441760 100644 --- a/man/sysupdate.d.xml +++ b/man/sysupdate.d.xml @@ -71,7 +71,7 @@ A file https://download.example.com/foobarOS_47.root.xz should be downloaded, decompressed and written to a previously unused partition with GPT partition type UUID 4f68bce3-e8cd-4db1-96e7-fbcaf984b709 for x86-64, as per Discoverable Partitions + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification. Similarly, a file https://download.example.com/foobarOS_47.verity.xz @@ -80,7 +80,7 @@ for x86-64 root file systems). Finally, a file https://download.example.com/foobarOS_47.efi.xz (a - unified kernel, as per Boot Loader + unified kernel, as per Boot Loader Specification Type #2) should be downloaded, decompressed and written to the ESP file system, i.e. to EFI/Linux/foobarOS_47.efi in the ESP. @@ -355,21 +355,21 @@ @a GPT partition flag NoAuto Either 0 or 1 - Controls NoAuto bit of the GPT partition flags, as per Discoverable Partitions Specification; only relevant if target resource type chosen as partition + Controls NoAuto bit of the GPT partition flags, as per Discoverable Partitions Specification; only relevant if target resource type chosen as partition @g GPT partition flag GrowFileSystem Either 0 or 1 - Controls GrowFileSystem bit of the GPT partition flags, as per Discoverable Partitions Specification; only relevant if target resource type chosen as partition + Controls GrowFileSystem bit of the GPT partition flags, as per Discoverable Partitions Specification; only relevant if target resource type chosen as partition @r Read-only flag Either 0 or 1 - Controls ReadOnly bit of the GPT partition flags, as per Discoverable Partitions Specification and other output read-only flags, see ReadOnly= below + Controls ReadOnly bit of the GPT partition flags, as per Discoverable Partitions Specification and other output read-only flags, see ReadOnly= below @@ -610,7 +610,7 @@ overall PartitionFlags= flags setting and the individual flag settings PartitionNoAuto= and PartitionGrowFileSystem= are used (or the wildcards for them), then the latter override the former, i.e. the individual flag bit overrides the - overall flags value. See Discoverable + overall flags value. See Discoverable Partitions Specification for details about these flags. Note that these settings are not used for matching, they only have effect on newly written @@ -622,7 +622,7 @@ Controls whether to mark the resulting file, subvolume or partition read-only. If the target type is partition this controls the ReadOnly partition flag, as per - Discoverable Partitions + Discoverable Partitions Specification, similar to the PartitionNoAuto= and PartitionGrowFileSystem= flags described above. If the target type is regular-file, the writable bit is removed from the access mode. If the the @@ -829,7 +829,7 @@ TriesDone=0 InstancesMax=2 The above installs a unified kernel image into the ESP (which is mounted to - /efi/), as per Boot + /efi/), as per Boot Loader Specification Type #2. This defines three possible patterns for the names of the kernel images, as per Automatic Boot Assessment, and ensures when installing new kernels, they are set up with 3 tries left. No diff --git a/src/basic/efivars.c b/src/basic/efivars.c index 847b6da1eef..17e0fb895e6 100644 --- a/src/basic/efivars.c +++ b/src/basic/efivars.c @@ -354,7 +354,7 @@ static int read_efi_options_variable(char **ret) { int r; /* In SecureBoot mode this is probably not what you want. As your cmdline is cryptographically signed - * like when using Type #2 EFI Unified Kernel Images (https://systemd.io/BOOT_LOADER_SPECIFICATION) + * like when using Type #2 EFI Unified Kernel Images (https://uapi-group.org/specifications/specs/boot_loader_specification) * The user's intention is then that the cmdline should not be modified. You want to make sure that * the system starts up as exactly specified in the signed artifact. * diff --git a/src/nspawn/nspawn.c b/src/nspawn/nspawn.c index ef5825ef757..d7b636209eb 100644 --- a/src/nspawn/nspawn.c +++ b/src/nspawn/nspawn.c @@ -5753,7 +5753,7 @@ static int run(int argc, char *argv[]) { log_notice("Note that the disk image needs to\n" " a) either contain only a single MBR partition of type 0x83 that is marked bootable\n" " b) or contain a single GPT partition of type 0FC63DAF-8483-4772-8E79-3D69D8477DE4\n" - " c) or follow https://systemd.io/DISCOVERABLE_PARTITIONS\n" + " c) or follow https://uapi-group.org/specifications/specs/discoverable_partitions_specification\n" " d) or contain a file system without a partition table\n" "in order to be bootable with systemd-nspawn."); goto finish; diff --git a/tools/list-discoverable-partitions.py b/tools/list-discoverable-partitions.py index 153c904774e..8376a7cdebb 100644 --- a/tools/list-discoverable-partitions.py +++ b/tools/list-discoverable-partitions.py @@ -90,7 +90,8 @@ DESCRIPTIONS = { 'The Extended Boot Loader Partition (XBOOTLDR) used for the current boot is automatically ' 'mounted to `/boot/`, unless a different partition is mounted there (possibly via ' '`/etc/fstab`) or the directory is non-empty on the root disk. This partition type ' - 'is defined by the [Boot Loader Specification](https://systemd.io/BOOT_LOADER_SPECIFICATION).'), + 'is defined by the [Boot Loader ' + 'Specification](https://uapi-group.org/specifications/specs/boot_loader_specification).'), 'SWAP': ( 'Swap, optionally in LUKS', 'All swap partitions on the disk containing the root partition are automatically enabled. '