summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2010-05-26 12:55:08 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2010-05-26 12:55:08 +0100
commitd13fa422bdfdda5d6c040fd63f5b5fcb187b0857 (patch)
tree39d6db0ce70d43f9bf52fe8732e06f6a26694a89 /README
parent795ce3b4c1d3fecdad026edc4a8dc3999c7cdfa7 (diff)
downloadtelepathy-mission-control-d13fa422bdfdda5d6c040fd63f5b5fcb187b0857.tar.gz
Update README
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 20 insertions, 20 deletions
diff --git a/README b/README
index d6d25471..fe20bc46 100644
--- a/README
+++ b/README
@@ -23,9 +23,6 @@ including instant messaging, voice calls and video calls. It abstracts
differences between protocols to provide a unified interface for
applications.
-Mission Control currently also provides a C API. Please note that this API is
-subject to rapid change (see below).
-
Requirements
============
@@ -54,7 +51,7 @@ Bugs, feature requests and to-do list
=====================================
Report all bugs, feature requests and "to-do" items here:
- <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=telepathy-mission-control>
+ <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=mission-control>
D-Bus API stability
===================
@@ -69,28 +66,31 @@ extensions) are subject to change.
C API stability
===============
-libmcclient is a client library for communicating with Mission Control. It
-is not necessarily suitable for communication with any other Telepathy
-AccountManager or ChannelDispatcher implementations, and will probably be
-phased out eventually, in favour of library support in telepathy-glib.
+The mission-control-plugins library introduced in Mission Control 5.5.0
+contains a C API for plugins. All plugins should be compiled and linked
+against this library by using the CFLAGS and LIBS from
+mission-control-plugins.pc, and installed in the directory given by this
+pkg-config query:
+
+ pkg-config --variable=plugindir mission-control-plugins
+
+Incompatible changes in this library's public API/ABI will be avoided whenever
+possible. The API and ABI versions can be retrieved with these pkg-config
+queries:
-libmissioncontrol-server contains most of the implementation of MC, and can
-be used to produce a derivative of MC containing desktop- or device-specific
-behaviour, like Maemo's proprietary osso-mission-control package. It is only
-built and installed as a library if Mission Control is configured with
-the --enable-mcd-plugins option; this is not recommended on mainstream Linux
-distributions.
+ pkg-config --variable=MCP_API_VERSION mission-control-plugins
+ pkg-config --variable=MCP_ABI_VERSION mission-control-plugins
-At this stage in development, neither library is considered stable; only
-depend on them if you have control over the specific version of MC you're
-using.
+The older libmcclient and libmissioncontrol-server have no API or ABI
+guarantees, and should not generally be used at all. Since version 5.5.0,
+their headers are not installed by default.
Versioning
==========
-Starting from version 5.1.0, Mission Control follows the same Linux-style
-odd/even minor versioning policy as most other Telepathy components: the 5.1.x
-series are development releases, and 5.2.x will be the first stable branch.
+Mission Control follows the same Linux-style odd/even minor versioning policy
+as most other Telepathy components: for instance, the 5.1.x series were
+development releases leading to the 5.2.x stable branch.
Intermediate versions built from the git repository have a "+" suffix on the
version number, so version "5.1.0+" could be any snapshot taken between 5.1.0