dbus/doc
Simon McVittie bafb2c455d spec: Have a sect2 per interface documented for the message bus
Previously, we arbitrarily divided o.fd.DBus into "messages"
(methods and signals), in one sect2, and Properties, in another sect2;
and for the only extended interface that is documented so far,
o.fd.DBus.Monitoring, we included its single method in the list of
o.fd.DBus methods.

This is putting too much weight on implementation details of how the
D-Bus protocol is implemented (with Properties being "less core" than
methods and signals), and not enough weight on how interfaces are
conceptually structured. It's more usual to group together all aspects
of an interface into one document or section, and the current arbitrary
separation is going to look more and more odd as we start documenting
more interfaces like Containers (dbus!449), Stats and Verbose.

Instead, repurpose the "Message Bus Messages" section to become the
documentation for the o.fd.DBus interface, and introduce a separate
section for each other interface that the message bus provides.
Each one contains a full list of methods, signals and properties (if any)
if it is specific to the message bus, or a cross-reference to a more
generic interface description if it is equally applicable to the message
bus and its clients.

Prompted by discussion on dbus!449.

Signed-off-by: Simon McVittie <smcv@collabora.com>
2024-10-01 14:41:06 +00:00
..
.gitignore .gitignore: Normalize into LC_ALL=C sort order 2018-12-14 12:53:08 +00:00
busconfig.dtd Add apparmor element and attributes to the bus config dtd 2015-02-18 17:03:56 +00:00
catalog.xml.in doc: Introduce XML catalog 2022-02-21 14:01:20 +00:00
CMakeLists.txt cmake: install api docs in html subdir 2024-09-27 17:51:40 +02:00
dbus-api-design.duck doc/dbus-api-design: Replace D-Feet with d-spy 2024-05-10 12:07:09 +02:00
dbus-cleanup-sockets.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-daemon.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-faq.xml Unify docbook dtd version to 4.4. 2013-04-19 12:40:01 +01:00
dbus-launch.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-monitor.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-run-session.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-send.1.xml.in Document the return value of dbus-send tool. 2024-05-27 15:24:18 +00:00
dbus-specification.xml spec: Have a sect2 per interface documented for the message bus 2024-10-01 14:41:06 +00:00
dbus-test-plan.xml Rename bus-test to test-bus to match common test application naming scheme. 2014-01-17 16:29:37 +00:00
dbus-test-tool.1.xml.in doc: Repeat a copyright notice in a form understood by SPDX tools 2023-08-14 16:58:21 +01:00
dbus-tutorial.xml dbus-tutorial: replace the entire GLib section with "use GDBus" 2014-10-29 14:15:53 +00:00
dbus-update-activation-environment.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dbus-uuidgen.1.xml.in doc: Use https URLs for home page and AUTHORS 2022-05-18 16:05:31 +00:00
dcop-howto.txt initial import of "dbus" skeleton 2002-11-21 16:41:33 +00:00
diagram.png 2005-01-18 Havoc Pennington <hp@redhat.com> 2005-01-18 20:42:15 +00:00
diagram.svg 2005-01-18 Havoc Pennington <hp@redhat.com> 2005-01-18 20:42:15 +00:00
doxygen_to_devhelp.xsl doxygen_to_devhelp: Produce Devhelp index format v2 2018-04-23 17:44:09 +01:00
file-boilerplate.c Add SPDX license marker for the AFL-2.1 OR GPL-2.0-or-later license 2023-01-04 07:53:44 +00:00
index.html.in cmake: Inclusion of a link in html overview file corrected 2024-04-16 09:53:59 +02:00
introspect.dtd spec: Allow <annotation> in <arg> elements in introspection XML 2016-10-03 11:33:47 +01:00
introspect.xsl Add SPDX license marker for the AFL-2.1 OR GPL-2.0-or-later license 2023-01-04 07:53:44 +00:00
list-doc-source.py doc: avoid Python injection if filenames contain quotes 2022-07-13 20:36:13 +01:00
maintainer-upload-docs.sh maint: Make maintainer-upload-docs.sh executable 2022-09-22 13:52:38 +01:00
meson.build Add SPDX license tags for the MIT (Expat) license, where straightforward 2023-08-14 17:18:04 +00:00
meson_post_install.py meson: Install Doxygen docs as api/html/*.html 2024-10-01 14:39:20 +00:00
system-activation.txt doc: Clarify /etc/dbus-1/system.d and /usr/share/dbus-1/system.d 2017-02-24 18:34:22 +00:00
TODO 2006-11-08 Havoc Pennington <hp@redhat.com> 2006-11-09 00:19:29 +00:00