summaryrefslogtreecommitdiffstats
path: root/man/org.freedesktop.import1.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-04-10 15:07:03 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-04-16 19:46:40 +0200
commit4fb222c4b29ec2a1a451a1e0e99c5d3c520395ab (patch)
tree3e6aa4abceca3f4b93070d71e5c902828c28bbdd /man/org.freedesktop.import1.xml
parentupdate-dbus-docs: add support for settings printing just one selected interface (diff)
downloadsystemd-4fb222c4b29ec2a1a451a1e0e99c5d3c520395ab.tar.xz
systemd-4fb222c4b29ec2a1a451a1e0e99c5d3c520395ab.zip
man: run dbus api docs through the updater
This replaces the api export tables with updated versions, and inserts comments for all "undocumented" items. The slow work of documented them is left for later ;) lxml does some formatting changes that are not significant for lxml processing, but generate spurious difference in the diff (namely: ulinks become one-line, and double quotes are used instead of single quotes for element attribute values). This should be a one-time thing: subsequent renegeration should be idempotent with regards to this.
Diffstat (limited to 'man/org.freedesktop.import1.xml')
-rw-r--r--man/org.freedesktop.import1.xml52
1 files changed, 31 insertions, 21 deletions
diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml
index 9c8498ff7f..6a628f4671 100644
--- a/man/org.freedesktop.import1.xml
+++ b/man/org.freedesktop.import1.xml
@@ -66,6 +66,12 @@ node /org/freedesktop/import1 {
in b read_only,
out u transfer_id,
out o transfer_path);
+ ImportFileSystem(in h fd,
+ in s local_name,
+ in b force,
+ in b read_only,
+ out u transfer_id,
+ out o transfer_path);
ExportTar(in s local_name,
in h fd,
in s format,
@@ -88,7 +94,7 @@ node /org/freedesktop/import1 {
in b force,
out u transfer_id,
out o transfer_path);
- ListTransfers(out a(usssdo) list);
+ ListTransfers(out a(usssdo) transfers);
CancelTransfer(in u transfer_id);
signals:
TransferNew(u transfer_id,
@@ -97,14 +103,13 @@ node /org/freedesktop/import1 {
o transfer_path,
s result);
};
- interface org.freedesktop.DBus.Peer {
- };
- interface org.freedesktop.DBus.Introspectable {
- };
- interface org.freedesktop.DBus.Properties {
- };
+ interface org.freedesktop.DBus.Peer { ... };
+ interface org.freedesktop.DBus.Introspectable { ... };
+ interface org.freedesktop.DBus.Properties { ... };
};
-</programlisting>
+ </programlisting>
+
+ <!--method ImportFileSystem is not documented!-->
<refsect2>
<title>Methods</title>
@@ -215,21 +220,26 @@ node /org/freedesktop/import1/transfer/_1 {
LogMessage(u priority,
s line);
properties:
- readonly u Id = 1;
- readonly s Local = 'xenial-server-cloudimg-amd64-root';
- readonly s Remote = 'https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-root.tar.gz';
- readonly s Type = 'pull-tar';
- readonly s Verify = 'signature';
- readonly d Progress = 0.253;
- };
- interface org.freedesktop.DBus.Peer {
- };
- interface org.freedesktop.DBus.Introspectable {
- };
- interface org.freedesktop.DBus.Properties {
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
+ readonly u Id = ...;
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
+ readonly s Local = '...';
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
+ readonly s Remote = '...';
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
+ readonly s Type = '...';
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
+ readonly s Verify = '...';
+ @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
+ readonly d Progress = ...;
};
+ interface org.freedesktop.DBus.Peer { ... };
+ interface org.freedesktop.DBus.Introspectable { ... };
+ interface org.freedesktop.DBus.Properties { ... };
};
-</programlisting>
+ </programlisting>
+
+ <!--signal LogMessage is not documented!-->
<refsect2>
<title>Methods</title>