[couchdb-documentation] branch master updated: Fix stale options (#585)

[rn...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rnewson pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git


The following commit(s) were added to refs/heads/master by this push:
     new 0d8a0d5  Fix stale options (#585)
0d8a0d5 is described below

commit 0d8a0d5b34c76ebc4b8f3e4b2ebbb02c5172cae4
Author: Bessenyei Balázs Donát <be...@users.noreply.github.com>
AuthorDate: Mon Sep 7 13:40:54 2020 +0200

    Fix stale options (#585)
    
    * Remove false from the supported values of stale
    
    * Add deprecation notice for stale
    
    * Add deprecation notice to stale for _find
    
    * Fix typo in Views Generation
    
    * Revert "Fix typo in Views Generation"
    
    This reverts commit 0526b9ba6d1be20427c8248fa5abc47c3199cbd0.
    
    Co-authored-by: Robert Newson <rn...@apache.org>
---
 src/api/database/find.rst       | 2 ++
 src/api/ddoc/views.rst          | 6 ++++--
 src/maintenance/performance.rst | 2 ++
 3 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/api/database/find.rst b/src/api/database/find.rst
index c515ca2..9eeb91b 100644
--- a/src/api/database/find.rst
+++ b/src/api/database/find.rst
@@ -62,6 +62,8 @@
         from a "stable" set of shards. *Optional*
     :<json string stale: Combination of ``update=false`` and ``stable=true``
         options. Possible options: ``"ok"``, ``false`` (default). *Optional*
+        Note that this parameter is deprecated. Use ``stable`` and ``update`` instead.
+        See :ref:`views/generation` for more details.
     :<json boolean execution_stats: Include
         :ref:`execution statistics <find/statistics>` in the query response.
         *Optional, default: ``false``*
diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index 7414b06..b3876c2 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -71,10 +71,12 @@
     :query boolean stable: Whether or not the view results should be returned
      from a stable set of shards. Default is ``false``.
     :query string stale: Allow the results from a stale view to be used.
-      Supported values: ``ok``, ``update_after`` and ``false``.
+      Supported values: ``ok`` and ``update_after``.
       ``ok`` is equivalent to ``stable=true&update=false``.
       ``update_after`` is equivalent to ``stable=true&update=lazy``.
-      ``false`` is equivalent to ``stable=false&update=true``.
+      The default behavior is equivalent to ``stable=false&update=true``.
+      Note that this parameter is deprecated. Use ``stable`` and ``update`` instead.
+      See :ref:`views/generation` for more details.
     :query json startkey: Return records starting with the specified key.
     :query json start_key: Alias for `startkey`.
     :query string startkey_docid: Return records starting with the specified
diff --git a/src/maintenance/performance.rst b/src/maintenance/performance.rst
index 442a9d7..4d4a27a 100644
--- a/src/maintenance/performance.rst
+++ b/src/maintenance/performance.rst
@@ -254,6 +254,8 @@ For example, something that takes 16 hex digits to represent can be done in
 Views
 =====
 
+.. _views/generation:
+
 Views Generation
 ----------------