Add warning about instability of D-Bus API
authorDavid King <david.king@canonical.com>
Wed, 24 Oct 2012 09:53:52 +0000 (10:53 +0100)
committerDavid King <david.king@canonical.com>
Wed, 24 Oct 2012 09:53:52 +0000 (10:53 +0100)
docs/reference/libsignon-glib-docs.xml

index 800c396ae90dfddc02bc0f0236ee435fad6d872f..5a1e63e0c6c4b6a70c251b598c7b62bfa792c87c 100644 (file)
 
   <part id="signond-dbus-api">
     <title>signond D-Bus API</title>
-      <xi:include href="../../libsignon-glib/sso-auth-service-gen-doc-com.google.code.AccountsSSO.SingleSignOn.AuthService.xml"/>
-      <xi:include href="../../libsignon-glib/sso-auth-session-gen-doc-com.google.code.AccountsSSO.SingleSignOn.AuthSession.xml"/>
-      <xi:include href="../../libsignon-glib/sso-identity-gen-doc-com.google.code.AccountsSSO.SingleSignOn.Identity.xml"/>
+
+    <partintro>
+      <para>
+      The signond D-Bus APIs are unstable, subject to change and should not be
+      used by client applications, which should use libsignon-glib or
+      libsignon-qt instead.
+      </para>
+    </partintro>
+
+    <xi:include href="../../libsignon-glib/sso-auth-service-gen-doc-com.google.code.AccountsSSO.SingleSignOn.AuthService.xml"/>
+    <xi:include href="../../libsignon-glib/sso-auth-session-gen-doc-com.google.code.AccountsSSO.SingleSignOn.AuthSession.xml"/>
+    <xi:include href="../../libsignon-glib/sso-identity-gen-doc-com.google.code.AccountsSSO.SingleSignOn.Identity.xml"/>
   </part>
 
   <part id="appendices">