Commit graph

603 commits

Author SHA1 Message Date
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
Simon McVittie
e9762e1542 Document that dbus-launch is not dbus-run-session
Architectural assumptions inside dbus-launch mean that it is unsuitable
for use in contexts where a particular process's lifetime defines the
session, unless there is an out-of-band mechanism (like the X server)
which can signal the end of the session.

Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-15 13:10:41 +01:00
Simon McVittie
ba433723f7 dbus-launch: revise recommendations and put them in an EXAMPLES section
The first thing we should talk about is how to get a D-Bus session in
your X session - that's the common case.

Secondarily, we can tell command-line addicts how to have a D-Bus session.
Do not recommend --exit-with-session here, since that polls (and reads
from) stdin, which is harmful to precisely those command-line users!
Until we have some better tool, the best we can do here is note that
the dbus-daemon is not automatically terminated.

Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-15 13:10:30 +01:00
Simon McVittie
fcc656d430 dbus-launch: add --exit-with-x11 option
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.

Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-15 13:10:16 +01:00
Simon McVittie
8f7e9cdd60 Fix distcheck with newer Doxygen: remove *.js, too, during uninstall 2012-06-05 13:29:11 +01:00
Simon McVittie
a183a33fb5 Merge remote-tracking branch 'alban/own_prefix2'
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=46273
2012-03-27 15:05:56 +01:00
Alban Crequy
97c11fe286 doc: update documentation with own_prefix policy rules
https://bugs.freedesktop.org/show_bug.cgi?id=46886
2012-03-22 11:28:58 +00: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
John Bradshaw
b328fee69b Fix spelling errors in dbus-launch(1)
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=47076
Bug-Fedora: https://bugzilla.redhat.com/show_bug.cgi?id=675491
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-03-12 13:53:05 +00:00
Simon McVittie
64e0cbe129 Prepare 1.5.10 2012-02-21 17:03:14 +00:00
Simon McVittie
2e15443744 dbus-send.1: document --reply-timeout
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-14 16:16:01 +00:00
Simon McVittie
666344fc67 dbus-send.1, dbus-send: document --print-reply=literal consistently
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-14 16:15:59 +00:00
Simon McVittie
f5c7892c66 dbus-send.1: use bold and italic type consistently
According to man-pages(7)

* bold is for literal text, the name of the thing being documented,
  or the name of another man page

* italic is for replaceable text, usually in all-caps

* normal type (in the SYNOPSIS) is for special syntax like the []
  indicating optional things

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-14 16:15:42 +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
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