summaryrefslogtreecommitdiffstats
path: root/man/os-release.xml
diff options
context:
space:
mode:
authorLuca Boccassi <bluca@debian.org>2023-03-24 16:10:11 +0100
committerLuca Boccassi <bluca@debian.org>2023-03-28 13:14:21 +0200
commit38d1d1046515a0ef8d10ef732bbafffc1ad54c13 (patch)
tree769aaa3dc23ad12ad571a0d5a92a2f7d856e2c4c /man/os-release.xml
parentportablectl: display sysext-specific fields (diff)
downloadsystemd-38d1d1046515a0ef8d10ef732bbafffc1ad54c13.tar.xz
systemd-38d1d1046515a0ef8d10ef732bbafffc1ad54c13.zip
os-release: add 'SYSEXT_' fields for version/id
sysext DDI cannot carry an os-release file, but have to carry an extension-release file. But so far, this was only used to match the sysext DDI with the base DDI/rootdir. It is also useful to describe the sysext DDI itself, just like we do in os-release. So document that the same fields used in os-release can also be added to an extension-release, with the 'SYSEXT_' prefix, and in that case they are understood to define the sysext DDI itself, rather than for matching purposes.
Diffstat (limited to 'man/os-release.xml')
-rw-r--r--man/os-release.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/man/os-release.xml b/man/os-release.xml
index 113ef9fc18..e74f27b990 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -111,6 +111,11 @@
<varname>VERSION_ID=</varname> exists and matches. This ensures ABI/API compatibility between the
layers and prevents merging of an incompatible image in an overlay.</para>
+ <para>In order to identify the extension image itself, the same fields defined below can be added to the
+ <filename>extension-release</filename> file with a <varname>SYSEXT_</varname> prefix (to disambiguate
+ from fields used to match on the base image). E.g.: <varname>SYSEXT_ID=myext</varname>,
+ <varname>SYSEXT_VERSION_ID=1.2.3</varname>.</para>
+
<para>In the <filename>extension-release.<replaceable>IMAGE</replaceable></filename> filename, the
<replaceable>IMAGE</replaceable> part must exactly match the file name of the containing image with the
suffix removed. In case it is not possible to guarantee that an image file name is stable and doesn't