summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Still recommend --exit-with-session in documentation, --exit-with-x11 was ↵Simon McVittie2012-06-271-4/+4
| | | | reverted
* Revert "dbus-launch: add --exit-with-x11 option"Simon McVittie2012-06-271-20/+6
| | | | This reverts commit fcc656d430f53ad62c25e41d7e7bd880cbb726a0.
* Document that dbus-launch is not dbus-run-sessionSimon McVittie2012-06-151-0/+13
| | | | | | | | | | 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
* dbus-launch: revise recommendations and put them in an EXAMPLES sectionSimon McVittie2012-06-151-17/+32
| | | | | | | | | | | | | | 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
* dbus-launch: add --exit-with-x11 optionSimon McVittie2012-06-151-6/+20
| | | | | | | | | 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
* Fix distcheck with newer Doxygen: remove *.js, too, during uninstalldbus-1.6.0Simon McVittie2012-06-051-0/+1
|
* Merge remote-tracking branch 'alban/own_prefix2'Simon McVittie2012-03-271-0/+10
|\ | | | | | | | | Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=46273
| * doc: update documentation with own_prefix policy rulesAlban Crequy2012-03-221-0/+10
| | | | | | | | https://bugs.freedesktop.org/show_bug.cgi?id=46886
* | spec: document unixexec transportsLennart Poettering2012-03-121-3/+64
| | | | | | | | | | | | | | 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>
* | Fix spelling errors in dbus-launch(1)John Bradshaw2012-03-121-2/+2
|/ | | | | | 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>
* Prepare 1.5.10dbus-1.5.10Simon McVittie2012-02-211-1/+10
|
* dbus-send.1: document --reply-timeoutSimon McVittie2012-02-141-0/+5
| | | | | | 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>
* dbus-send.1, dbus-send: document --print-reply=literal consistentlySimon McVittie2012-02-141-2/+8
| | | | | | 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>
* dbus-send.1: use bold and italic type consistentlySimon McVittie2012-02-141-15/+18
| | | | | | | | | | | | | | | | 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>
* spec: document systemd transportLennart Poettering2012-02-101-2/+23
| | | | | | | | 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>
* Merge branch 'system-search-paths-21620'Simon McVittie2012-02-101-1/+26
|\ | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=21620 Reviewed-by: Lennart Poettering <lennart@poettering.net>
| * Explicitly don't search XDG_DATA_DIRS for system services, and document itSimon McVittie2012-02-081-1/+26
| | | | | | | | | | | | | | | | | | | | | | 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>
* | Merge branch 'doc-search-paths-35306'Simon McVittie2012-02-101-3/+19
|\ \ | |/ | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306 Reviewed-by: Lennart Poettering <lennart@poettering.net>
| * spec: document how to install session .service filesSimon McVittie2012-02-081-0/+9
| | | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
| * spec: document the search path for session servicesSimon McVittie2012-02-081-3/+10
| | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306
* | Merge branch 'reversed-dns-37095'Simon McVittie2012-02-101-25/+125
|\ \ | | | | | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=37095 Reviewed-by: Lennart Poettering <lennart@poettering.net>
| * | Cross-reference from the glossary to interface names etc.Simon McVittie2011-05-171-4/+13
| | |
| * | Describe best practices for property names, and recommend against ↵Simon McVittie2011-05-171-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | 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.
| * | Remove the old, vague Naming Conventions sectionSimon McVittie2011-05-171-16/+0
| | | | | | | | | | | | | | | The defining instance of each namespaced term now contains notes on conventional naming.
| * | Briefly mention why to namespace object-pathsSimon McVittie2011-05-171-1/+21
| | |
| * | Describe conventional naming of errorsSimon McVittie2011-05-171-0/+11
| | |
| * | Describe conventional naming of methods and signalsSimon McVittie2011-05-171-0/+8
| | |
| * | Describe best-practices for naming well-known bus namesSimon McVittie2011-05-171-0/+25
| | |
| * | Formally define a unique connection name and a well-known bus nameSimon McVittie2011-05-171-4/+5
| | |
| * | Write about best-practices for interface names in the same place they're definedSimon McVittie2011-05-171-0/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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"
* | | bus: introduce --nopidfile switch to disable writing of PID filesLennart Poettering2012-02-101-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge branch 'dbus-1.4'Simon McVittie2012-02-081-1/+1
|\ \ \ | |_|/ |/| | | | | | | | Conflicts: NEWS
| * | docs: correctly invoke man2htmlJack Nagel2012-02-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * | Revert all changes since a36d4918a6f646e085Simon McVittie2012-01-041-461/+77
|/ / | | | | | | | | | | | | 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.
* | Merge branch 'dbus-1.4'Simon McVittie2011-09-211-14/+25
|\ \ | | | | | | | | | | | | Conflicts: NEWS
| * | Fix maintainer-upload-docs target to work out-of-treeSimon McVittie2011-09-211-14/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge branch 'dbus-1.4'Simon McVittie2011-08-151-7/+7
|\ \ \ | |/ /
| * | Install diagrams in htmldirChris Mayo2011-08-151-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | micro versionSimon McVittie2011-07-291-2/+2
| | |
* | | spec v0.18 and D-Bus 1.5.6dbus-1.5.6Simon McVittie2011-07-291-1/+8
| | |
* | | spec: mention that buses may have a security policy, but leave it ↵Simon McVittie2011-07-291-0/+8
| | | | | | | | | | | | | | | | | | | | | implementation-specific Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
* | | Move the explanation of message routing to the Message Routing section, ↵Simon McVittie2011-07-291-52/+56
| | | | | | | | | | | | | | | | | | | | | leaving behind a summary Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
* | | Define eavesdropping, and document the eavesdrop matchSimon McVittie2011-07-291-0/+60
| | | | | | | | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
* | | spec: define unicast messages and broadcast signals, and explicitly allow ↵Simon McVittie2011-07-291-3/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | spec: make the Match Rules section true againSimon McVittie2011-07-291-8/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Upgrade the type system into its own top-level section of the specSimon McVittie2011-07-281-19/+30
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge branch 'dbus-1.4'Simon McVittie2011-07-286-217/+217
|\ \ \ | |/ /
| * | man pages: replace all unescaped hyphen/minus characters with \-Simon McVittie2011-07-286-217/+217
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge branch 'dbus-1.4' and update NEWS for masterSimon McVittie2011-07-181-13/+21
|\ \ \ | |/ / | | | | | | | | | Conflicts: NEWS
| * | Uninstall the installed docsSimon McVittie2011-07-181-0/+4
| | | | | | | | | | | | | | | Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
View Lorry Controller Status