You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2017/03/08 02:16:55 UTC

[1/6] documentation commit: updated refs/heads/master to 3a2eadb

Repository: couchdb-documentation
Updated Branches:
  refs/heads/master 3f7ee184d -> 3a2eadb2c


Fix description of delayed_commits

- Fix spelling and grammar
- Reword to be less awkward.


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

Branch: refs/heads/master
Commit: 5b7d0570b37e2ea9838114a9f27265d34bb8d507
Parents: 5134e9c
Author: Jonathan Hall <fl...@flimzy.com>
Authored: Tue Mar 7 11:35:26 2017 +0100
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:11:41 2017 -0500

----------------------------------------------------------------------
 src/config/couchdb.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/5b7d0570/src/config/couchdb.rst
----------------------------------------------------------------------
diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst
index cf58acf..62eb49c 100644
--- a/src/config/couchdb.rst
+++ b/src/config/couchdb.rst
@@ -47,11 +47,11 @@ Base CouchDB Options
 
     .. config:option:: delayed_commits :: Delayed commits
 
-        When this config value as ``false`` the CouchDB provides guaranty of
-        `fsync` call before return :http:statuscode:`201` response on each
-        document saving. Setting this config value as ``true`` may raise some
-        overall performance with cost of losing durability - it's strongly not
-        recommended to do such in production::
+        When this config value is ``false`` the CouchDB provides a guarantee
+        that `fsync` will be called before returning a :http:statuscode:`201`
+        response on each document save. Setting this config value to ``true``
+        may improve performance, at cost of some durability. For production use
+        disabling this is strongly recommended::
 
             [couchdb]
             delayed_commits = false


[4/6] documentation commit: updated refs/heads/master to 3a2eadb

Posted by va...@apache.org.
Remove redundancy


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

Branch: refs/heads/master
Commit: f8f7f4765b71e2c9c01619ba4271d14b773546cb
Parents: 93d2f6d
Author: Jonathan Hall <fl...@flimzy.com>
Authored: Sat Mar 4 11:40:54 2017 +0100
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:11:41 2017 -0500

----------------------------------------------------------------------
 src/api/database/security.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/f8f7f476/src/api/database/security.rst
----------------------------------------------------------------------
diff --git a/src/api/database/security.rst b/src/api/database/security.rst
index 1c9e26b..116010f 100644
--- a/src/api/database/security.rst
+++ b/src/api/database/security.rst
@@ -39,7 +39,7 @@
     - ``names``: List of CouchDB user names
     - ``roles``: List of users roles
 
-    Any other additional fields in the security object are optional.
+    Any additional fields in the security object are optional.
     The entire security object is made available to validation and other
     internal functions so that the database can control and limit
     functionality.


[2/6] documentation commit: updated refs/heads/master to 3a2eadb

Posted by va...@apache.org.
Grammar improvements


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

Branch: refs/heads/master
Commit: 93d2f6dbb2bafa30d9fa1b443c44bbd5f0d959fa
Parents: 3f7ee18
Author: Jonathan Hall <fl...@flimzy.com>
Authored: Sat Feb 25 19:18:10 2017 +0100
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:11:41 2017 -0500

----------------------------------------------------------------------
 src/api/database/security.rst | 3 +--
 src/api/server/authn.rst      | 4 ++--
 2 files changed, 3 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/93d2f6db/src/api/database/security.rst
----------------------------------------------------------------------
diff --git a/src/api/database/security.rst b/src/api/database/security.rst
index f34139a..1c9e26b 100644
--- a/src/api/database/security.rst
+++ b/src/api/database/security.rst
@@ -34,8 +34,7 @@
       <api/db/revs_limit>`. They can not create a database nor delete a
       database.
 
-    Both ``members`` and ``admins`` objects are contains two array-typed
-    fields:
+    Both ``members`` and ``admins`` objects contain two array-typed fields:
 
     - ``names``: List of CouchDB user names
     - ``roles``: List of users roles

http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/93d2f6db/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index 09567da..6bf4c63 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -282,8 +282,8 @@ some external authentication service and you don't want to duplicate users and
 their roles in CouchDB.
 
 This authentication method allows creation of a :ref:`userctx_object` for
-remotely authenticated user. By default, the client just need to pass specific
-headers to CouchDB with related request:
+remotely authenticated user. By default, the client just needs to pass specific
+headers to CouchDB with related requests:
 
 - :config:option:`X-Auth-CouchDB-UserName <couch_httpd_auth/x_auth_username>`:
   username;


[3/6] documentation commit: updated refs/heads/master to 3a2eadb

Posted by va...@apache.org.
Fix the config option name and descriptions

- Re-word description of X-Auth-CouchDB-Roles header to be less awkward.  As
  previously worded, it was a list of N items with a single comma, which
  clearly makes no sense.  I reworded it to be less ambiguously a
  comma-separated listed.
- <force token to be required> was formatted as a config option.  Instead, I
  reworded the description to use the acutal config option,
  <proxy_use_secret>,
- Reword description of X-Auth-CouchDB-Token to make it clear that the
  header itself is not optional, but rather that the config option requiring
  it is optional.


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

Branch: refs/heads/master
Commit: 5134e9cb0f11e14c0929472c8d84a2422b8f0e75
Parents: f8f7f47
Author: Jonathan Hall <fl...@flimzy.com>
Authored: Mon Mar 6 10:59:47 2017 +0100
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:11:41 2017 -0500

----------------------------------------------------------------------
 src/api/server/authn.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/5134e9cb/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index 6bf4c63..e9cb41b 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -288,10 +288,10 @@ headers to CouchDB with related requests:
 - :config:option:`X-Auth-CouchDB-UserName <couch_httpd_auth/x_auth_username>`:
   username;
 - :config:option:`X-Auth-CouchDB-Roles <couch_httpd_auth/x_auth_roles>`:
-  list of user roles separated by a comma (``,``);
+  comma-separated (``,``) list of user roles;
 - :config:option:`X-Auth-CouchDB-Token <couch_httpd_auth/x_auth_token>`:
-  authentication token. Optional, but strongly recommended to
-  :config:option:`force token be required <couch_httpd_auth/proxy_use_secret>`
+  authentication token. When :config:option:`proxy_use_secret <couch_httpd_auth/proxy_use_secret>`
+  is set (which is strongly recommended!), this header provides the secret token
   to prevent requests from untrusted sources.
 
 **Request**:


[5/6] documentation commit: updated refs/heads/master to 3a2eadb

Posted by va...@apache.org.
Shorten line to make linter happy


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

Branch: refs/heads/master
Commit: 90050a698d524d562488e0cbaa627471e2b1413e
Parents: 5b7d057
Author: Nick Vatamaniuc <va...@apache.org>
Authored: Tue Mar 7 21:15:11 2017 -0500
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:15:11 2017 -0500

----------------------------------------------------------------------
 src/api/server/authn.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/90050a69/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/src/api/server/authn.rst b/src/api/server/authn.rst
index e9cb41b..911c047 100644
--- a/src/api/server/authn.rst
+++ b/src/api/server/authn.rst
@@ -290,9 +290,10 @@ headers to CouchDB with related requests:
 - :config:option:`X-Auth-CouchDB-Roles <couch_httpd_auth/x_auth_roles>`:
   comma-separated (``,``) list of user roles;
 - :config:option:`X-Auth-CouchDB-Token <couch_httpd_auth/x_auth_token>`:
-  authentication token. When :config:option:`proxy_use_secret <couch_httpd_auth/proxy_use_secret>`
-  is set (which is strongly recommended!), this header provides the secret token
-  to prevent requests from untrusted sources.
+  authentication token. When
+  :config:option:`proxy_use_secret <couch_httpd_auth/proxy_use_secret>`
+  is set (which is strongly recommended!), this header provides the secret
+  token to prevent requests from untrusted sources.
 
 **Request**:
 


[6/6] documentation commit: updated refs/heads/master to 3a2eadb

Posted by va...@apache.org.
Merge branch 'pr/104'

Closes #104


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

Branch: refs/heads/master
Commit: 3a2eadb2c0d35d6ab164d88769438c9e6c8429e9
Parents: 3f7ee18 90050a6
Author: Nick Vatamaniuc <va...@apache.org>
Authored: Tue Mar 7 21:15:28 2017 -0500
Committer: Nick Vatamaniuc <va...@apache.org>
Committed: Tue Mar 7 21:15:28 2017 -0500

----------------------------------------------------------------------
 src/api/database/security.rst |  5 ++---
 src/api/server/authn.rst      | 13 +++++++------
 src/config/couchdb.rst        | 10 +++++-----
 3 files changed, 14 insertions(+), 14 deletions(-)
----------------------------------------------------------------------