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.machine1.xml | |
| parent | update-dbus-docs: use executables in build/ (diff) | |
| download | systemd-48f99d7c069e07671e570161aecbe109af1285e0.tar.xz systemd-48f99d7c069e07671e570161aecbe109af1285e0.zip | |
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.machine1.xml')
| -rw-r--r-- | man/org.freedesktop.machine1.xml | 36 |
1 files changed, 26 insertions, 10 deletions
diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index bc9779c521..c18e133e7c 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -34,11 +34,7 @@ <para>The service exposes the following interfaces on the Manager object on the bus:</para> - <programlisting> -$ gdbus introspect --system \ - --dest org.freedesktop.machine1 \ - --object-path /org/freedesktop/machine1 - + <programlisting executable="systemd-machined" node="/org/freedesktop/machine1" interface="org.freedesktop.machine1.Manager"> node /org/freedesktop/machine1 { interface org.freedesktop.machine1.Manager { methods: @@ -435,11 +431,7 @@ node /org/freedesktop/machine1 { <refsect1> <title>Machine Objects</title> - <programlisting> -$ gdbus introspect --system \ - --dest org.freedesktop.machine1 \ - --object-path /org/freedesktop/machine1/machine/rawhide - + <programlisting executable="systemd-machined" node="/org/freedesktop/machine1/machine/rawhide" interface="org.freedesktop.machine1.Machine"> node /org/freedesktop/machine1/machine/rawhide { interface org.freedesktop.machine1.Machine { methods: @@ -618,6 +610,30 @@ node /org/freedesktop/machine1/machine/rawhide { </refsect1> <refsect1> + <title>Examples</title> + + <example> + <title>Introspect <interfacename>org.freedesktop.machine1.Manager</interfacename> on the bus</title> + + <programlisting> +$ gdbus introspect --system \ + --dest org.freedesktop.machine1 \ + --object-path /org/freedesktop/machine1 + </programlisting> + </example> + + <example> + <title>Introspect <interfacename>org.freedesktop.machine1.Machine</interfacename> on the bus</title> + + <programlisting> +$ gdbus introspect --system \ + --dest org.freedesktop.machine1 \ + --object-path /org/freedesktop/machine1/machine/rawhide + </programlisting> + </example> + </refsect1> + + <refsect1> <title>Versioning</title> <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html"> |