summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorAdrian Vovk <adrianvovk@gmail.com>2023-07-19 20:43:58 +0200
committerTom Coldrick <thomas.coldrick@codethink.co.uk>2024-07-12 15:38:09 +0200
commitdb8849f2d4ab24c767f806f324587939e7f5c8e6 (patch)
treef348f10ea13de36204489e3c88ab7ab7b49f3b8d /man
parentsysupdate: Implement JSON output (diff)
downloadsystemd-db8849f2d4ab24c767f806f324587939e7f5c8e6.tar.xz
systemd-db8849f2d4ab24c767f806f324587939e7f5c8e6.zip
sysupdate: Support changelogs & appstream metadata
Makes it possible to specify URLs to a changelog and an appstream catalog XML in the sysupdate.d/*.conf files. This will be passed along to the clients of systemd-sysupdated, which can then present this data.
Diffstat (limited to 'man')
-rw-r--r--man/sysupdate.d.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml
index 125c5802b7..ef3b21d29d 100644
--- a/man/sysupdate.d.xml
+++ b/man/sysupdate.d.xml
@@ -487,6 +487,38 @@
<xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>ChangeLog=</varname></term>
+
+ <listitem><para>Optionally takes a human-presentable URL to a website containing a change-log of
+ the resource being updated.</para>
+
+ <para>This may be set multiple times in a single transfer definition. If set multiple times, the
+ values are gathered into a list of URLs. Adding a value of the empty string will clear the existing
+ list of all values.</para>
+
+ <para>This setting supports specifier expansion. See below for details on supported
+ specifiers. This setting will also expand the <literal>@v</literal> wildcard pattern. See above
+ for details.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>AppStream=</varname></term>
+
+ <listitem><para>Optionally takes a URL to an
+ <ulink url="https://www.freedesktop.org/software/appstream/docs/chap-CatalogData.html">AppStream catalog</ulink>
+ XML file. This may be used by software centers (such as GNOME Software or KDE Discover) to present
+ rich metadata about the resources being updated. This includes display names, changelogs, icons,
+ and more. The specified catalog must include <ulink url="https://systemd.io/APPSTREAM_BUNDLE">special metadata</ulink>
+ to be correctly associated with <command>systemd-sysupdate</command> by the software centers.</para>
+
+ <para>This setting supports specifier expansion. See below for details on supported
+ specifiers.</para>
+
+ <xi:include href="version-info.xml" xpointer="v257"/></listitem>
+ </varlistentry>
</variablelist>
</refsect1>