agama/doc/dbus/bus
2023-09-04 13:40:55 +01:00
..
cleanup-zbus.xslt doc/dbus: sort by interface when seeding 2023-07-14 15:38:39 +02:00
org.opensuse.Agama.Manager1.bus.xml Update the D-Bus documentation 2023-08-31 11:45:56 +01:00
org.opensuse.Agama.Network1.Connection.bus.xml Capitalize the 'Addresses' property in the docs 2023-07-04 15:53:11 +01:00
org.opensuse.Agama.Network1.Connection.IPv4.bus.xml doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02:00
org.opensuse.Agama.Network1.Connection.Wireless.bus.xml doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02:00
org.opensuse.Agama.Network1.Connections.bus.xml Update the org.opensuse.Agama.Network1 documentation 2023-07-04 15:22:54 +01:00
org.opensuse.Agama.Network1.Device.bus.xml Update the org.opensuse.Agama.Network1 documentation 2023-07-04 15:22:54 +01:00
org.opensuse.Agama.Network1.Devices.bus.xml Update the org.opensuse.Agama.Network1 documentation 2023-07-04 15:22:54 +01:00
org.opensuse.Agama.Software1.bus.xml doc/dbus/bus: adjusted the introspected files after seed.sh/cleanup() 2023-07-14 15:38:39 +02:00
org.opensuse.Agama.Software1.Proposal.bus.xml doc/dbus/bus: adjusted the introspected files after seed.sh/cleanup() 2023-07-14 15:38:39 +02:00
org.opensuse.Agama.Storage1.bus.xml Update D-Bus documentation 2023-08-24 14:11:21 +01:00
org.opensuse.Agama.Storage1.Proposal.bus.xml Update D-Bus documentation 2023-08-24 14:11:21 +01:00
org.opensuse.Agama.Storage1.Proposal.Calculator.bus.xml doc/dbus: each documented interface goes to a separate .doc.xml file 2023-08-24 15:40:31 +02:00
org.opensuse.Agama.Storage1.ZFCP.Controller.bus.xml [service] Extend zFCP D-Bus API 2023-06-15 15:29:45 +01:00
org.opensuse.Agama.Storage1.ZFCP.Disk.bus.xml [service] D-Bus API documentation 2023-06-12 16:36:03 +01:00
org.opensuse.Agama.Storage1.ZFCP.Manager.bus.xml doc/dbus: Storage1 2023-06-20 14:47:14 +02:00
org.opensuse.Agama.Users1.bus.xml doc/dbus/bus: adjusted the introspected files after seed.sh/cleanup() 2023-07-14 15:38:39 +02:00
org.opensuse.Agama1.Locale.bus.xml Update the D-Bus documentation 2023-08-31 11:45:56 +01:00
org.opensuse.Agama1.Manager.bus.xml doc/dbus/bus: adjusted the introspected files after seed.sh/cleanup() 2023-07-14 15:38:39 +02:00
org.opensuse.Agama1.Progress.bus.xml doc/dbus: Fix checks broken by previous PR 🤦 2023-05-11 17:09:56 +02:00
org.opensuse.Agama1.Questions.bus.xml Update the D-Bus documentation 2023-08-31 11:45:56 +01:00
org.opensuse.Agama1.Questions.Generic.bus.xml Update the D-Bus documentation 2023-08-31 11:45:56 +01:00
org.opensuse.Agama1.Questions.WithPassword.bus.xml Update the D-Bus documentation 2023-08-31 11:45:56 +01:00
org.opensuse.Agama1.ServiceStatus.bus.xml doc/dbus: Fix checks broken by previous PR 🤦 2023-05-11 17:09:56 +02:00
org.opensuse.Agama1.Validation.bus.xml doc/dbus: Fix checks broken by previous PR 🤦 2023-05-11 17:09:56 +02:00
README.md doc/dbus: better bus/README.md 2023-06-20 14:47:14 +02:00
seed.sh Update the D-Bus documentation 2023-08-31 11:45:56 +01:00

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 😭.

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?