diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-04-24 12:08:10 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-05-05 22:41:23 +0200 |
| commit | 48f99d7c069e07671e570161aecbe109af1285e0 (patch) | |
| tree | 42768a6ed1fd37707c24ca93bedc84bd28fc31c3 /man/org.freedesktop.import1.xml | |
| parent | c351d568c3ddf5a10231f9d5e8c9d7059292767c (diff) | |
| download | systemd-48f99d7c069e07671e570161aecbe109af1285e0.tar.gz | |
man: use --bus-introspect to autogenerate dbus api docs
This has the advantage that the executables are always in place and we don't
need any units to exist on the bus, so we can eventually hook this up into
a normal build system. (Probably as a build time check.)
Diffstat (limited to 'man/org.freedesktop.import1.xml')
| -rw-r--r-- | man/org.freedesktop.import1.xml | 34 |
1 files changed, 24 insertions, 10 deletions
diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml index 4a425f1ac3..1414cc15d7 100644 --- a/man/org.freedesktop.import1.xml +++ b/man/org.freedesktop.import1.xml @@ -46,11 +46,7 @@ <para>The service exposes the following interfaces on the Manager object on the bus:</para> - <programlisting> -$ gdbus introspect --system \ - --dest org.freedesktop.import1 \ - --object-path /org/freedesktop/import1 - + <programlisting executable="systemd-importd" node="/org/freedesktop/import1" interface="org.freedesktop.import1.Manager"> node /org/freedesktop/import1 { interface org.freedesktop.import1.Manager { methods: @@ -238,11 +234,7 @@ node /org/freedesktop/import1 { <refsect1> <title>The Transfer Object</title> - <programlisting> -$ gdbus introspect --system \ - --dest org.freedesktop.import1 \ - --object-path /org/freedesktop/import1/transfer/_1 - + <programlisting executable="systemd-importd" node="/org/freedesktop/import1/transfer/_1" interface="org.freedesktop.import1.Transfer"> node /org/freedesktop/import1/transfer/_1 { interface org.freedesktop.import1.Transfer { methods: @@ -326,6 +318,28 @@ node /org/freedesktop/import1/transfer/_1 { </refsect1> <refsect1> + <title>Examples</title> + + <example> + <title>Introspect <interfacename>org.freedesktop.import1.Manager</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system \ + --dest org.freedesktop.import1 \ + --object-path /org/freedesktop/import1 + </programlisting> + </example> + + <example> + <title>Introspect <interfacename>org.freedesktop.import1.Transfer</interfacename> on the bus</title> + + <programlisting>$ gdbus introspect --system \ + --dest org.freedesktop.import1 \ + --object-path /org/freedesktop/import1/transfer/_1 + </programlisting> + </example> + </refsect1> + + <refsect1> <title>Versioning</title> <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html"> |