From 17f573ed026f0790cc305a407e69bb1e9a424e41 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Thu, 11 Jun 2009 17:59:28 +0200 Subject: Doc: Added information about QDBUS_DEBUG to the D-Bus documentation. Task-number: 253715 Reviewed-by: Trust Me --- doc/src/introtodbus.qdoc | 19 ++++++++++++++++++- doc/src/snippets/code/doc_src_introtodbus.qdoc | 5 +++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/src/introtodbus.qdoc b/doc/src/introtodbus.qdoc index 71c65d5..1edc6eb 100644 --- a/doc/src/introtodbus.qdoc +++ b/doc/src/introtodbus.qdoc @@ -198,7 +198,24 @@ \row \o Interface \o Plugin identifier \o Dot-separated \endtable - \section2 Further Reading + \section1 Debugging + + When developing applications that use D-Bus, it is sometimes useful to be able + to see information about the messages that are sent and received across the + bus by each application. + + This feature can be enabled on a per-application basis by setting the + \c QDBUS_DEBUG environment variable before running each application. + For example, we can enable debugging only for the car in the + \l{Remote Controlled Car Example} by running the controller and the + car in the following way: + + \snippet doc/src/snippets/code/doc_src_introtodbus.qdoc QDBUS_DEBUG + + Information about the messages will be written to the console the application + was launched from. + + \section1 Further Reading The following documents contain information about Qt's D-Bus integration features, and provide details about the mechanisms used to send and receive diff --git a/doc/src/snippets/code/doc_src_introtodbus.qdoc b/doc/src/snippets/code/doc_src_introtodbus.qdoc index bedfe7f..97b14e9 100644 --- a/doc/src/snippets/code/doc_src_introtodbus.qdoc +++ b/doc/src/snippets/code/doc_src_introtodbus.qdoc @@ -1,3 +1,8 @@ //! [0] org.freedesktop.DBus //! [0] + +//! [QDBUS_DEBUG] +examples/dbus/remotecontrolledcar/controller/controller & +QDBUS_DEBUG=1 examples/dbus/remotecontrolledcar/car/car & +//! [QDBUS_DEBUG] -- cgit v0.12