From d470a6c22736f98748b918a74f141ea44a52298b Mon Sep 17 00:00:00 2001 From: Adrian Vovk Date: Wed, 21 Aug 2024 22:10:49 -0400 Subject: [PATCH] sysupdate: man: Cleanup sections about flags --- man/org.freedesktop.sysupdate1.xml | 50 ++++++++++++++++-------------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/man/org.freedesktop.sysupdate1.xml b/man/org.freedesktop.sysupdate1.xml index 329fab8635d..66c21fab3d3 100644 --- a/man/org.freedesktop.sysupdate1.xml +++ b/man/org.freedesktop.sysupdate1.xml @@ -170,61 +170,60 @@ node /org/freedesktop/sysupdate1/target/host { Methods - List() returns a list of versions available for this target. The - flags argument can be used to pass additional options, with bit 0 mapping to - . When is true, this method returns only the versions - installed locally. Otherwise, this method pulls metadata from the network and returns all versions - available for this target. Use Describe() to query more information about each - version returned by this method. - - Describe() returns all known information about a given version as a JSON - object. The version argument is used to pass the version to be described. Additional - options may be passed through the flags argument. The only supported value currently - is SD_SYSUPDATE_OFFLINE, which prevents the call from accessing the network - and restricts results to locally installed versions. This flag is defined as follows: + List() returns a list of versions available for this target. Additional + options may be passed through the flags argument. Valid flags are defined as follows: + #define SD_SYSUPDATE_OFFLINE (UINT64_C(1) << 0) - The returned JSON object contains several known keys. More keys may be added in the future. The - currently known keys are as follows: + When SD_SYSUPDATE_OFFLINE is set, this method returns only the versions + installed locally. Otherwise, this method pulls metadata from the network and returns all versions + available for this target. Use Describe() to query more information about each + version returned by this method. + + Describe() returns all known information about a given version as a JSON + object. The version argument is used to pass the version to be described. Additional + options may be passed through the flags argument. This method supports the same flags + as List(). The returned JSON object contains several known keys. More keys may be + added in the future. The currently known keys are as follows: - version + version A string containing the version number. - newest + newest A boolean indicating whether this version is the latest available for the target. - available + available A boolean indicating whether this version is available for download. - installed + installed A boolean indicating whether this version is installed locally. - obsolete + obsolete A boolean indicating whether this version is considered obsolete by the service, and is therefore disallowed from being installed. - protected + protected A boolean indicating whether this version is exempt from deletion by a Vacuum() operation. - changelog_urls + changelog_urls A list of strings that contain user-presentable URLs to ChangeLogs associated with this version. @@ -326,9 +325,12 @@ node /org/freedesktop/sysupdate1/target/host { All methods called on this interface expose additional variables to the polkit rules. class contains the class of the Target being acted upon, and name contains the name of the same Target. Additionally, each method exposes its arguments to the - rule. Arguments containing flags are unwrapped into a variable-per-flag; for example, the - SD_SYSUPDATE_OFFLINE flag is exposed as a variable named offline. - + rule. Flags are mapped as follows: + + + SD_SYSUPDATE_OFFLINE → update + + -- 2.47.3