summaryrefslogtreecommitdiff
path: root/man/org.freedesktop.portable1.xml
diff options
context:
space:
mode:
authorLuca Boccassi <luca.boccassi@microsoft.com>2022-01-24 17:42:32 +0000
committerYu Watanabe <watanabe.yu+github@gmail.com>2022-01-25 06:44:27 +0900
commit0017415cc5f2b97e0f9812cb10984c364d4e03bc (patch)
tree44255fcca46106648ce515269f765e05310fd4ec /man/org.freedesktop.portable1.xml
parent9697662915e47a4797b05003cb1970fe2b01e530 (diff)
downloadsystemd-0017415cc5f2b97e0f9812cb10984c364d4e03bc.tar.gz
portable: add GetImageStateWithExtensions method
Allow to correctly query a layered portable service for attached/detached state.
Diffstat (limited to 'man/org.freedesktop.portable1.xml')
-rw-r--r--man/org.freedesktop.portable1.xml19
1 files changed, 19 insertions, 0 deletions
diff --git a/man/org.freedesktop.portable1.xml b/man/org.freedesktop.portable1.xml
index 53c960206e..a63b6aeebe 100644
--- a/man/org.freedesktop.portable1.xml
+++ b/man/org.freedesktop.portable1.xml
@@ -57,6 +57,10 @@ node /org/freedesktop/portable1 {
out a{say} units);
GetImageState(in s image,
out s state);
+ GetImageStateWithExtensions(in s image,
+ in as extensions,
+ in t flags,
+ out s state);
AttachImage(in s image,
in as matches,
in s profile,
@@ -132,6 +136,8 @@ node /org/freedesktop/portable1 {
<variablelist class="dbus-method" generated="True" extra-ref="GetImageState()"/>
+ <variablelist class="dbus-method" generated="True" extra-ref="GetImageStateWithExtensions()"/>
+
<variablelist class="dbus-method" generated="True" extra-ref="AttachImage()"/>
<variablelist class="dbus-method" generated="True" extra-ref="AttachImageWithExtensions()"/>
@@ -207,6 +213,12 @@ node /org/freedesktop/portable1 {
<listitem><para>running-runtime</para></listitem>
</itemizedlist></para>
+ <para><function>GetImageStateWithExtensions()</function> is a superset of
+ <function>GetImageState()</function>, with additional support for a list of extensions
+ as input parameters, which is necessary to query the state in case the image was attached
+ in that particular way. The <varname>flag</varname> parameter is currently unused and
+ reserved for future purposes.</para>
+
<para><function>AttachImage()</function> attaches a portable image to the system.
This method takes an image path or name, a list of strings that will be used to search for
unit files inside the image (partial or complete matches), a string indicating which
@@ -334,6 +346,9 @@ node /org/freedesktop/portable1 {
out ay os_release,
out a{say} units);
GetState(out s state);
+ GetStateWithExtensions(in as extensions,
+ in t flags,
+ out s state);
Attach(in as matches,
in s profile,
in b runtime,
@@ -402,6 +417,8 @@ node /org/freedesktop/portable1 {
<!--method GetState is not documented!-->
+ <!--method GetStateWithExtensions is not documented!-->
+
<!--method Attach is not documented!-->
<!--method AttachWithExtensions is not documented!-->
@@ -434,6 +451,8 @@ node /org/freedesktop/portable1 {
<variablelist class="dbus-method" generated="True" extra-ref="GetState()"/>
+ <variablelist class="dbus-method" generated="True" extra-ref="GetStateWithExtensions()"/>
+
<variablelist class="dbus-method" generated="True" extra-ref="Attach()"/>
<variablelist class="dbus-method" generated="True" extra-ref="AttachWithExtensions()"/>