[tracker] libtracker-miner: Add migration docs

[Carlos Garnacho <carlosg src gnome org>]

commit 4c4feabcd67173c06fff82abf64a16ec5087d67e
Author: Carlos Garnacho <carlosg gnome org>
Date:   Mon Aug 7 12:10:57 2017 +0200

    libtracker-miner: Add migration docs

 docs/reference/libtracker-miner/Makefile.am        |    2 +-
 .../libtracker-miner/libtracker-miner-docs.sgml    |    1 +
 docs/reference/libtracker-miner/meson.build        |    2 +-
 docs/reference/libtracker-miner/migrating-1to2.xml |   73 ++++++++++++++++++++
 4 files changed, 76 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/libtracker-miner/Makefile.am b/docs/reference/libtracker-miner/Makefile.am
index c98e417..250f10c 100644
--- a/docs/reference/libtracker-miner/Makefile.am
+++ b/docs/reference/libtracker-miner/Makefile.am
@@ -58,7 +58,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 overview.sgml
+content_files = version.xml overview.sgml migrating-1to2.xml
 
 expand_content_files =
 
diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml 
b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
index fc5986a..5dbfe47 100644
--- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
+++ b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml
@@ -51,5 +51,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-miner/meson.build b/docs/reference/libtracker-miner/meson.build
index 7af9972..f3cda1a 100644
--- a/docs/reference/libtracker-miner/meson.build
+++ b/docs/reference/libtracker-miner/meson.build
@@ -5,5 +5,5 @@ version_xml = configure_file(input: 'version.xml.in',
 gnome.gtkdoc('libtracker-miner',
     src_dir: 'src/libtracker-miner',
     main_sgml: 'libtracker-miner-docs.sgml',
-    content_files: 'overview.sgml',
+    content_files: ['overview.sgml', 'migrating-1to2.xml'],
     install: true)
diff --git a/docs/reference/libtracker-miner/migrating-1to2.xml 
b/docs/reference/libtracker-miner/migrating-1to2.xml
new file mode 100644
index 0000000..6538d2a
--- /dev/null
+++ b/docs/reference/libtracker-miner/migrating-1to2.xml
@@ -0,0 +1,73 @@
+<?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-miner 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>TrackerMiner instances do not implement org.freedesktop.Tracker1.Miner</title>
+    <para>
+      TrackerMiner abstract classes have been made useful for situations where
+      there is a local connection (e.g. no interaction with tracker-store).
+      In order to expose TrackerMiner implementations through the traditional
+      org.freedesktop.Tracker1.Miner DBus interface, you must now create a
+      TrackerMinerProxy for it.
+    </para>
+  </section>
+
+  <section>
+    <title>No TrackerEnumerator</title>
+    <para>
+      TrackerDataProvider implementations now use the GFileEnumerator interface
+      from GLib in order to iterate across a tree of uniquely identified
+      resources. If you implemented a TrackerEnumerator, it must be converted
+      into a GFileEnumerator interface implementation. No further instructions
+      are provided as the API almost matches 1:1.
+    </para>
+  </section>
+
+  <section>
+    <title>No tracker_miner_fs_get_parent_urn()</title>
+    <para>
+      Use tracker_miner_fs_get_urn().
+    </para>
+  </section>
+
+  <section>
+    <title>No tracker_miner_fs_force_recheck()</title>
+    <para>
+      Use tracker_indexing_tree_notify_updated().
+    </para>
+  </section>
+
+  <section>
+    <title>No tracker_miner_fs_force_recheck() or tracker_miner_fs_force_mtime_checking()</title>
+    <para>
+      Use tracker_indexing_tree_notify_updated().
+    </para>
+  </section>
+
+  <section>
+    <title>No tracker_miner_fs_check_directory*()</title>
+    <para>
+      Use tracker_indexing_tree_add().
+    </para>
+  </section>
+
+  <section>
+    <title>No tracker_miner_fs_writeback_notify() and tracker_miner_fs_file_notify()</title>
+    <para>
+      You can now use tracker_miner_fs_notify_finish() to notify the end of both operations.
+    </para>
+  </section>
+</chapter>