From: Lennart Poettering Date: Sun, 23 Nov 2025 17:07:13 +0000 (+0100) Subject: man: always prefix links to uapi specs with their UAPI.XY spec number X-Git-Tag: v259-rc2~39^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F39867%2Fhead;p=thirdparty%2Fsystemd.git man: always prefix links to uapi specs with their UAPI.XY spec number Let's try to establish the spec numbers, by mentioning them in most doc links. Follow-up for: https://github.com/uapi-group/specifications/pull/187 --- diff --git a/man/bootctl.xml b/man/bootctl.xml index cbe735437fd..b317d840209 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -81,7 +81,7 @@ These commands are available for all boot loaders that implement the Boot + url="https://uapi-group.org/specifications/specs/boot_loader_specification">UAPI.1 Boot Loader Specification, such as systemd-boot. @@ -90,7 +90,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">UAPI.1 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 . @@ -126,7 +126,7 @@ Boot Loader Interface Commands These commands are available for all boot loaders that implement the Boot Loader Specification and the UAPI.1 Boot Loader Specification and the Boot Loader Interface, such as systemd-boot. @@ -152,7 +152,7 @@ boot loader entry. These special IDs are resolved to the current values of the EFI variables LoaderEntryDefault, LoaderEntrySysFail, LoaderEntryOneShot and LoaderEntrySelected, see - Boot Loader Specification for details. + UAPI.1 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. @@ -314,7 +314,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 UAPI.2 Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. @@ -444,7 +444,7 @@ Controls creation and deletion of the Boot Loader Specification Type #1 entry + url="https://uapi-group.org/specifications/specs/boot_loader_specification">UAPI.1 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 @@ -705,7 +705,7 @@ Boot Loader Entries: See Also systemd-boot7 - Boot Loader Specification + UAPI.1 Boot Loader Specification Boot Loader Interface systemd-boot-random-seed.service8 diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 9315679f07d..fa771a5c409 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -306,8 +306,9 @@ 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 - Specification. For further information on supported disk images, see + table, following the UAPI.2 + Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml index 7c5e5e523f5..86315cd0ce9 100644 --- a/man/file-hierarchy.xml +++ b/man/file-hierarchy.xml @@ -25,12 +25,11 @@ Operating systems using the systemd1 system and - service manager are organized based on a file system hierarchy inspired by UNIX, - as described in - Linux File System Hierarchy. - Additional requirements on when given parts of the hierarchy - must be available during boot are listed in - Mount Requirements. + service manager are organized based on a file system hierarchy inspired by UNIX, as described in UAPI.9 Linux File System + Hierarchy. Additional requirements on when given parts of the hierarchy + must be available during boot are listed in Mount + Requirements. Many of the paths described here can be queried with the diff --git a/man/journalctl.xml b/man/journalctl.xml index 82a0c07bdbd..933d56a38e9 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -193,7 +193,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 UAPI.2 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 0603292c3ef..3327f5c8b8e 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -109,7 +109,7 @@ The third argument directly refers to the path where to place kernel images, initrd images and other resources for - Boot + UAPI.1 Boot Loader Specification Type #1 entries (the "entry directory"). If other boot loader schemes are used the parameter may be ignored. @@ -141,7 +141,7 @@ $BOOT/ENTRY-TOKEN/KERNEL_VERSION/INITRD-FILE. This can also be used to prepend microcode before the actual initrd. It also creates a boot loader entry according to the - Boot Loader Specification + UAPI.1 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 @@ -290,7 +290,7 @@ The <varname>$BOOT</varname> partition - The partition where the kernels and Boot + The partition where the kernels and UAPI.1 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 @@ -310,7 +310,7 @@ Controls creation and deletion of the - Boot Loader Specification + UAPI.1 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, and is placed immediately below the boot root directory. When @@ -410,7 +410,7 @@ are applied to the 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 UAPI.2 Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. @@ -504,7 +504,7 @@ bls - Standard Boot Loader + Standard UAPI.1 Boot Loader Specification Type #1 layout, compatible with systemd-boot7: entries in @@ -520,7 +520,7 @@ uki Standard Boot Loader + url="https://uapi-group.org/specifications/specs/boot_loader_specification">UAPI.1 Boot Loader Specification Type #2 layout, compatible with systemd-boot7: unified kernel images under $BOOT/EFI/Linux as @@ -787,7 +787,7 @@ depmod8 systemd-boot7 ukify1 - Boot Loader Specification + UAPI.1 Boot Loader Specification diff --git a/man/loader.conf.xml b/man/loader.conf.xml index ef358f7e688..56026da20d7 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -51,7 +51,7 @@ and type #2 (ESP/EFI/Linux/*.uki and XBOOTLDR/EFI/Linux/*.uki). Those files are described by the - Boot Loader + UAPI.1 Boot Loader Specification. Note: the behaviour of systemd-boot is also influenced by EFI variables. Some of diff --git a/man/repart.d.xml b/man/repart.d.xml index 22d50e2c636..e83ed34f796 100644 --- a/man/repart.d.xml +++ b/man/repart.d.xml @@ -238,7 +238,7 @@ x86 (32-bit, aka i386) and x86-64 (64-bit, aka amd64). Most of the partition type UUIDs listed above are defined in the Discoverable Partitions + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable Partitions Specification. @@ -780,7 +780,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">UAPI.2 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. @@ -1007,7 +1007,7 @@ associated with it. For example, distributions can use this to implement $BOOT as defined in the - Boot Loader + UAPI.1 Boot Loader Specification. Distributions may prefer to use the ESP as $BOOT whenever possible, but to adhere to the spec XBOOTLDR must sometimes be used instead. So, they should create two definitions: the first defining an ESP big enough to hold just the bootloader, and a second for diff --git a/man/standard-options.xml b/man/standard-options.xml index d07ea4a09a4..d6d0c529218 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -137,7 +137,7 @@ Path to the Extended Boot Loader partition, as defined in the - Boot Loader Specification. + UAPI.1 Boot Loader Specification. If not specified, /boot/ is checked. It is recommended to mount the Extended Boot Loader partition to /boot/, if possible. diff --git a/man/systemctl.xml b/man/systemctl.xml index a290e990e5e..eae6442f583 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -1755,7 +1755,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err To load a kernel, an enumeration is performed following the - Boot Loader Specification, + UAPI.1 Boot Loader Specification, and the default boot entry is loaded. For this step to succeed, the system must be using UEFI and the boot loader entries must be configured appropriately. bootctl list may be used to list boot entries, see @@ -2646,7 +2646,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 UAPI.2 Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 927748bdc5d..e64f9be57ee 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -966,7 +966,7 @@ stored sock 0:8 4213190 - socket:[4213190] ro This command analyzes the specified image policy string, as per systemd.image-policy7. The policy is normalized and simplified. For each currently defined partition identifier (as per the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable Partitions Specification) the effect of the image policy string is shown in tabular form. diff --git a/man/systemd-bless-boot.service.xml b/man/systemd-bless-boot.service.xml index eb1d345fb82..715ff6f8448 100644 --- a/man/systemd-bless-boot.service.xml +++ b/man/systemd-bless-boot.service.xml @@ -36,15 +36,15 @@ detects that systemd-boot7 style boot counting is used. - Internally, the service operates based on the LoaderBootCountPath EFI variable (of the - vendor UUID 4a67b082-0a4c-41cf-b6c7-440b29bb8c4f), 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 - 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 - booting successfully at least once. (This service will hence rename the boot loader entry file or unified kernel - image file on the first successful boot.) + Internally, the service operates based on the LoaderBootCountPath EFI variable + (of the vendor UUID 4a67b082-0a4c-41cf-b6c7-440b29bb8c4f), which is passed from the + boot loader to the OS. It contains a file system path (relative to the EFI system partition) of the + UAPI.1 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 booting successfully at least once. (This service will hence rename the boot + loader entry file or unified kernel image file on the first successful boot.) diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index c465d4f4f35..0924b4ee887 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">UAPI.1 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, UAPI.1 Boot Loader Specification Type #2, which are executable EFI binaries in /EFI/Linux/ on the ESP and the Extended Boot Loader Partition. @@ -373,11 +373,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">UAPI.1 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">UAPI.1 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 @@ -657,7 +657,7 @@ uki-url http://example.com/somedir/fooos.efi 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">UAPI.1 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 @@ -742,7 +742,7 @@ uki-url http://example.com/somedir/fooos.efi systemd-boot-random-seed.service8 kernel-install8 systemd-stub7 - Boot Loader Specification + UAPI.1 Boot Loader Specification Boot Loader Interface TPM2 PCR Measurements Made by systemd diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml index e27ae4288e0..7d39426b1cf 100644 --- a/man/systemd-cryptenroll.xml +++ b/man/systemd-cryptenroll.xml @@ -84,8 +84,8 @@ , described below. - See Linux TPM - PCR Registry for an authoritative list of PCRs and how they are updated. The table below + See UAPI.7 Linux + TPM PCR Registry for an authoritative list of PCRs and how they are updated. The table below contains a quick reference, describing in particular the PCRs modified by systemd. @@ -218,7 +218,7 @@ through the certificates measured into PCR 7. Validation through certificates hashes is typically preferable over validation through direct measurements as it is less brittle in context of OS/firmware updates: the measurements will change on every update, but signatures should remain unchanged. See the - Linux TPM PCR + UAPI.7 Linux TPM PCR Registry for more discussion. diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml index c52de5f454c..669cea96f4e 100644 --- a/man/systemd-dissect.xml +++ b/man/systemd-dissect.xml @@ -93,7 +93,7 @@ OS disk images containing a GPT partition table envelope, with partitions marked - according to the Discoverable Partitions + according to the UAPI.2 Discoverable Partitions Specification. OS disk images containing just a plain file-system without an enveloping partition @@ -144,7 +144,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">UAPI.2 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. @@ -421,7 +421,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">UAPI.2 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: @@ -492,7 +492,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">UAPI.2 Discoverable Partitions Specification. @@ -651,7 +651,7 @@ systemd-nspawn1 systemd.exec5 systemd.v7 - Discoverable Partitions Specification + UAPI.2 Discoverable Partitions Specification mount8 umount8 fdisk8 diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index 26ce7571743..86a85f0bf28 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -117,7 +117,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 + UAPI.2 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 00a6b11234d..398076abc73 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -36,7 +36,7 @@ (XBOOTLDR), 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 for more details. It implements the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable Partitions Specification. Note that this generator has no effect on non-GPT systems. It will also not create mount point @@ -138,7 +138,7 @@ … Root partitions for other architectures / - The first partition with the type UUID matching the architecture, located on the same disk as the ESP used for booting, 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 used for booting, is used as the root file system /. For the full list and constant values, see UAPI.2 Discoverable Partitions Specification. SD_GPT_HOME @@ -252,7 +252,7 @@ Mount and automount units for the EFI System Partition (ESP) and Extended Boot Loader Partition (XBOOTLDR) are generated on EFI systems. If the disk contains an XBOOTLDR partition, as defined in the - Boot Loader + UAPI.1 Boot Loader Specification, it is made available at /boot/. This generator creates an automount unit; the mount will only be activated on-demand when accessed. The mount point will be created if necessary. @@ -354,7 +354,7 @@ automatic discovery of the root partition based on GPT partition information is enabled. This is a superset of root=gpt-auto, as it automatically configures Verity partitions (including signature-based setup) following the logic defined for that in the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification/">UAPI.2 Discoverable Partitions Specification. Moreover it takes the configured image policy and image filter into account for all partition types, including the root file system. root=dissect will wait for the factory reset phase to be completed if it is in effect before activating the root file diff --git a/man/systemd-id128.xml b/man/systemd-id128.xml index 27ad7530482..d8f49ca3d75 100644 --- a/man/systemd-id128.xml +++ b/man/systemd-id128.xml @@ -96,7 +96,7 @@ version 255. var-partition-uuid prints a UUID which, following the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable Partitions Specification, should be used as the GPT partition UUID for /var/, being derived from the GPT partition type, keyed by the local /etc/machine-id. Added in version 257. diff --git a/man/systemd-import-generator.xml b/man/systemd-import-generator.xml index 9435650d819..b09ea93f1a6 100644 --- a/man/systemd-import-generator.xml +++ b/man/systemd-import-generator.xml @@ -128,7 +128,7 @@ from downloaded disk images. This is only supported for raw disk images. Note when this option is used with the purpose of mounting a disk image conforming to the - Discoverable + UAPI.3 Discoverable Disk Image Specification as root file system, and the automatic GPT partition discovery logic as implemented by systemd-gpt-auto-generator8 diff --git a/man/systemd-measure.xml b/man/systemd-measure.xml index 755d84fe47c..ce198400880 100644 --- a/man/systemd-measure.xml +++ b/man/systemd-measure.xml @@ -34,7 +34,7 @@ systemd-measure is a tool that may be used to pre-calculate and sign the expected TPM2 PCR 11 values that should be seen when a Linux Unified Kernel Image + url="https://uapi-group.org/specifications/specs/unified_kernel_image/">UAPI.5 Unified Kernel Image (UKI) based on systemd-stub7 is booted up. It accepts paths to the ELF kernel image file, initrd image file, devicetree file, kernel diff --git a/man/systemd-mountfsd.service.xml b/man/systemd-mountfsd.service.xml index 81d02d3d4f8..7cc607c4c5c 100644 --- a/man/systemd-mountfsd.service.xml +++ b/man/systemd-mountfsd.service.xml @@ -33,7 +33,7 @@ file descriptors for the file systems contained therein to clients, via a Varlink IPC API. The disk images provided must contain a raw file system image or must follow the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification/">UAPI.2 Discoverable Partitions Specification. Before mounting any file systems authenticity of the disk image is established in one or a combination of the following ways: diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index ed0acc69371..d5e50d8d6df 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -327,14 +327,12 @@ partition of type 0fc63daf-8483-4772-8e79-3d69d8477de4. - A GUID partition table (GPT) with a marked - root partition which is mounted as the root directory of the - container. Optionally, GPT images may contain a home and/or - 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 - Partitions Specification. + A GUID partition table (GPT) with a marked root partition which is mounted as the + root directory of the container. Optionally, GPT images may contain a home and/or 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 UAPI.2 + 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 d098804dc10..2b40c1e5610 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -170,7 +170,7 @@ or credentials) or bind encryption to booted kernels. For further details about the UKI concept, see the UKI specification. + url="https://uapi-group.org/specifications/specs/unified_kernel_image/">UAPI.5 UKI specification. @@ -806,7 +806,7 @@ systemd.exec5 systemd-creds1 systemd-sysext8 - Boot Loader Specification + UAPI.1 Boot Loader Specification Boot Loader Interface ukify1 systemd-measure1 diff --git a/man/systemd-sysext.xml b/man/systemd-sysext.xml index 050e21fafcb..b5ab6826a2e 100644 --- a/man/systemd-sysext.xml +++ b/man/systemd-sysext.xml @@ -90,7 +90,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">UAPI.2 Discoverable Partitions Specification Disk images lacking a partition table, with a naked Linux file system (e.g. erofs, squashfs or ext4) diff --git a/man/systemd-sysusers.xml b/man/systemd-sysusers.xml index 29d02f26e0a..5c299169eba 100644 --- a/man/systemd-sysusers.xml +++ b/man/systemd-sysusers.xml @@ -76,8 +76,8 @@ 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 - Specification. For further information on supported disk images, see + UAPI.2 + 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 e4794c3f163..815dcd88d62 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -264,7 +264,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 + UAPI.2 Discoverable Partitions Specification. For further information on supported disk images, see systemd-nspawn1's switch of the same name. diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml index 7b26bec0676..7fd19671cbc 100644 --- a/man/systemd-vmspawn.xml +++ b/man/systemd-vmspawn.xml @@ -196,7 +196,7 @@ Set the linux kernel image to use for direct kernel boot. If a directory type image is used and was omitted, vmspawn will search for boot loader entries according to the - Boot Loader Specification assuming + UAPI.1 Boot Loader Specification assuming XBOOTLDR to be located at /boot and ESP to be /efi respectively. If no kernel was installed into the image then the image will fail to boot. @@ -210,7 +210,7 @@ Set the initrd to use for direct kernel boot. If the supplied is a - Boot Loader Specification + UAPI.1 Boot Loader Specification Type #2 entry, then this argument is not required. If no initrd was installed into the image then the image will fail to boot. @@ -739,7 +739,7 @@ $ ssh root@vsock/$my_vsock_cid -i /run/user/$UID/systemd/vmspawn/machine-*-syste mkosi1 machinectl1 importctl1 - Boot Loader Specification + UAPI.1 Boot Loader Specification diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index b2e3ae369b6..ebf8b1df6a0 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -174,9 +174,9 @@ 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 Specification. + that follows the UAPI.2 + Discoverable Partitions Specification. When DevicePolicy= is set to closed or strict, or set to auto and DeviceAllow= is diff --git a/man/systemd.image-filter.xml b/man/systemd.image-filter.xml index f5a8a811dac..eb16fce519b 100644 --- a/man/systemd.image-filter.xml +++ b/man/systemd.image-filter.xml @@ -24,7 +24,7 @@ Description In systemd, whenever a disk image (DDI) implementing the Discoverable + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable Partitions Specification is activated, a filter may be specified controlling which partitions to consider for mounting. Such a disk image dissection filter is a string that contains per-partition-type patterns, separated by colons (:). The individual rules consist of a partition diff --git a/man/systemd.image-policy.xml b/man/systemd.image-policy.xml index 36a8395bf0c..6d91669ef1b 100644 --- a/man/systemd.image-policy.xml +++ b/man/systemd.image-policy.xml @@ -24,13 +24,13 @@ Description In systemd, whenever a disk image (DDI) implementing the Discoverable - Partitions Specification is activated, a policy may be specified controlling which partitions to - mount and what kind of cryptographic protection to require. Such a disk image dissection policy is a - string that contains per-partition-type rules, separated by colons (:). The individual - rules consist of a partition identifier, an equal sign (=), and one or more flags - which may be set per partition. If multiple flags are specified per partition they are separated by a - plus sign (+). + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 + Discoverable Partitions Specification is activated, a policy may be specified controlling which + partitions to mount and what kind of cryptographic protection to require. Such a disk image dissection + policy is a string that contains per-partition-type rules, separated by colons + (:). The individual rules consist of a partition identifier, an equal sign + (=), and one or more flags which may be set per partition. If multiple flags are + specified per partition they are separated by a plus sign (+). The partition identifiers currently defined are: , , , , , , diff --git a/man/systemd.v.xml b/man/systemd.v.xml index cee351448c1..9bdf775378a 100644 --- a/man/systemd.v.xml +++ b/man/systemd.v.xml @@ -81,7 +81,7 @@ The variable part of the filenames in the .v/ directories are filtered and compared primarily with a version comparison, implementing Version Format + url="https://uapi-group.org/specifications/specs/version_format_specification/">UAPI.10 Version Format Specification. However, additional rules apply: diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml index 13dcd097754..0f1862b13c7 100644 --- a/man/sysupdate.d.xml +++ b/man/sysupdate.d.xml @@ -84,8 +84,8 @@ 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 - Specification. + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 + Discoverable Partitions Specification. Similarly, a file https://download.example.com/foobarOS_47.verity.xz should be downloaded, decompressed and written to a previously empty partition with GPT partition type @@ -93,7 +93,7 @@ for x86-64 root file systems). Finally, a file https://download.example.com/foobarOS_47.efi (a - unified kernel, as per Boot Loader + unified kernel, as per UAPI.1 Boot Loader Specification Type #2) should be downloaded, decompressed and written to the $BOOT file system, i.e. to EFI/Linux/foobarOS_47.efi in the ESP or XBOOTLDR partition. @@ -368,21 +368,21 @@ @aGPT partition flag NoAutoEither 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 UAPI.2 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 UAPI.2 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 UAPI.2 Discoverable Partitions Specification and other output read-only flags, see ReadOnly= below @@ -681,12 +681,12 @@ If set to root, esp, xbootldr, the specified Path= will be resolved relative to the mount point of the corresponding partition, as defined by the - Boot Loader + UAPI.1 Boot Loader Specification. If set to boot, the specified Path= will be resolved relative to the mount point of the $BOOT partition (i.e. the ESP or XBOOTLDR), as defined by the - Boot Loader + UAPI.1 Boot Loader Specification. If set to explicit, the specified Path= will be @@ -753,7 +753,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 UAPI.2 Discoverable Partitions Specification for details about these flags. Note that these settings are not used for matching, they only have effect on newly written @@ -767,7 +767,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 + UAPI.2 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 @@ -987,7 +987,7 @@ TriesDone=0 InstancesMax=2 The above installs a unified kernel image into the $BOOT partition, as per - Boot Loader + UAPI.1 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 more than two parallel diff --git a/man/ukify.xml b/man/ukify.xml index 0f953cd94db..829761642dc 100644 --- a/man/ukify.xml +++ b/man/ukify.xml @@ -47,7 +47,7 @@ ukify is a tool whose primary purpose is to combine components (usually a kernel, an initrd, and the systemd-stub7 UEFI - stub) to create a Unified + stub) to create a UAPI.5 Unified Kernel Image (UKI) — a single PE binary that boots the system. When the UKI is executed, the stub extracts and boots the embedded linux kernel. The UKI can be started directly by the firmware or through a boot loader. When used with qemu, a UKI can also