Commit graph

388 commits

Author SHA1 Message Date
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
Lennart Poettering
a8423067ce bus: introduce --nopidfile switch to disable writing of PID files
When used with init systems such as systemd (where PID files are
redundant) this allows us to disable PID files even if a path is
configured for them in the normal bus configuration files.

Make use of this new switch in the systemd unit file.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=45520
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-10 10:07:24 +00:00
Simon McVittie
2a8be5a2f5 Merge branch 'dbus-1.4'
Conflicts:
	NEWS
2012-02-08 19:06:51 +00:00
Jack Nagel
336483a6cc docs: correctly invoke man2html
man2html expects to find its input on stdin, so just passing the
filename will cause it to hang waiting for input.

[man2html 1.6g as shipped in Debian seems to be fine with files on the
command line, but apparently other versions aren't? -smcv]

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=43875
2012-02-08 18:58:36 +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
5df8c3db12 Revert all changes since a36d4918a6
Someone seems to have merged part of master into 1.4. Again. Let's go
back to the "last known good" point (the branch-point of some 1.4
branches I had locally), then we can cherry-pick the changes that
should have gone in.
2012-01-04 17:44:23 +00:00
Simon McVittie
bf3d8259ac Merge branch 'dbus-1.4'
Conflicts:
	NEWS
2011-09-21 11:39:32 +01:00
Simon McVittie
f4c02e7829 Fix maintainer-upload-docs target to work out-of-tree
The STATIC_DOCS, DTDS and all dist_ files except XMLTO_OUTPUT are in the
source tree. The XMLTO_OUTPUT and the man2html output are in the build
tree, and the BONUS_FILES already have $(srcdir) in their names.

Also change the rules that generate the dbus-docs directory so that if
they fail, they leave behind a temporary directory, rather than leaving
behind a dbus-docs directory that causes make to not run those rules
if re-run; and change the rules to scp files to the server, to put a
trailing "/" on paths, ensuring that the tarball won't be uploaded as
"www" if the www directory doesn't already exist.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=41047
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-09-21 11:25:48 +01:00
Simon McVittie
6d4fe188e5 Merge branch 'dbus-1.4' 2011-08-15 10:26:48 +01:00
Chris Mayo
c82a83fb1b Install diagrams in htmldir
diagram.png and diagram.svg are linked from dbus-tutorial.html but recent
changes to doc/Makefile.am mean that if htmldir is set with configure they are
installed such that the relative link from dbus-tutorial.html does not work.

Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2011-08-15 10:23:04 +01: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
0d7318ccc7 Merge branch 'dbus-1.4' 2011-07-28 11:32:46 +01:00
Simon McVittie
4335a09280 man pages: replace all unescaped hyphen/minus characters with \-
In a man page, "-" officially means a typographical (Unicode) hyphen,
which frequently breaks the ability to copy and paste code examples from
a man page. "\-" means the ASCII hyphen/minus character. See
<http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html> for
more details.

Rather than trying to distinguish between hyphens, em-dashes and
hyphen/minus, I just replaced all ambiguous hyphens with \- by applying
this vim command repeatedly until it didn't find anything:

     %s/\(^\|[^\\]\)-/\1\\-/g

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38284
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2011-07-28 11:06:10 +01:00
Simon McVittie
feb31a3321 Merge branch 'dbus-1.4' and update NEWS for master
Conflicts:
	NEWS
2011-07-18 19:42:35 +01:00
Simon McVittie
693e2fc463 Uninstall the installed docs
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:52 +01:00
Simon McVittie
39b6b898c5 Install man2html output to $(htmldir)
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:47 +01:00
Simon McVittie
14dab0789e Install diagram.*, system-activation.txt to the $(docdir)
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:23 +01:00
Simon McVittie
53af0b903c Install xmlto output to $(htmldir) automatically
Also rename HTML_FILES to XMLTO_OUTPUT, as a more self-describing name:
we have other HTML files which are not the output from xmlto.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:24:15 +01:00
Simon McVittie
37cb1522fe Install dbus.devhelp to $(htmldir), not $(apidir), and remove it in clean
It needs to be in $(htmldir) so that its relative paths will work.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18 19:23:45 +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
9a28fa6a4e Merge branch 'dbus-1.4' 2011-04-12 11:27:09 +01:00
Simon McVittie
59c6663293 When uploading docs, use rsync -p to set permissions
It turns out that rsync --chmod means "pretend the source files had
already had this chmod operation applied to them", and not "chmod the
destination files" like you'd expect.

As a result, the -p (--perms) option is also needed, so that rsync will
"preserve" the modified permissions. Otherwise, the docs will not be
group-writeable as intended, and only the person who made the previous
upload will be able to upload them next time.

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36130
Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-04-12 11:26:49 +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