-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
295 additions
and
147 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,4 +6,4 @@ all: | |
| cp index.html dist | ||
|
|
||
| check: | ||
| $(MAKE) -C dbus diff | ||
| $(MAKE) -C dbus check | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,22 @@ | ||
| FIXME: describe how to maintain these (semi)automatically | ||
| The `*.bus.xml` files here are produced by introspecting actual objects | ||
| exported by the Agama services. | ||
|
|
||
| The files are produced by `seed.sh`. | ||
| - FIXME: run it in CI. | ||
| - FIXME: make it easy to run it *and* commit the result to git. | ||
|
|
||
| Each file name represents a D-Bus **interface** that we want to document. | ||
| That is why some files have symlinks pointing to them (and why you see no | ||
| `org.freedesktop.DBus.*` filenames, we don't need to document those interfaces) | ||
|
|
||
| The interfaces implemented in Rust already have documentation in them | ||
| (courtesy of Rust macro magic) but it is not in the exact format that | ||
| `gdbus-codegen` understands :sob:. | ||
|
|
||
| You are expected to copy a new `foo.bus.xml` to `../foo.doc.xml`, remove the | ||
| `<interface>` elements other than `foo`, and add meaningful documentation. | ||
| Run `make check`. | ||
|
|
||
| FIXME: Storage1.ZFCP and Storage1.DASD needs an s390 machine to run, | ||
| we should expose them on x86 too (returning errors), perhaps guarded by an | ||
| `AGAMA_IGNORE_ARCH` flag? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 31 additions & 19 deletions
50
doc/dbus/bus/org.opensuse.Agama.Questions1.Generic.bus.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,49 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node name="/org/opensuse/Agama/Questions1/1"> | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="property_name" direction="in" type="s"/> | ||
| <arg name="value" direction="out" type="v"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="property_name" direction="in" type="s"/> | ||
| <arg name="val" direction="in" type="v"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="value" direction="out" type="a{sv}"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface" type="s"/> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.opensuse.Agama.Questions1.Generic"> | ||
| <property name="Answer" type="s" access="readwrite"/> | ||
| <property name="DefaultOption" type="s" access="read"/> | ||
| <property name="Id" type="u" access="read"/> | ||
| <property name="Options" type="as" access="read"/> | ||
| <property name="Text" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg name="xml_data" direction="out" type="s"/> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.opensuse.Agama.Questions1"> | ||
| <property type="u" name="Id" access="read"/> | ||
| <property type="s" name="Text" access="read"/> | ||
| <property type="as" name="Options" access="read"/> | ||
| <property type="s" name="DefaultOption" access="read"/> | ||
| <property type="s" name="Answer" access="readwrite"/> | ||
| </interface> | ||
| </node> | ||
|
|
62 changes: 37 additions & 25 deletions
62
doc/dbus/bus/org.opensuse.Agama.Questions1.LuksActivation.bus.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,53 @@ | ||
|
|
||
| <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node name="/org/opensuse/Agama/Questions1/2"> | ||
| "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> | ||
| <node> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Peer"> | ||
| <method name="Ping"> | ||
| </method> | ||
| <method name="GetMachineId"> | ||
| <arg type="s" direction="out"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.opensuse.Agama.Questions1.Generic"> | ||
| <property name="Answer" type="s" access="readwrite"/> | ||
| <property name="DefaultOption" type="s" access="read"/> | ||
| <property name="Id" type="u" access="read"/> | ||
| <property name="Options" type="as" access="read"/> | ||
| <property name="Text" type="s" access="read"/> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Properties"> | ||
| <method name="Get"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="property_name" direction="in" type="s"/> | ||
| <arg name="value" direction="out" type="v"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg type="v" direction="out"/> | ||
| </method> | ||
| <method name="Set"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="property_name" direction="in" type="s"/> | ||
| <arg name="val" direction="in" type="v"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg name="property_name" type="s" direction="in"/> | ||
| <arg name="value" type="v" direction="in"/> | ||
| </method> | ||
| <method name="GetAll"> | ||
| <arg name="interface_name" direction="in" type="s"/> | ||
| <arg name="value" direction="out" type="a{sv}"/> | ||
| <arg name="interface_name" type="s" direction="in"/> | ||
| <arg type="a{sv}" direction="out"/> | ||
| </method> | ||
| <!-- | ||
| Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal. | ||
| --> | ||
| <signal name="PropertiesChanged"> | ||
| <arg name="interface" type="s"/> | ||
| <arg name="interface_name" type="s"/> | ||
| <arg name="changed_properties" type="a{sv}"/> | ||
| <arg name="invalidated_properties" type="as"/> | ||
| </signal> | ||
| </interface> | ||
| <interface name="org.freedesktop.DBus.Introspectable"> | ||
| <method name="Introspect"> | ||
| <arg name="xml_data" direction="out" type="s"/> | ||
| </method> | ||
| </interface> | ||
| <interface name="org.opensuse.Agama.Questions1"> | ||
| <property type="u" name="Id" access="read"/> | ||
| <property type="s" name="Text" access="read"/> | ||
| <property type="as" name="Options" access="read"/> | ||
| <property type="s" name="DefaultOption" access="read"/> | ||
| <property type="s" name="Answer" access="readwrite"/> | ||
| </interface> | ||
| <interface name="org.opensuse.Agama.Questions1.LuksActivation"> | ||
| <property type="s" name="Password" access="readwrite"/> | ||
| <property type="u" name="Attempt" access="read"/> | ||
| <property name="Attempt" type="y" access="read"/> | ||
| <property name="Password" type="s" access="readwrite"/> | ||
| </interface> | ||
| </node> | ||
|
|
Oops, something went wrong.