README

   1 Sections in this file describe:
   2  - introduction and overview
   3  - low-level vs. high-level API
   4  - version numbers
   5  - options to the configure script
   6  - ABI stability policy
   7
   8 Introduction
   9 ===
  10
  11 D-Bus is a simple system for interprocess communication and coordination.
  12
  13 The "and coordination" part is important; D-Bus provides a bus daemon that does things like:
  14  - notify applications when other apps exit
  15  - start services on demand
  16  - support single-instance applications
  17
  18 See http://www.freedesktop.org/software/dbus/ for lots of documentation,
  19 mailing lists, etc.
  20
  21 See also the file HACKING for notes of interest to developers working on D-Bus.
  22
  23 If you're considering D-Bus for use in a project, you should be aware
  24 that D-Bus was designed for a couple of specific use cases, a "system
  25 bus" and a "desktop session bus." These are documented in more detail
  26 in the D-Bus specification and FAQ available on the web site.
  27
  28 If your use-case isn't one of these, D-Bus may still be useful, but
  29 only by accident; so you should evaluate carefully whether D-Bus makes
  30 sense for your project.
  31
  32 Security
  33 ==
  34
  35 If you find a security vulnerability that is not known to the public,
  36 please report it privately to dbus-security@lists.freedesktop.org
  37 or by reporting a freedesktop.org bug that is marked as
  38 restricted to the "D-BUS security group" (you might need to "Show
  39 Advanced Fields" to have that option).
  40
  41 On Unix systems, the system bus (dbus-daemon --system) is designed
  42 to be a security boundary between users with different privileges.
  43
  44 On Unix systems, the session bus (dbus-daemon --session) is designed
  45 to be used by a single user, and only accessible by that user.
  46
  47 We do not currently consider D-Bus on Windows to be security-supported,
  48 and we do not recommend allowing untrusted users to access Windows
  49 D-Bus via TCP.
  50
  51 Note: low-level API vs. high-level binding APIs
  52 ===
  53
  54 A core concept of the D-Bus implementation is that "libdbus" is
  55 intended to be a low-level API. Most programmers are intended to use
  56 the bindings to GLib, Qt, Python, Mono, Java, or whatever. These
  57 bindings have varying levels of completeness and are maintained as
  58 separate projects from the main D-Bus package. The main D-Bus package
  59 contains the low-level libdbus, the bus daemon, and a few command-line
  60 tools such as dbus-launch.
  61
  62 If you use the low-level API directly, you're signing up for some
  63 pain. Think of the low-level API as analogous to Xlib or GDI, and the
  64 high-level API as analogous to Qt/GTK+/HTML.
  65
  66 Version numbers
  67 ===
  68
  69 D-Bus uses the common "Linux kernel" versioning system, where
  70 even-numbered minor versions are stable and odd-numbered minor
  71 versions are development snapshots.
  72
  73 So for example, development snapshots: 1.1.1, 1.1.2, 1.1.3, 1.3.4
  74 Stable versions: 1.0, 1.0.1, 1.0.2, 1.2.1, 1.2.3
  75
  76 All pre-1.0 versions were development snapshots.
  77
  78 Development snapshots make no ABI stability guarantees for new ABI
  79 introduced since the last stable release. Development snapshots are
  80 likely to have more bugs than stable releases, obviously.
  81
  82 Configuration
  83 ===
  84
  85 dbus could be build by using autotools or cmake.
  86
  87 When using autotools the configure step is initiated by running ./configure
  88 with or without additional configuration flags. dbus requires GNU Make
  89 (on BSD systems, this is typically called gmake) or a "make" implementation
  90 with compatible extensions.
  91
  92 When using cmake the configure step is initiated by running the cmake
  93 program with or without additional configuration flags.
  94
  95 Configuration flags
  96 ===
  97
  98 When using autotools, run "./configure --help" to see the possible
  99 configuration options and environment variables.
 100
 101 When using cmake, inspect README.cmake to see the possible
 102 configuration options and environment variables.
 103
 104 API/ABI Policy
 105 ===
 106
 107 Now that D-Bus has reached version 1.0, the objective is that all
 108 applications dynamically linked to libdbus will continue working
 109 indefinitely with the most recent system and session bus daemons.
 110
 111  - The protocol will never be broken again; any message bus should
 112    work with any client forever. However, extensions are possible
 113    where the protocol is extensible.
 114
 115  - If the library API is modified incompatibly, we will rename it
 116    as in http://ometer.com/parallel.html - in other words,
 117    it will always be possible to compile against and use the older
 118    API, and apps will always get the API they expect.
 119
 120 Interfaces can and probably will be _added_. This means both new
 121 functions and types in libdbus, and new methods exported to
 122 applications by the bus daemon.
 123
 124 The above policy is intended to make D-Bus as API-stable as other
 125 widely-used libraries (such as GTK+, Qt, Xlib, or your favorite
 126 example). If you have questions or concerns they are very welcome on
 127 the D-Bus mailing list.
 128
 129 NOTE ABOUT DEVELOPMENT SNAPSHOTS AND VERSIONING
 130
 131 Odd-numbered minor releases (1.1.x, 1.3.x, 2.1.x, etc. -
 132 major.minor.micro) are devel snapshots for testing, and any new ABI
 133 they introduce relative to the last stable version is subject to
 134 change during the development cycle.
 135
 136 Any ABI found in a stable release, however, is frozen.
 137
 138 ABI will not be added in a stable series if we can help it. i.e. the
 139 ABI of 1.2.0 and 1.2.5 you can expect to be the same, while the ABI of
 140 1.4.x may add more stuff not found in 1.2.x.
 141
 142 NOTE ABOUT STATIC LINKING
 143
 144 We are not yet firmly freezing all runtime dependencies of the libdbus
 145 library. For example, the library may read certain files as part of
 146 its implementation, and these files may move around between versions.
 147
 148 As a result, we don't yet recommend statically linking to
 149 libdbus. Also, reimplementations of the protocol from scratch might
 150 have to work to stay in sync with how libdbus behaves.
 151
 152 To lock things down and declare static linking and reimplementation to
 153 be safe, we'd like to see all the internal dependencies of libdbus
 154 (for example, files read) well-documented in the specification, and
 155 we'd like to have a high degree of confidence that these dependencies
 156 are supportable over the long term and extensible where required.
 157
 158 NOTE ABOUT HIGH-LEVEL BINDINGS
 159
 160 Note that the high-level bindings are _separate projects_ from the
 161 main D-Bus package, and have their own release cycles, levels of
 162 maturity, and ABI stability policies. Please consult the documentation
 163 for your binding.
 164
 165 Bootstrapping D-Bus on new platforms
 166 ===
 167
 168 A full build of D-Bus, with all regression tests enabled and run, has some
 169 dependencies which themselves depend on D-Bus, either for compilation or
 170 for some of *their* regression tests: GLib, dbus-glib and dbus-python are
 171 currently affected.
 172
 173 To avoid circular dependencies, when bootstrapping D-Bus for the first time
 174 on a new OS or CPU architecture, you can either cross-compile some of
 175 those components, or choose the build order and options carefully:
 176
 177 * build and install D-Bus without tests
 178   - do not use the --enable-modular-tests=yes configure option
 179   - do not use the --enable-tests=yes configure option
 180 * build and install GLib, again without tests
 181 * use those versions of libdbus and GLib to build and install dbus-glib
 182 * ... and use those to install dbus-python
 183 * rebuild libdbus; this time you can run all of the tests
 184 * rebuild GLib; this time you can run all of the tests