Commit graph

140 commits

Author SHA1 Message Date
Simon McVittie
e33c318c13 NEWS 2012-08-09 12:42:52 +01:00
Colin Walters
88f8d44aed spec: Mention object path and interface name
We didn't actually have /org/freedesktop/DBus in the spec, nor did we
explicitly mention the existence of "org.freedesktop.DBus" as an
interface, although it is implicit in the method names.

https://bugs.freedesktop.org/show_bug.cgi?id=51865
2012-07-18 10:19:20 -04:00
Simon McVittie
04cb0a6b0b Describe how to marshal arrays, structs, dict-entries, variants in prose
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 14:03:31 +01:00
Simon McVittie
12f2bd641e Promote the marshalling format to a top-level section
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 14:03:28 +01:00
Simon McVittie
7b81cecae0 Promote the definition of valid object paths and signatures into the type system
Also remove the (double!) requirement that signatures be nul-terminated,
and turn it into a note about the marshalling format.

Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 14:03:21 +01:00
Simon McVittie
c8e7a5690b Define the fixed and string-like types a bit more formally
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 13:42:27 +01:00
Simon McVittie
7fd69d123f Don't claim that all basic types work like INT32: strings don't!
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 13:42:24 +01:00
Simon McVittie
7461c704b9 Define single complete types in the overview of the type system
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 13:42:20 +01:00
Simon McVittie
8624dbec2d Split Basic and Container types into subsections, promote "Type Signatures" to be an intro
The "Type Signatures" subsection is basically an introduction to the
type system, so it doesn't need a heading of its own.

Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
2012-06-15 13:42:12 +01:00
Lennart Poettering
552ca4d0ce spec: document unixexec transports
This adds a specification text for the new unixexec: transport.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35230
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-03-12 16:38:36 +00:00
Simon McVittie
64e0cbe129 Prepare 1.5.10 2012-02-21 17:03:14 +00:00
Lennart Poettering
6056a3d662 spec: document systemd transport
This adds a short section about the systemd transport to the
specification.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35232
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-10 13:44:20 +00:00
Simon McVittie
21c8094040 Merge branch 'system-search-paths-21620'
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=21620
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10 10:10:38 +00:00
Simon McVittie
349260f245 Merge branch 'doc-search-paths-35306'
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10 10:10:17 +00:00
Simon McVittie
818e62f15f Merge branch 'reversed-dns-37095'
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=37095
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10 10:09:38 +00:00
Simon McVittie
fccb5a0fe1 Explicitly don't search XDG_DATA_DIRS for system services, and document it
In practice, it never works, because the activation helper doesn't
respect environment variables for security reasons.
If you want to vary the search path, alter system.conf instead, to
replace or augment <standard_system_servicedirs/> with your preferred
search path.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=21620
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-08 16:11:35 +00:00
Simon McVittie
6b01c6cdfd spec: document how to install session .service files
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-08 15:46:37 +00:00
Simon McVittie
ae3faad91d spec: document the search path for session services
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306
2012-02-08 15:30:06 +00:00
Simon McVittie
33a77c8605 micro version 2011-07-29 17:20:55 +01:00
Simon McVittie
affd8a7d16 spec v0.18 and D-Bus 1.5.6 2011-07-29 16:46:38 +01:00
Simon McVittie
7afd5e97ce spec: mention that buses may have a security policy, but leave it implementation-specific
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450
Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29 16:32:03 +01:00
Simon McVittie
713f31fae5 Move the explanation of message routing to the Message Routing section, leaving behind a summary
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450
Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29 16:32:03 +01:00
Simon McVittie
755a52a316 Define eavesdropping, and document the eavesdrop match
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450
Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29 16:31:48 +01:00
Simon McVittie
8de8646311 spec: define unicast messages and broadcast signals, and explicitly allow unicast signals
I believe that the wording of the spec has always allowed unicast signals,
but most bindings assume that signals are broadcasts, so it seems worth
saying specifically that this feature exists and can be useful.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450
Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29 16:30:48 +01:00
Simon McVittie
80989477dd spec: make the Match Rules section true again
The spec previously claimed that only messages matching the client's
match rules would be received. This is not actually true: messages
listing a client as their DESTINATION are always delivered (security
policy permitting).

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450
Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29 16:29:49 +01:00
Simon McVittie
23cb3ecad3 Upgrade the type system into its own top-level section of the spec
The type system can be used independently, for instance in GVariant
(although GVariant's binary encoding is in fact not the same).

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2011-07-28 12:18:50 +01:00
Simon McVittie
cc24576b5a Finalize D-Bus Spec 0.17, update lists of authors 2011-06-01 12:19:26 +01:00
Simon McVittie
8acb6d685b fix verb-subject agreement in ObjectManager spec 2011-05-25 15:25:45 +01:00
David Zeuthen
d1812812af Add org.freedesktop.DBus.ObjectManager interface
The org.freedesktop.DBus.ObjectManager provides a standardized and
efficient way of keeping one or more tree of objects synchronized
between one server and several clients.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34869
Signed-off-by: David Zeuthen <davidz@redhat.com>
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2011-05-25 15:24:32 +01:00
Simon McVittie
5cbd607e51 Cross-reference from the glossary to interface names etc. 2011-05-17 17:10:56 +01:00
Simon McVittie
1909039b19 Describe best practices for property names, and recommend against dash-separated-words
Related to <https://bugs.freedesktop.org/show_bug.cgi?id=20948> whose
conclusion seemed to be that anything is allowed, but CamelCase is
considerably more interoperable.
2011-05-17 17:10:36 +01:00
Simon McVittie
f0f67e4329 Remove the old, vague Naming Conventions section
The defining instance of each namespaced term now contains notes on
conventional naming.
2011-05-17 17:07:34 +01:00
Simon McVittie
dd2b63e6e1 Briefly mention why to namespace object-paths 2011-05-17 17:06:46 +01:00
Simon McVittie
cd279fd3c5 Describe conventional naming of errors 2011-05-17 17:06:30 +01:00
Simon McVittie
977c7a7c4a Describe conventional naming of methods and signals 2011-05-17 17:06:21 +01:00
Simon McVittie
6213a3d897 Describe best-practices for naming well-known bus names 2011-05-17 17:06:06 +01:00
Simon McVittie
fc87e251bc Formally define a unique connection name and a well-known bus name 2011-05-17 17:05:39 +01:00
Simon McVittie
cf32940b2a Write about best-practices for interface names in the same place they're defined
I'm deliberately using a hypothetical API from example.com, rather
than a real API, to avoid perpetuating these over-simplifications any
further than they've spread already:

- "namespaces start with org.freedesktop"
- "namespaces start with org"
- "interfaces are defined by their sole implementation"
- "services have one object implementing one interface"
- "interfaces always behave like classes"
- "interfaces are always noun phrases"
- "there is a freedesktop.org D-Bus API for screensavers"
2011-05-17 17:04:39 +01:00
Simon McVittie
f8ae29fd4e Clarify that 'r' and 'e' cannot appear in signatures
Reviewed-by: Colin Walters <walters@verbum.org>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34529
2011-04-27 18:00:51 +01:00
Simon McVittie
840314724b Reserve 'm', '*', '?', '@', '&' and '^' for their uses in GVariant
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34529
Reviewed-by: Colin Walters <walters@verbum.org>
2011-04-27 18:00:18 +01:00
Simon McVittie
9ddd3ae25c Development version: 1.5.1, dbus-specification 0.17 2011-04-11 19:04:30 +01:00
Simon McVittie
968dbab087 Prepare 1.5.0
- D-Bus Specification 0.16
- libtool 9:0:6
2011-04-11 13:34:28 +01:00
Simon McVittie
c4b76acc6b Merge branch 'dbus-1.4'
Conflicts:
	NEWS
2011-04-08 15:23:17 +01:00
Simon McVittie
aa009ba18b oops, fix XML mis-nesting 2011-04-07 18:27:52 +01:00
Sven Herzberg
136b8b8c86 list which parts of the Desktop Entry spec apply to service files
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=19159
2011-04-07 18:26:17 +01:00
Simon McVittie
b92f2224bf Remove support for trailing "." on arg0namespace 2011-04-07 16:12:35 +01:00
Simon McVittie
97bf0b2b48 Rename path_prefix to path_namespace and disallow trailing '/'
Also disallow having both path and path_namespace in the same match rule
(it wouldn't make sense, path is more specific than path_namespace).

As per IRC discussion with davidz and wjt.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34870
2011-04-07 16:12:22 +01:00
Simon McVittie
a9f76f20a0 Document when arg0namespace was added, for completeness 2011-04-07 15:27:01 +01:00
Simon McVittie
4d6c5afbc0 Document when argNpath was added, for completeness 2011-04-07 15:26:49 +01:00
Simon McVittie
976b7a7956 specification: fix versioning
We've added things since 0.15, so this isn't still 0.15.
2011-04-07 15:04:48 +01:00