Merge branch 'master' into ioq-docs

Author: janl

src/api/database/find.rst

@@ -756,7 +756,9 @@ the database performs a full scan of the primary index:
     in production.
 
 Most selector expressions work exactly as you would expect for the given
-operator.
+operator. But it is not always the case: for example, comparison of strings is
+done with ICU and can can give surprising results if you were expecting ASCII
+ordering. See :ref:`views/collation` for more details.
 
 .. _find/sort:
 

src/api/server/common.rst

@@ -1045,6 +1045,9 @@ error.
                     documents and ``_active_tasks`` to get a complete state
                     summary
 
+.. versionchanged:: 3.0.0 In error states the `"info"` field switched
+                    from being a string to being an object
+
 .. http:get:: /_scheduler/docs
     :synopsis: Retrieve information about replication documents from the
                ``_replicator`` database.
@@ -1074,9 +1077,10 @@ error.
     :>json string target: Replication target
     :>json string start_time: Timestamp of when the replication was started
     :>json string last_update: Timestamp of last state update
-    :>json object info: May contain additional information about the state.
-                        For error states, this will be a string. For success
-                        states this will contain a JSON object (see below).
+    :>json object info: Will contain additional information about the
+                        state. For errors, this will be an object with
+                        an `"error"` field and string value. For
+                        success states, see below.
     :>json number error_count: Consecutive errors count. Indicates how many
                                times in a row this replication has crashed.
                                Replication will be retried with an exponential
@@ -1210,9 +1214,10 @@ error.
     :>json string target: Replication target
     :>json string start_time: Timestamp of when the replication was started
     :>json string last_update: Timestamp of last state update
-    :>json object info: May contain additional information about the state.
-                        For error states, this will be a string. For success
-                        states this will contain a JSON object (see below).
+    :>json object info: Will contain additional information about the
+                        state. For errors, this will be an object with
+                        an `"error"` field and string value. For
+                        success states, see below.
     :>json number error_count: Consecutive errors count. Indicates how many
                                times in a row this replication has crashed.
                                Replication will be retried with an exponential
@@ -1311,9 +1316,10 @@ error.
     :>json string target: Replication target
     :>json string start_time: Timestamp of when the replication was started
     :>json string last_update: Timestamp of last state update
-    :>json object info: May contain additional information about the state.
-                        For error states, this will be a string. For success
-                        states this will contain a JSON object (see below).
+    :>json object info: Will contain additional information about the
+                        state. For errors, this will be an object with
+                        an `"error"` field and string value. For
+                        success states, see below.
     :>json number error_count: Consecutive errors count. Indicates how many
                                times in a row this replication has crashed.
                                Replication will be retried with an exponential

src/replication/index.rst

@@ -16,16 +16,16 @@
 Replication
 ===========
 
-The replication is an incremental one way process involving two databases
+Replication is an incremental one way process involving two databases
 (a source and a destination).
 
-The aim of the replication is that at the end of the process, all active
-documents on the source database are also in the destination database and all
-documents that were deleted in the source databases are also deleted (if exists)
-on the destination database.
+The aim of replication is that at the end of the process, all active
+documents in the source database are also in the destination database
+and all documents that were deleted in the source database are also
+deleted in the destination database (if they even existed).
 
 The replication process only copies the last revision of a document, so all
-previous revisions that were only on the source database are not copied to the
+previous revisions that were only in the source database are not copied to the
 destination database.
 
 .. toctree::

src/replication/intro.rst

@@ -21,16 +21,16 @@ database. This enables users to distribute data across several nodes or
 data centers, but also to move data more closely to clients.
 
 Replication involves a source and a destination database, which can be on the
-same or on different CouchDB instances. The aim of the replication is that at
-the end of the process, all active documents on the source database are also in
+same or on different CouchDB instances. The aim of replication is that at
+the end of the process, all active documents in the source database are also in
 the destination database and all documents that were deleted in the source
-databases are also deleted on the destination database (if they even existed).
+database are also deleted in the destination database (if they even existed).
 
-Transient and Persistant Replication
+Transient and Persistent Replication
 ====================================
 
 There are two different ways to set up a replication. The first one that was
-introduced into CouchDB leads do a replication that could be called `transient`.
+introduced into CouchDB leads to a replication that could be called `transient`.
 Transient means that there are no documents backing up the replication. So after a
 restart of the CouchDB server the replication will disapear. Later, the
 :ref:`_replicator <replicator>` database was introduced, which keeps documents

src/replication/replicator.rst

@@ -207,7 +207,9 @@ crashes with an increasingly larger interval. The ``history`` list from
           "doc_id": "my_rep_crashing",
           "error_count": 6,
           "id": "cb78391640ed34e9578e638d9bb00e44+create_target",
-          "info": "db_not_found: could not open http://adm:*****@localhost:5984/missing/",
+          "info": {
+               "error": "db_not_found: could not open http://adm:*****@localhost:5984/missing/"
+          },
           "last_updated": "2017-04-05T20:55:10Z",
           "node": "node1@127.0.0.1",
           "source_proxy": null,
@@ -263,7 +265,9 @@ exactly why it failed:
             "doc_id": "my_rep_dup",
             "error_count": 1,
             "id": null,
-            "info": "Replication `a81a78e822837e66df423d54279c15fe+continuous+create_target` specified by document `my_rep_dup` already started, triggered by document `my_rep` from db `_replicator`",
+            "info": {
+                "error": "Replication `a81a78e822837e66df423d54279c15fe+continuous+create_target` specified by document `my_rep_dup` already started, triggered by document `my_rep` from db `_replicator`"
+            },
             "last_updated": "2017-04-05T21:41:51Z",
             "source": "http://myserver.com/foo/",
             "start_time": "2017-04-05T21:41:51Z",