summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2017-07-28policy: Add max_fds, min_fds qualifiers for send, receive rulesSimon McVittie1-0/+20
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101848 Reviewed-by: Thiago Macieira <thiago@kde.org> [smcv: Revert an incorrect comment change] Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-07-28Add send_broadcast as an attribute of <allow> and <deny> elementsSimon McVittie1-0/+11
<allow send_broadcast="true" ...> only matches broadcasts, which are signals with a NULL destination. There was previously no way for the policy language to express "NULL destination", only "any destination". <allow send_broadcast="false" ...> only matches non-broadcasts, which are non-signals or signals with a non-NULL destination. There was previously no way for the policy language to express "any non-NULL destination", only "any destination". Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: improved documentation as per Philip's review] Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-07-28dbus-daemon(1): Document how send_* and receive_* work in generalSimon McVittie1-0/+26
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-07-28dbus-daemon(1): Be more truthful about the default policySimon McVittie1-3/+7
We don't allow sending unrequested replies, but the documentation implied that we did. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-07-28dbus-daemon(1): Clarify how user, group rules workSimon McVittie1-8/+12
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-07-28dbus-daemon(1): Actually document "own" rulesSimon McVittie1-0/+11
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-07-28dbus-daemon(1): Document the wildcard attribute value "*" more clearlySimon McVittie1-18/+29
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Thiago Macieira <thiago@kde.org> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=92853
2017-06-29spec: Update my email addressSimon McVittie1-1/+1
Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-06-29Start 1.11.16 developmentSimon McVittie1-4/+4
Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-06-291.11.14Simon McVittie1-3/+33
Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-06-29spec: Document versioning of eavesdrop='true'Simon McVittie1-0/+7
The wording and formatting used here is consistent with other semi-recently-added match keys. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
2017-06-29spec: Formally deprecate eavesdroppingSimon McVittie1-22/+42
Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: Wrap BecomeMonitor in <literal> as per Philip's review] Signed-off-by: Simon McVittie <smcv@collabora.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
2017-06-29spec: Do not promise match rules with eavesdrop='true' can be addedSimon McVittie1-6/+1
This is no longer true, and it seems less misleading to raise an error than to obey the letter of the spec by quietly ignoring calls from an inappropriate caller. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
2017-06-29Add unix:dir=/something addressesSimon McVittie1-6/+32
These are like unix:tmpdir=/something, except that the resulting socket is always path-based, never abstract. This is desirable for two reasons: * If a Linux container manager wants to expose a path-based socket into the container, it can do so by bind-mounting it in the container's filesystem namespace. That cannot work for abstract sockets because they are not files. * Conversely, if a Linux container manager does not want to expose a path-based socket in the container, it can avoid bind-mounting it, or bind-mount some harmless object like /dev/null over it. That cannot work for abstract sockets because access to abstract sockets is part of the network namespace, which is all-or-nothing. Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101567
2017-06-08spec: Document the Features and Interfaces properties on o.fd.DBusSimon McVittie1-0/+116
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101257
2017-06-08spec: Document the Peer and Properties interfaces for the message busSimon McVittie1-0/+8
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101257
2017-06-02spec: Document the canonical object path for the bus driverSimon McVittie1-1/+19
Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=101256
2017-05-31spec: Fix indentationTom Gundersen1-1/+1
[smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
2017-05-31spec: Re-word documentation of ListQueuedOwnersTom Gundersen1-3/+1
This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
2017-05-31spec: Re-word documentation of ReleaseNameTom Gundersen1-9/+7
This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
2017-05-31Spec: Re-word documentation of RequestNameTom Gundersen1-8/+6
This was previously written in an unusual message-passing-oriented style, which obscured the meaning. Use a more method-call-oriented style instead. [smcv: separated out from a larger commit, added commit message] Reviewed-by: Simon McVittie <smcv@collabora.com>
2017-05-31spec: Move ListQueuedOwners API description to list of methodsSimon McVittie1-56/+56
Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-05-31spec: Move ReleaseName API description to list of methodsSimon McVittie1-95/+95
Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-05-31spec: Move RequestName API description to list of methodsSimon McVittie1-240/+241
Tom Gundersen pointed out that RequestName, ReleaseName and ListQueuedOwners were documented in their own section instead of being put together with the other method calls, which makes it more difficult to apply changes consistently across all methods. I'm moving them one at a time to make the changes reviewable, since the diff resulting from moving all three as a unit is too large to review sensibly. Signed-off-by: Simon McVittie <smcv@collabora.com>
2017-04-18Ensure hyphen/minus is treated as literal in regexesSimon McVittie1-1/+1
Each U+002D HYPHEN-MINUS in [0-9A-Za-z_-/.\] is treated as a member of a range. The third one, which appears to have been intended to be a literal, is part of an empty range because the starting point U+005F LOW LINE is greater than the endpoint U+002F SOLIDUS, resulting in at least some grep implementations not considering U+002D, U+002F or U+005F to match the pattern. This resulted in one of the dbus-launch tests being unintentionally skipped when it used a regex based on the one in the spec. regex(7) suggests "To include a literal '-' [in a bracketed character set], make it the first or last character". Signed-off-by: Simon McVittie <smcv@collabora.com> Reviewed-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=100686
2017-02-24doc: Clarify /etc/dbus-1/system.d and /usr/share/dbus-1/system.dPhilip Withnall2-2/+8
The documentation generally only mentioned the directory in /etc, even though we actually prefer security policies to be installed in /usr/share to allow for stateless and volatile systems (i.e. booting up with an empty /etc). Signed-off-by: Philip Withnall <withnall@endlessm.com> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99901 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2017-02-21dbus-daemon(1): Describe how session and system services are foundSimon McVittie1-15/+177
For Unix, this partially duplicates the D-Bus Specification, but provides more detail about the intention of each search path element. It also documents the non-standardized path elements searched by the reference implementation. For Windows, there are no standardized path elements in the D-Bus Specification (and it isn't clear how useful it would be to standardize them, since Windows software that uses D-Bus tends to be installed as an integrated "stack" with a bundled copy of a suitable dbus-daemon), so we just document what the reference implementation does. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99825 Reviewed-by: Philip Withnall <withnall@endlessm.com> [smcv: fix formatting nitpicks] Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2017-02-21spec: Don't say implementation-specific locations must be lowest prioritySimon McVittie1-7/+3
We're treating transient services as higher-priority than those in the XDG_DATA_HOME or XDG_DATA_DIRS, which is consistent with systemd. The specific list used by the standard session dbus-daemon will be added to dbus-daemon(1) in the next commit. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=99825 Reviewed-by: Philip Withnall <withnall@endlessm.com> Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-11-29Start towards 1.11.10Simon McVittie1-2/+10
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-11-28dbus 1.11.8 and D-Bus Specification 0.30Simon McVittie1-2/+15
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-11-28Spec: document AppArmor mediation of auto-startingSimon McVittie1-0/+77
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98666
2016-11-22Spec: be clearer about "starting" and "activation" being synonymsSimon McVittie1-3/+8
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
2016-11-22spec: Clarify behaviour of o.f.D.P.GetAllPhilip Withnall1-0/+11
Clarify its intended behaviour in two situations: • For interfaces which have no properties. • Where some properties are not visible to the caller (due to access control, for example). The intention here is for this behaviour to be mandatory, but given that this is quite late on in the specification’s life, and various D-Bus libraries like dbus-glib and telepathy-glib cannot support access control at a per-property level, for example. GDBus can, although it’s questionable whether this is a good idea. Deliberately leave the specification open to allow access control at a higher level as well (such as per-(object, interface)). Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36190 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-11-22Spec: mostly use versioned interface and bus namesSimon McVittie1-18/+18
Using versioned names here reinforces the advice given in <https://dbus.freedesktop.org/doc/dbus-api-design.html#api-versioning>. I haven't added versions to the sample parameters "com.example.tea" and "com.example.cappuccino" for methods that query information about names, on the basis that I assume they are more likely to be intended to represent an implementation than an API. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
2016-11-22Spec: document systemd activationSimon McVittie1-0/+33
We didn't say that SystemdService existed. Now we do, together with enough context to make it make sense. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
2016-11-22Spec: document what auto-starting is, and recommend itSimon McVittie1-7/+47
For something we recommend, that is important enough to have its own header flag, it doesn't have very good documentation. Redo the text to suggest that auto-starting is the normal thing and StartServiceByName is the oddity. That's usually a good principle to follow, since it dodges time-of-check/time-of-use issues, and the method call that you presumably wanted to do needs to handle errors anyway. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
2016-11-22Spec: be clearer about what activation meansSimon McVittie1-3/+5
The spec previously mentioned that CORBA calls this activation, but did not explicitly say that D-Bus has copied this jargon term. It's 2016, and developers are probably more likely to be familiar with D-Bus than with CORBA at this point: explicitly say that *our* jargon term for this action is activation. Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Philip Withnall <philip.withnall@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=98671
2016-10-10Release 1.11.6 and spec 0.29Simon McVittie1-1/+10
Signed-off-by: Simon McVittie <smcv@debian.org>
2016-10-05doc: Install introspection and busconfig DTDsPhilip Withnall1-5/+6
Install them to $(datadir)/xml/dbus-1, which seems to be the standard location for installed DTDs. This means that developers can use them to validate their introspection XML, and sysadmins can use them to validate their bus configuration files. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=89011 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-10-03spec: Allow <annotation> in <arg> elements in introspection XMLPhilip Withnall3-2/+8
This is widely used in practice (especially by GLib — just look at files in /usr/share/dbus-1/interfaces/), and there is no reason not to allow it. Update the specification, introspection DTD and XSL file to allow and represent it. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=86162 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-10-03doc: Add missing space in introspect.xslPhilip Withnall1-1/+1
This adds a space in the output between ‘annotation’ and the key of the annotation. A Saturday afternoon cosmetic fix. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=86162 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-10-01spec: Recommend against using ‘/’ for object pathsPhilip Withnall1-0/+9
As discussed in http://0pointer.de/blog/projects/versioning-dbus.html and in https://dbus.freedesktop.org/doc/dbus-api-design.html, un-versioned object paths make it hard to work out which interface a signal was emitted from. Clarify this in the specification to try and avoid people making this mistake. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=37095 Reviewed-by: Simon McVittie <smcv@debian.org>
2016-09-30dbus-daemon: add --syslog, --nosyslog, --syslog-onlySimon McVittie1-1/+36
Like --fork and --nofork, these override what the configuration says. Use --syslog-only to force the systemd services to log to the Journal (via syslog, which means we see the severity metadata) instead of testing sd_booted() in the configuration implementation. Signed-off-by: Simon McVittie <smcv@debian.org>
2016-08-151.11.4Simon McVittie1-2/+8
2016-07-20dbus-launch: add --exit-with-x11 optionSimon McVittie1-7/+27
This is more suitable for distributions' Xsession scripts: it verifies that X is already available, and so never results in an attempt to poll stdin. We read the machine UUID because it is needed to set the X atoms. x11_init() assumes that the machine UUID (global variable) has been set, either via read_machine_uuid_if_needed() or save_machine_uuid(). This is pretty tangled, but to make The Right Thing happen automatically, we'd need to redo dbus-launch in terms of DBusError. Reviewed-by: Will Thompson Reviewed-by: Thiago Macieira Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197 Signed-off-by: Simon McVittie <smcv@debian.org>
2016-06-30spec: Clarify the marshaling format in a few minor waysPhilip Withnall1-11/+45
This is an attempt to make that section a little clearer. I don’t think any factual inaccuracies have been fixed (because I couldn’t find any). Including some wording and an example by Simon McVittie. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=93382 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2016-03-02Merge branch 'dbus-1.10'Simon McVittie1-2/+2
2016-03-02dbus-test-tool echo: fix sleep documentationDmitri Iouchtchenko1-2/+2
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=94244 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2015-12-021.11.0Simon McVittie1-6/+4
2015-11-07spec: trailing whitespace clean-upLennart Poettering1-238/+238
It's generally a good idea to avoid trailing whitespace in order to keep patchs minimal. While it's common to enforce such restrictions for C code, it's important for docbok XML files too. Hence, let's clean this up and remove all trailing whitespace currently in place. [By policy we do not clean up historical trailing whitespace and tab-indentation in the C source code unless we are modifying those lines anyway, to retain the ability to merge stable-branch bugfixes into the development branch. However, the copy of the spec in the development branch is the only one that receives any updates, so that concern doesn't apply here. -smcv] Bug: https://bugs.freedesktop.org/show_bug.cgi?id=91755
generated by cgit v1.2.3 (git 2.51.0) at 2026-08-22 01:14:34 +0000