[tracker] libtracker-control: Add migration docs

[Debarshi Ray <debarshir src gnome org>]

commit 214daa06e448a4e2de91ca46160cebfb9a828191
Author: Debarshi Ray <debarshir gnome org>
Date:   Tue Sep 5 12:15:29 2017 +0200

    libtracker-control: Add migration docs
    
    https://bugzilla.gnome.org/show_bug.cgi?id=787246

 docs/reference/libtracker-control/Makefile.am      |    2 +-
 .../libtracker-control-docs.sgml                   |    1 +
 docs/reference/libtracker-control/meson.build      |    1 +
 .../libtracker-control/migrating-1to2.xml          |   24 ++++++++++++++++++++
 4 files changed, 27 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/libtracker-control/Makefile.am b/docs/reference/libtracker-control/Makefile.am
index b2d9a38..41d82db 100644
--- a/docs/reference/libtracker-control/Makefile.am
+++ b/docs/reference/libtracker-control/Makefile.am
@@ -41,7 +41,7 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml
 MKHTML_OPTIONS=--path="$(abs_builddir)"
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files = version.xml
+content_files = version.xml migrating-1to2.xml
 
 expand_content_files =
 
diff --git a/docs/reference/libtracker-control/libtracker-control-docs.sgml 
b/docs/reference/libtracker-control/libtracker-control-docs.sgml
index 2db6352..31a581b 100644
--- a/docs/reference/libtracker-control/libtracker-control-docs.sgml
+++ b/docs/reference/libtracker-control/libtracker-control-docs.sgml
@@ -31,5 +31,6 @@
     </chapter>
   </part>
 
+  <xi:include href="migrating-1to2.xml"/>
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/docs/reference/libtracker-control/meson.build b/docs/reference/libtracker-control/meson.build
index b7cca19..659155d 100644
--- a/docs/reference/libtracker-control/meson.build
+++ b/docs/reference/libtracker-control/meson.build
@@ -5,4 +5,5 @@ version_xml = configure_file(input: 'version.xml.in',
 gnome.gtkdoc('libtracker-control',
     src_dir: 'src/libtracker-control',
     main_sgml: 'libtracker-control-docs.sgml',
+    content_files: ['migrating-1to2.xml'],
     install: true)
diff --git a/docs/reference/libtracker-control/migrating-1to2.xml 
b/docs/reference/libtracker-control/migrating-1to2.xml
new file mode 100644
index 0000000..75116bc
--- /dev/null
+++ b/docs/reference/libtracker-control/migrating-1to2.xml
@@ -0,0 +1,24 @@
+<?xml version='1.0'?>
+
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<chapter id="tracker-migrating-1-to-2">
+  <title>Migrating from libtracker-control 1.x to 2.0</title>
+
+  <para>
+    Tracker 2.0 is a new major version, containing some possibly
+    incompatible changes. Most of the changes are not hard to adapt,
+    and even unlikely to be a problem if the ported application was
+    kept up-to-date in its usage of 1.x.
+  </para>
+
+  <section>
+    <title>Cancellation support for tracker_miner_manager_index_file</title>
+    <para>
+      The tracker_miner_manager_index_file method now requires a GCancellable
+      argument. You can pass NULL if you don't want to specify one.
+    </para>
+  </section>
+</chapter>