couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject [1/6] git commit: updated refs/heads/master to 00aa8fd
Date Tue, 01 Oct 2013 13:49:45 GMT
Updated Branches:
  refs/heads/master 6f31ffd97 -> 00aa8fd2f


Language tweaks for http/compaction configuration reference.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/3216d30b
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/3216d30b
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/3216d30b

Branch: refs/heads/master
Commit: 3216d30bcb12c6951548d7b5c5b0f8430c29d3cd
Parents: 6f31ffd
Author: Dirkjan Ochtman <djc@apache.org>
Authored: Tue Oct 1 14:58:34 2013 +0200
Committer: Dirkjan Ochtman <djc@apache.org>
Committed: Tue Oct 1 14:58:34 2013 +0200

----------------------------------------------------------------------
 share/doc/src/config/compaction.rst | 30 +++++++++++++++---------------
 share/doc/src/config/http.rst       |  2 +-
 2 files changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/3216d30b/share/doc/src/config/compaction.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/compaction.rst b/share/doc/src/config/compaction.rst
index 5e1e10d..39311a0 100644
--- a/share/doc/src/config/compaction.rst
+++ b/share/doc/src/config/compaction.rst
@@ -49,10 +49,10 @@ Compaction Daemon Rules
 
 .. config:section:: compactions :: Compaction Daemon Rules
 
-  Automatic compaction rules definition. The :option:`daemons/compaction_daemon`
-  compacts databases and their respective view groups when all the condition
-  parameters are satisfied. Configuration can be per database or global, and it
-  has the following format::
+  A list of rules to determine when to run automatic compaction. The
+  :option:`daemons/compaction_daemon` compacts databases and their respective
+  view groups when all the condition parameters are satisfied. Configuration
+  can be per-database or global, and it has the following format::
 
     [compactions]
     database_name = [ {ParamName, ParamValue}, {ParamName, ParamValue}, ... ]
@@ -64,12 +64,10 @@ Compaction Daemon Rules
     [compactions]
     _default = [{db_fragmentation, "70%"}, {view_fragmentation, "60%"}, {from, "23:00"},
{to, "04:00"}]
 
-  Possible parameters:
-
   - ``db_fragmentation``: If the ratio of legacy data, including metadata, to
-    current data in the database file size is equal to or greater then this
-    value, this database compaction condition is satisfied. The percentage is
-    expressed as an integer percentage. This value is computed as::
+    current data in the database file size is equal to or greater than this
+    value, this condition is satisfied. The percentage is expressed as an
+    integer percentage. This value is computed as::
 
       (file_size - data_size) / file_size * 100
 
@@ -86,15 +84,15 @@ Compaction Daemon Rules
     The data_size and file_size values can be obtained when querying a
     :ref:`view group's information URI <api/ddoc/info>`.
 
-  - ``from`` and ``to``: The period for which a database (and its view groups)
+  - ``from`` and ``to``: The period for which a database (and its view group)
     compaction is allowed. The value for these parameters must obey the format::
 
       HH:MM - HH:MM  (HH in [0..23], MM in [0..59])
 
   - ``strict_window``: If a compaction is still running after the end of the
     allowed period, it will be canceled if this parameter is set to `true`.
-    It defaults to `false` and it's meaningful only if the *period* parameter
-    is also specified.
+    It defaults to `false` and is meaningful only if the *period* parameter is
+    also specified.
 
   - ``parallel_view_compaction``: If set to `true`, the database and its views
     are compacted in parallel. This is only useful on certain setups, like
@@ -150,9 +148,11 @@ Configuration of Compaction Daemon
 
   .. config:option:: min_file_size
 
-    If a database or view index file is smaller then this value (in bytes),
-    compaction will not happen. Very small files always have a very high
-    fragmentation therefore it's not worth to compact them::
+    If a database or view index file is smaller than this value (in bytes),
+    compaction will not happen. Very small files always have high fragmentation,
+    so compacting them is inefficient.
+
+    ::
 
       [compaction_daemon]
       min_file_size = 131072

http://git-wip-us.apache.org/repos/asf/couchdb/blob/3216d30b/share/doc/src/config/http.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/http.rst b/share/doc/src/config/http.rst
index 41b8b9d..f12c40b 100644
--- a/share/doc/src/config/http.rst
+++ b/share/doc/src/config/http.rst
@@ -277,7 +277,7 @@ Secure Socket Level Options
   configuration screen in Futon. Here is what you need to do in
   ``local.ini``, you can infer what needs doing in the other places.
 
-  At first, :option:`enable HTTPS daemon <daemons/httpsd>`::
+  At first, :option:`enable the HTTPS daemon <daemons/httpsd>`::
 
     [daemons]
     httpsd = {couch_httpd, start_link, [https]}


Mime
View raw message