[couchdb-documentation] 01/01: Clarify what compaction does

[fl...@apache.org]

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

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

commit 43c8870190cddc21b51fae4de34a87869a3f31e0
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Thu Jul 11 18:37:48 2019 +0200

    Clarify what compaction does
---
 src/api/database/compact.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/api/database/compact.rst b/src/api/database/compact.rst
index 4fcf34e..e0c63e8 100644
--- a/src/api/database/compact.rst
+++ b/src/api/database/compact.rst
@@ -22,15 +22,15 @@
     Request compaction of the specified database. Compaction compresses the
     disk database file by performing the following operations:
 
-    - Writes a new, optimised, version of the database file, removing any
+    - Writes a new, optimized, version of the database file, removing any
       unused sections from the new version during write. Because a new file is
       temporarily created for this purpose, you may require up to twice the
       current storage space of the specified database in order for the
       compaction routine to complete.
-
-    - Removes old revisions of documents from the database, up to the
-      per-database limit specified by the ``_revs_limit`` database
-      parameter.
+    - Removes the bodies of any old, non-leaf revisions of documents from the
+      database.
+    - Removes old revision history beyond the limit specified by the
+      ``_revs_limit`` database parameter.
 
     Compaction can only be requested on an individual database; you cannot
     compact all the databases for a CouchDB instance. The compaction process