agama/doc/dbus/bus
Martin Vidner 1a8cc8b73a Updated doc/dbus/bus/*.bus.xml
by running seed.sh in a testing_using_container.sh container

Really should do it more often (automatically) as it nicely detects
these API changes (commits found manually by me)

69ef2a0cda Manager.CollectLogs
c1f640e7f0 LocaleMixin
1860819faa Progress.Steps
69019564c9 Software1.ListRepositories
c37c01a9f0 Software1.SetUserPatterns
75f70d8b9c Software1.ProbeFinished
f29f4ab78a Issues.All
f29f4ab78a Locale.ListTimezones
2025-04-13 16:30:42 +02: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 Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +02:00
org.opensuse.Agama.Software1.bus.xml Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +02:00
org.opensuse.Agama.Software1.Product.bus.xml [service] Update D-Bus documentation 2023-10-20 16:08:28 +01: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 Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +02:00
org.opensuse.Agama.Storage1.DASD.Device.bus.xml doc(dbus): add documentation for the DASD-related interfaces 2024-08-07 15:06:46 +01:00
org.opensuse.Agama.Storage1.DASD.Manager.bus.xml doc(dbus): add documentation for the DASD-related interfaces 2024-08-07 15:06:46 +01:00
org.opensuse.Agama.Storage1.ISCSI.bus.xml storage: export separate D-Bus object for iSCSI 2025-04-09 12:18:16 +01:00
org.opensuse.Agama.Storage1.ISCSI.Initiator.bus.xml Add XML files for ISCSI-related interfaces 2024-05-08 15:36:23 +01:00
org.opensuse.Agama.Storage1.ISCSI.Node.bus.xml Add XML files for ISCSI-related interfaces 2024-05-08 15:36:23 +01:00
org.opensuse.Agama.Storage1.Proposal.bus.xml service: Update D-Bus documentation 2024-03-25 12:30:41 +00: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 Inconsequential changes in introspection XML 2025-04-12 13:20:48 +02:00
org.opensuse.Agama1.Locale.bus.xml Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +02:00
org.opensuse.Agama1.LocaleMixin.bus.xml Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +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 Updated doc/dbus/bus/*.bus.xml 2025-04-13 16:30:42 +02:00
org.opensuse.Agama1.Questions.Generic.bus.xml Inconsequential changes in introspection XML 2025-04-12 13:20:48 +02:00
org.opensuse.Agama1.Questions.WithPassword.bus.xml Inconsequential changes in introspection XML 2025-04-12 13:20:48 +02:00
org.opensuse.Agama1.Registration.bus.xml [service] Update D-Bus documentation 2023-10-20 16:08:28 +01:00
README.md Respect AGAMA_MAINFRAME_COSPLAY=1 to expose s390 D-Bus objects 2025-04-12 13:20:48 +02:00
seed.sh Remove network dbus leftovers 2025-03-25 17:21:47 +00: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. testing_using_container.sh, (cd doc/dbus/bus; ./seed.sh)

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_MAINFRAME_COSPLAY flag?