agama/doc/dbus/bus
Martin Vidner 367bade42c doc/dbus: better bus/README.md
[skip CI]
2023-06-20 14:47:14 +02:00
..
org.opensuse.Agama.Locale1.bus.xml doc/dbus/bus: update .bus.xml 2023-06-20 14:38:51 +02:00
org.opensuse.Agama.Network1.Connection.bus.xml doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02: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 doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02:00
org.opensuse.Agama.Network1.Device.bus.xml doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02:00
org.opensuse.Agama.Network1.Devices.bus.xml doc/dbus: seeded introspection XML for Network1.* 2023-05-29 16:17:25 +02:00
org.opensuse.Agama.Questions1.bus.xml doc/dbus/bus: Questions1.Generic now properly declared 2023-06-20 14:38:51 +02:00
org.opensuse.Agama.Questions1.Generic.bus.xml doc/dbus/bus: Questions1.Generic now properly declared 2023-06-20 14:38:51 +02:00
org.opensuse.Agama.Questions1.LuksActivation.bus.xml doc/dbus/bus: Questions1.Generic now properly declared 2023-06-20 14:38:51 +02:00
org.opensuse.Agama.Software1.bus.xml doc/dbus: make diff passes; seeded more interfaces 2023-04-06 14:35:13 +02:00
org.opensuse.Agama.Software1.Proposal.bus.xml doc/dbus: make diff passes; seeded more interfaces 2023-04-06 14:35:13 +02:00
org.opensuse.Agama.Storage1.bus.xml [service] Extend zFCP D-Bus API 2023-06-15 15:29:45 +01: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: make diff passes; seeded more interfaces 2023-04-06 14:35:13 +02:00
org.opensuse.Agama1.Manager.bus.xml doc/dbus/bus: Agama1.Manager +Finish +IguanaBackend 2023-06-20 14:38:51 +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.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 doc/dbus/bus: adjust seeding Questions from Rust 2023-06-20 14:38:51 +02: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?