summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2015-02-09 13:38:27 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2015-02-09 15:52:10 +0000
commit82ca3f62848b72061bf041df529bea58e53d55e7 (patch)
tree0da102b06ec0e1599eea13136a5f926fda044b1d
parent983ea5ae211dcac80007cc8ef2b3be0aad35ecb1 (diff)
doc: Make the deprecation warning bigger
Make the deprecation warning in the documentation introduction bigger. Add a copy of it to the front page of the documentation too, which is what people see when they first find the documentation online.
-rw-r--r--doc/reference/dbus-glib-docs.sgml27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/reference/dbus-glib-docs.sgml b/doc/reference/dbus-glib-docs.sgml
index de21d16..c434c02 100644
--- a/doc/reference/dbus-glib-docs.sgml
+++ b/doc/reference/dbus-glib-docs.sgml
@@ -10,6 +10,17 @@
<releaseinfo>for version &version;</releaseinfo>
</bookinfo>
+ <warning>
+ <para>dbus-glib is a deprecated API for use of D-Bus from GLib
+ applications. Do not use it in new code.</para>
+
+ <para>Since version 2.26, GLib's accompanying GIO library
+ provides a high-level API for D-Bus, "GDBus", based on an
+ independent reimplementation of the D-Bus protocol. The maintainers
+ of D-Bus recommend that GLib applications should use GDBus
+ instead of dbus-glib.</para>
+ </warning>
+
<chapter>
<title>Introduction</title>
@@ -19,14 +30,16 @@
http://www.freedesktop.org/wiki/Software/dbus</ulink>.
</para>
- <para>dbus-glib is a deprecated API for use of D-Bus from GLib
- applications. Do not use it in new code.</para>
+ <warning>
+ <para>dbus-glib is a deprecated API for use of D-Bus from GLib
+ applications. Do not use it in new code.</para>
- <para>Since version 2.26, GLib's accompanying GIO library
- provides a high-level API for D-Bus, "GDBus", based on an
- independent reimplementation of the D-Bus protocol. The maintainers
- of D-Bus recommend that GLib applications should use GDBus
- instead of dbus-glib.</para>
+ <para>Since version 2.26, GLib's accompanying GIO library
+ provides a high-level API for D-Bus, "GDBus", based on an
+ independent reimplementation of the D-Bus protocol. The maintainers
+ of D-Bus recommend that GLib applications should use GDBus
+ instead of dbus-glib.</para>
+ </warning>
</chapter>
<chapter>