flimzy commented on a change in pull request #177: Add 2.1.1 release notes
URL:
https://github.com/apache/couchdb-documentation/pull/177#discussion_r145612098
##########
File path: src/whatsnew/2.1.rst
##########
@@ -20,11 +20,162 @@
:depth: 1
:local:
+.. _release/2.1.x/upgrade:
+
+Upgrade Notes
+=============
+
+* The deprecated (and broken) OAuth 1.0 implementation has been removed.
+
+* If user code reads or manipulates replicator document states,
+ consider using the ``[replicator] update_docs = true`` compatibility
+ parameter. In that case replicator will continue updating documents
+ with transient replication states. However, that will incure a
+ performance cost. Consider instead switching using
+ ``_scheduler/docs`` HTTP endpoint.
+
+* The ``stale`` parameter for views and ``_find`` has been deprecated in favour
+ of two new parameters: ``stable`` and ``update``. The old ``stale=ok``
+ behaviour is equivalent to ``stable=true&update=false``, and the old
+ ``stale=update_after`` behaviour is equivalent to
``stable=true&update=lazy``.
+ The deprecated ``stale`` parameter will be removed in CouchDB 3.0.
+
+* The ``[couchdb] max_document_size`` configuration parameter was renamed
+ to ``[httpd] max_http_request_size`` to reflect its actual implementation.
+ It has been enhanced by a new ``[couchdb] single_max_doc_size`` setting.
+ Both are documented in the shipped ``default.ini`` file.
+
+.. _release/2.1.1:
+
+Version 2.1.1
+=============
+
+General
+-------
+
+* :ghissue:`617`: CouchDB now supports compilation and running under Erlang/OTP
+ 20.x.
+
+* :ghissue:``: The ``couch_peruser`` functionality is now *really* fixed.
+ Really.
+
+* :ghissue:`827`: The cookie domain for AuthSession cookies, used in a
+ proxy authentication configuration, can now be customized via the ini file.
+
+* :ghissue:`858`: It is now possible to modify shard maps for system databases.
+
+* :ghissue:`732`: Due to an Erlang bug (ERL-343), invalid paths can be
+ returned if volumes are mounted containing whitespace in their name. This
+ problem surfaced primarily on macOS (Time Machine volumes). CouchDB now
+ works around this bug in unpatched versions of Erlang by skipping the free
+ space check performed by the compaction daemon. Erlang itself will
+ correctly perform free space checks in version 21.0.
+
+* The Dockerfile in the source repository has been retired. For a current
+ Dockerfile, see the ``couchdb-docker`` repository.
+
+Performance
+-----------
+
+* :ghissue:`835`: CouchDB now no longer decompresses documents just to
+ determine their uncompressed size. In tests, this has lead to improvements
+ between 10-40% in both CPU and wall-clock time for database compaction.
+
+* The design document cache (``ddoc_cache``) has been rewritten to improve
+ performance.
+
+Mango
+-----
+
+* :ghissue:`740`: Mango queries can now be paginated. Each query response
+ includes a bookmark. The bookmark can be provided on a subsequent query to
+ continue from a specific key.
+
+* :ghissue:`768`: Mango ``_find`` accepts an ``execution_stats``
+ parameter. If present, a new object is included in the response which
+ contains information about the query executed. The object contains the
+ count of total keys examined (0 for json indexes), total documents
+ examined (when ``include_docs=true`` is used), and the total quorum
+ documents examined (when fabric doc lookups are used).
+
+* :ghissue:`816` and :ghissue:`866`: Mango now requires that all of the fields
+ in a candidate index must exist in a query's selector. Previously, this check
+ was incorrect, and indexes that might only contain a subset of valid
+ documents might be selected by the query planner if an explicit index was not
+ specified at query time. Further, if a sort field is specified at query time,
+ that field needs to exist (but could be null) in the results returned.
+
+Other
+-----
+
+The 2.1.1 release also includes the following minor improvements:
+
+ * :ghissue:`635`: Stop couch_index processes on ddoc update
+ * :ghissue:`721`: Save migrated replicator checkpoint documents immediately
+ * :ghissue:`688`: Reuse http-based replicatoin checkpoints when upgrading
Review comment:
s/replicatoin/replication/
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
