Repository: couchdb-documentation Updated Branches: refs/heads/master 27cc73368 -> 1c4a6b967
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/921f0d22 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/921f0d22 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/921f0d22 Branch: refs/heads/master Commit: 921f0d22398d5c4d2b0f0572d063edfe71e2366b Parents: f318219 Author: Alexander Shorin <kxe...@apache.org> Authored: Thu Mar 26 01:22:42 2015 +0300 Committer: Alexander Shorin <kxe...@apache.org> Committed: Thu Mar 26 03:04:13 2015 +0300 ---------------------------------------------------------------------- src/api/database/bulk-api.rst | 3 +- src/api/database/changes.rst | 89 +++++++++++++++++++----------------- src/api/database/compact.rst | 13 ++++-- src/api/database/misc.rst | 12 +++-- src/api/database/temp-views.rst | 3 +- src/api/ddoc/common.rst | 3 +- src/api/ddoc/render.rst | 6 ++- src/api/ddoc/rewrites.rst | 47 +++++++++++-------- src/api/server/common.rst | 22 ++++++--- src/config/compaction.rst | 2 +- src/config/couchdb.rst | 2 + src/contributing.rst | 4 +- src/couchapp/views/intro.rst | 11 +++-- src/cve/2012-5641.rst | 2 + src/cve/2014-2668.rst | 2 + src/fauxton/install.rst | 7 +-- src/intro/overview.rst | 13 +++--- src/maintenance/compaction.rst | 2 +- src/maintenance/index.rst | 2 +- src/query-server/erlang.rst | 3 +- src/query-server/protocol.rst | 4 +- src/replication/conflicts.rst | 5 +- src/replication/protocol.rst | 2 - src/whatsnew/0.9.rst | 10 +++- src/whatsnew/1.3.rst | 9 ++-- 25 files changed, 165 insertions(+), 113 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/database/bulk-api.rst ---------------------------------------------------------------------- diff --git a/src/api/database/bulk-api.rst b/src/api/database/bulk-api.rst index 22a6197..662a731 100644 --- a/src/api/database/bulk-api.rst +++ b/src/api/database/bulk-api.rst @@ -192,7 +192,8 @@ ================== .. http:post:: /{db}/_bulk_docs - :synopsis: Inserts or updates multiple documents in to the database in a single request + :synopsis: Inserts or updates multiple documents in to the database in + a single request The bulk document API allows you to create and update multiple documents at the same time within a single request. The basic operation is similar http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/database/changes.rst ---------------------------------------------------------------------- diff --git a/src/api/database/changes.rst b/src/api/database/changes.rst index 70c0d6b..62a7319 100644 --- a/src/api/database/changes.rst +++ b/src/api/database/changes.rst @@ -22,70 +22,73 @@ Returns a sorted list of changes made to documents in the database, in time order of application, can be obtained from the database's ``_changes`` resource. Only the most recent change for a given document is guaranteed to - be provided, for example if a document has had fields added, and then deleted, - an API client checking for changes will not necessarily receive the - intermediate state of added documents. + be provided, for example if a document has had fields added, and then + deleted, an API client checking for changes will not necessarily receive + the intermediate state of added documents. This can be used to listen for update and modifications to the database for - post processing or synchronization, and for practical purposes, a continuously - connected ``_changes`` feed is a reasonable approach for generating a - real-time log for most applications. + post processing or synchronization, and for practical purposes, + a continuously connected ``_changes`` feed is a reasonable approach for + generating a real-time log for most applications. :param db: Database name :<header Accept: - :mimetype:`application/json` - :mimetype:`text/event-stream` - :mimetype:`text/plain` :<header Last-Event-ID: ID of the last events received by the server on a - previous connection. Overrides `since` query parameter. + previous connection. Overrides `since` query parameter. :query array doc_ids: List of document IDs to filter the changes feed as - valid JSON array. Used with :ref:`_doc_ids <changes/filter/doc_ids>` filter. - Since `length of URL is limited`_, it is better to use - :post:`/{db}/_changes` instead. + valid JSON array. Used with :ref:`_doc_ids <changes/filter/doc_ids>` + filter. Since `length of URL is limited`_, it is better to use + :post:`/{db}/_changes` instead. :query boolean conflicts: Includes `conflicts` information in response. - Ignored if `include_docs` isn't ``true``. Default is ``false``. + Ignored if `include_docs` isn't ``true``. Default is ``false``. :query boolean descending: Return the change results in descending sequence - order (most recent change first). Default is ``false``. + order (most recent change first). Default is ``false``. :query string feed: see :ref:`changes`. Default is ``normal``. :query string filter: Reference to a :ref:`filter function <filterfun>` - from a design document that will filter whole stream emitting only filtered - events. See the section `Change Notifications in the book - CouchDB The Definitive Guide`_ for more information. - :query number heartbeat: Period in *milliseconds* after which an empty line is - sent in the results. Only applicable for :ref:`longpoll <changes/longpoll>` - or :ref:`continuous <changes/continuous>` feeds. Overrides any timeout to - keep the feed alive indefinitely. Default is ``60000``. May be ``true`` to - use default value. - :query boolean include_docs: Include the associated document with each result. - If there are conflicts, only the winning revision is returned. - Default is ``false``. + from a design document that will filter whole stream emitting only + filtered events. See the section `Change Notifications in the book + CouchDB The Definitive Guide`_ for more information. + :query number heartbeat: Period in *milliseconds* after which an empty + line is sent in the results. Only applicable for :ref:`longpoll + <changes/longpoll>` or :ref:`continuous <changes/continuous>` feeds. + Overrides any timeout to keep the feed alive indefinitely. + Default is ``60000``. May be ``true`` to use default value. + :query boolean include_docs: Include the associated document with each + result. If there are conflicts, only the winning revision is returned. + Default is ``false``. :query boolean attachments: Include the Base64-encoded content of - :ref:`attachments <api/doc/attachments>` in the documents that are included - if `include_docs` is ``true``. Ignored if `include_docs` isn't ``true``. - Default is ``false``. + :ref:`attachments <api/doc/attachments>` in the documents that + are included if `include_docs` is ``true``. Ignored if `include_docs` + isn't ``true``. Default is ``false``. :query boolean att_encoding_info: Include encoding information in attachment - stubs if `include_docs` is ``true`` and the particular attachment is - compressed. Ignored if `include_docs` isn't ``true``. Default is ``false``. + stubs if `include_docs` is ``true`` and the particular attachment is + compressed. Ignored if `include_docs` isn't ``true``. + Default is ``false``. :query number last-event-id: Alias of `Last-Event-ID` header. :query number limit: Limit number of result rows to the specified value - (note that using ``0`` here has the same effect as ``1``). + (note that using ``0`` here has the same effect as ``1``). :query since: Start the results from the change immediately after the given - sequence number. Can be integer number or ``now`` value. Default is ``0``. - :query string style: Specifies how many revisions are returned in the changes - array. The default, ``main_only``, will only return the current "winning" - revision; ``all_docs`` will return all leaf revisions (including conflicts - and deleted former conflicts). + sequence number. Can be integer number or ``now`` value. + Default is ``0``. + :query string style: Specifies how many revisions are returned in + the changes array. The default, ``main_only``, will only return + the current "winning" revision; ``all_docs`` will return all leaf + revisions (including conflicts and deleted former conflicts). :query number timeout: Maximum period in *milliseconds* to wait for a change - before the response is sent, even if there are no results. Only applicable - for :ref:`longpoll <changes/longpoll>` or :ref:`continuous - <changes/continuous>` feeds. Default value is specified by - :config:option:`httpd/changes_timeout` configuration option. - Note that ``60000`` value is also the default maximum timeout to prevent - undetected dead connections. + before the response is sent, even if there are no results. + Only applicable for :ref:`longpoll <changes/longpoll>` or + :ref:`continuous <changes/continuous>` feeds. + Default value is specified by :config:option:`httpd/changes_timeout` + configuration option. Note that ``60000`` value is also the default + maximum timeout to prevent undetected dead connections. :query string view: Allows to use view functions as filters. Documents - counted as "passed" for view filter in case if map function emits at least - one record for them. See :ref:`changes/filter/view` for more info. + counted as "passed" for view filter in case if map function emits + at least one record for them. + See :ref:`changes/filter/view` for more info. :>header Cache-Control: ``no-cache`` if changes feed is - :ref:`eventsource <changes/eventsource>` + :ref:`eventsource <changes/eventsource>` :>header Content-Type: - :mimetype:`application/json` - :mimetype:`text/event-stream` - :mimetype:`text/plain; charset=utf-8` http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/database/compact.rst ---------------------------------------------------------------------- diff --git a/src/api/database/compact.rst b/src/api/database/compact.rst index 483e9dd..14c8fee 100644 --- a/src/api/database/compact.rst +++ b/src/api/database/compact.rst @@ -87,7 +87,8 @@ =========================== .. http:post:: /{db}/_compact/{ddoc} - :synopsis: Starts a compaction for all the views in the selected design document + :synopsis: Starts a compaction for all the views in the selected + design document Compacts the view indexes associated with the specified design document. If may be that compacting a large view can return more storage than @@ -145,7 +146,8 @@ =========================== .. http:post:: /{db}/_ensure_full_commit - :synopsis: Makes sure all uncommitted changes are written and synchronized to the disk + :synopsis: Makes sure all uncommitted changes are written and synchronized + to the disk Commits any recent changes to the specified database to disk. You should call this if you want to ensure that recent changes have been flushed. @@ -160,8 +162,8 @@ :<header Content-Type: :mimetype:`application/json` :>header Content-Type: - :mimetype:`application/json` - :mimetype:`text/plain; charset=utf-8` - :>json string instance_start_time: Timestamp of when the database was opened, - expressed in microseconds since the epoch. + :>json string instance_start_time: Timestamp of when the database + was opened, expressed in microseconds since the epoch. :>json boolean ok: Operation status :code 201: Commit completed successfully :code 400: Invalid database name @@ -204,7 +206,8 @@ Removes view index files that are no longer required by CouchDB as a result of changed views within design documents. As the view filename is based on a hash of the view functions, over time old views will remain, consuming - storage. This call cleans up the cached view output on disk for a given view. + storage. This call cleans up the cached view output on disk for + a given view. :param db: Database name :<header Accept: - :mimetype:`application/json` http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/database/misc.rst ---------------------------------------------------------------------- diff --git a/src/api/database/misc.rst b/src/api/database/misc.rst index 20c8aa0..2337a16 100644 --- a/src/api/database/misc.rst +++ b/src/api/database/misc.rst @@ -127,7 +127,8 @@ an expensive operation as every document in the database must be examined. ===================== .. http:post:: /{db}/_missing_revs - :synopsis: By given list of document revisions returns the document revisions that do not exist in the database + :synopsis: By given list of document revisions returns the document + revisions that do not exist in the database With given a list of document revisions, returns the document revisions that do not exist in the database. @@ -187,7 +188,8 @@ an expensive operation as every document in the database must be examined. ================== .. http:post:: /{db}/_revs_diff - :synopsis: By given list of document revisions returns differences between the given revisions and ones that are in the database + :synopsis: By given list of document revisions returns differences between + the given revisions and ones that are in the database Given a set of document/revision IDs, returns the subset of those that do not correspond to revisions stored in the database. @@ -270,7 +272,8 @@ an expensive operation as every document in the database must be examined. =================== .. http:get:: /{db}/_revs_limit - :synopsis: Returns the limit of historical revisions to store for a single document in the database + :synopsis: Returns the limit of historical revisions to store for + a single document in the database Gets the current ``revs_limit`` (revision limit) setting. @@ -303,7 +306,8 @@ an expensive operation as every document in the database must be examined. 1000 .. http:put:: /{db}/_revs_limit - :synopsis: Sets the limit of historical revisions to store for a single document in the database + :synopsis: Sets the limit of historical revisions to store for + a single document in the database Sets the maximum number of document revisions that will be tracked by CouchDB, even after compaction has occurred. You can set the revision limit http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/database/temp-views.rst ---------------------------------------------------------------------- diff --git a/src/api/database/temp-views.rst b/src/api/database/temp-views.rst index 447da0c..ffabc00 100644 --- a/src/api/database/temp-views.rst +++ b/src/api/database/temp-views.rst @@ -17,7 +17,8 @@ ================== .. http:post:: /{db}/_temp_view - :synopsis: Executes a given view function for all documents and returns the result + :synopsis: Executes a given view function for all documents and returns + the result Creates (and executes) a temporary view based on the view function supplied in the JSON request. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/ddoc/common.rst ---------------------------------------------------------------------- diff --git a/src/api/ddoc/common.rst b/src/api/ddoc/common.rst index dfc4fd6..f8620c5 100644 --- a/src/api/ddoc/common.rst +++ b/src/api/ddoc/common.rst @@ -17,7 +17,8 @@ ========================== .. http:head:: /{db}/_design/{ddoc} - :synopsis: Returns bare information in the HTTP Headers for the design document + :synopsis: Returns bare information in the HTTP Headers for + the design document Returns the HTTP Headers containing a minimal amount of information about the specified design document. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/ddoc/render.rst ---------------------------------------------------------------------- diff --git a/src/api/ddoc/render.rst b/src/api/ddoc/render.rst index e38875c..51fe333 100644 --- a/src/api/ddoc/render.rst +++ b/src/api/ddoc/render.rst @@ -138,7 +138,8 @@ ==================================================== .. http:get:: /{db}/_design/{ddoc}/_list/{func}/{view} - :synopsis: Executes a list function against the view from the same design document + :synopsis: Executes a list function against the view from the same + design document .. http:post:: /{db}/_design/{ddoc}/_list/{func}/{view} :synopsis: Same as GET method for the related endpoint @@ -204,7 +205,8 @@ =============================================================== .. http:get:: /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} - :synopsis: Executes a list function against the view from other design document + :synopsis: Executes a list function against the view from other + design document .. http:post:: /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} :synopsis: Same as GET method for the related endpoint http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/ddoc/rewrites.rst ---------------------------------------------------------------------- diff --git a/src/api/ddoc/rewrites.rst b/src/api/ddoc/rewrites.rst index e67770e..e0861e0 100644 --- a/src/api/ddoc/rewrites.rst +++ b/src/api/ddoc/rewrites.rst @@ -17,7 +17,8 @@ ======================================== .. http:any:: /{db}/_design/{ddoc}/_rewrite/{path} - :synopsis: Rewrites HTTP request for the specified path by using stored routing rules + :synopsis: Rewrites HTTP request for the specified path by using stored + routing rules Rewrites the specified path by rules defined in the specified design document. @@ -63,25 +64,31 @@ Examples: - +--------------------------------------+----------+------------------+-------+ - | Rule | Url | Rewrite to | Tokens| - +======================================+==========+==================+=======+ - | {"from": "/a", "to": "/some"} | /a | /some | | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a/\*", "to": "/some/\*} | /a/b/c | /some/b/c | | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a/b", "to": "/some"} | /a/b?k=v | /some?k=v | k=v | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a/b", "to": "/some/:var"} | /a/b | /some/b?var=b | var=b | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a/:foo/", | /a/b/c | /some/b/c?foo=b | foo=b | - | "to": "/some/:foo/"} | | | | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a/:foo", "to": "/some", | /a/b | /some/?k=b&foo=b | foo=b | - | "query": { "k": ":foo" }} | | | | - +--------------------------------------+----------+------------------+-------+ - | {"from": "/a", "to": "/some/:foo"} | /a?foo=b | /some/?b&foo=b | foo=b | - +--------------------------------------+----------+------------------+-------+ + +-----------------------------------+----------+------------------+-------+ + | Rule | Url | Rewrite to | Tokens| + +===================================+==========+==================+=======+ + | {"from": "/a", | /a | /some | | + | "to": "/some"} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a/\*", | /a/b/c | /some/b/c | | + | "to": "/some/\*} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a/b", | /a/b?k=v | /some?k=v | k=v | + | "to": "/some"} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a/b", | /a/b | /some/b?var=b | var=b | + | "to": "/some/:var"} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a/:foo/", | /a/b/c | /some/b/c?foo=b | foo=b | + | "to": "/some/:foo/"} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a/:foo", | /a/b | /some/?k=b&foo=b | foo=b | + | "to": "/some", | | | | + | "query": { "k": ":foo" }} | | | | + +-----------------------------------+----------+------------------+-------+ + | {"from": "/a", | /a?foo=b | /some/?b&foo=b | foo=b | + | "to": "/some/:foo"} | | | | + +-----------------------------------+----------+------------------+-------+ Request method, header, query parameters, request payload and response body are depended on endpoint to which url will be rewritten. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/api/server/common.rst ---------------------------------------------------------------------- diff --git a/src/api/server/common.rst b/src/api/server/common.rst index 12c7750..5be8936 100644 --- a/src/api/server/common.rst +++ b/src/api/server/common.rst @@ -221,11 +221,13 @@ :<header Accept: - :mimetype:`application/json` - :mimetype:`text/plain` - :query string feed: - **longpoll**: Closes the connection after the first event. - - **continuous**: Send a line of JSON per event. Keeps the socket open - until ``timeout``. - - **eventsource**: Like, ``continuous``, but sends the events in - `EventSource <http://dev.w3.org/html5/eventsource/>`_ format. + :query string feed: - **longpoll**: Closes the connection after the first + event. + - **continuous**: Send a line of JSON per event. + Keeps the socket open until ``timeout``. + - **eventsource**: Like, ``continuous``, but sends + the events in `EventSource + <http://dev.w3.org/html5/eventsource/>`_ format. :query number timeout: Number of seconds until CouchDB closes the connection. Default is ``60``. :query boolean heartbeat: Whether CouchDB will send a newline character @@ -472,8 +474,8 @@ Replication can be described as either push or pull replication: Pull replication is the most useful solution to use if your source database has a permanent IP address, and your destination (local) database may have a dynamically assigned IP address (for example, through DHCP). This is - particularly important if you are replicating to a mobile or other device from a - central server. + particularly important if you are replicating to a mobile or other device + from a central server. - *Push replication* is where the ``source`` is a local database, and ``target`` is a remote database. @@ -766,6 +768,8 @@ The statistics are divided into the following top-level sections: Describes statistics specific to the internals of CouchDB +.. lint: ignore errors for the next 17 lines + +-------------------------+-------------------------------------------------------+----------------+ | Statistic ID | Description | Unit | +=========================+=======================================================+================+ @@ -806,6 +810,8 @@ Describes statistics specific to the internals of CouchDB ``httpd_status_codes`` ====================== +.. lint: ignore errors for the next 29 lines + +----------------+------------------------------------------------------+----------+ | Statistic ID | Description | Unit | +================+======================================================+==========+ @@ -839,6 +845,8 @@ Describes statistics specific to the internals of CouchDB ``httpd`` ========= +.. lint: ignore errors for the next 13 lines + +----------------------------------+----------------------------------------------+----------+ | Statistic ID | Description | Unit | +==================================+==============================================+==========+ http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/config/compaction.rst ---------------------------------------------------------------------- diff --git a/src/config/compaction.rst b/src/config/compaction.rst index 9beb872..2a8c018 100644 --- a/src/config/compaction.rst +++ b/src/config/compaction.rst @@ -1,4 +1,4 @@ -.. Licensed under the Apache License, Version 2.0 (the "License")you may not +.. Licensed under the Apache License, Version 2.0 (the "License"); you may not .. use this file except in compliance with the License. You may obtain a copy of .. the License at .. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/config/couchdb.rst ---------------------------------------------------------------------- diff --git a/src/config/couchdb.rst b/src/config/couchdb.rst index 48d8d65..48142ea 100644 --- a/src/config/couchdb.rst +++ b/src/config/couchdb.rst @@ -24,6 +24,8 @@ Base CouchDB Options .. config:section:: couchdb :: Base CouchDB Options + .. lint: ignore errors for the next 1 line + .. config:option:: attachment_stream_buffer_size :: Attachment streaming buffer Higher values may result in better read performance due to fewer read http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/contributing.rst ---------------------------------------------------------------------- diff --git a/src/contributing.rst b/src/contributing.rst index a0aebf9..02daee6 100644 --- a/src/contributing.rst +++ b/src/contributing.rst @@ -217,8 +217,8 @@ The guidelines are in descending priority. #. Titles * The highest level titles in a file is over and underlined with ``=``. - * Lower level titles are underlined with the following characters in descending - order:: + * Lower level titles are underlined with the following characters in + descending order:: = - ^ * + # ` : . " ~ _ http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/couchapp/views/intro.rst ---------------------------------------------------------------------- diff --git a/src/couchapp/views/intro.rst b/src/couchapp/views/intro.rst index 574c30d..5f2fb23 100644 --- a/src/couchapp/views/intro.rst +++ b/src/couchapp/views/intro.rst @@ -232,7 +232,10 @@ Find Many --------- We talked about âgetting all posts for last month.â If itâs February now, -this is as easy as ``/blog/_design/docs/_view/by_date?startkey="2010/01/01 00:00:00"&endkey="2010/02/00 00:00:00"``. +this is as easy as:: + + /blog/_design/docs/_view/by_date?startkey="2010/01/01 00:00:00"&endkey="2010/02/00 00:00:00" + The ``startkey`` and ``endkey`` parameters specify an inclusive range on which we can search. @@ -266,8 +269,10 @@ Table 2. New view results: | [2009, 1, 30, 18, 4, 11] | "Bought a Cat" | +---------------------------+------------------+ -And our queries change to -``/blog/_design/docs/_view/by_date?startkey=[2010, 1, 1, 0, 0, 0]&endkey=[2010, 2, 1, 0, 0, 0]``. +And our queries change to:: + + /blog/_design/docs/_view/by_date?startkey=[2010, 1, 1, 0, 0, 0]&endkey=[2010, 2, 1, 0, 0, 0] + For all you care, this is just a change in syntax, not meaning. But it shows you the power of views. Not only can you construct an index with scalar values like strings and integers, you can also use JSON structures as keys for your http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/cve/2012-5641.rst ---------------------------------------------------------------------- diff --git a/src/cve/2012-5641.rst b/src/cve/2012-5641.rst index 0736f2b..40be7dd 100644 --- a/src/cve/2012-5641.rst +++ b/src/cve/2012-5641.rst @@ -10,6 +10,8 @@ .. License for the specific language governing permissions and limitations under .. the License. +.. lint: ignore errors for the next 5 lines + .. _cve/2012-5641: ================================================================================== http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/cve/2014-2668.rst ---------------------------------------------------------------------- diff --git a/src/cve/2014-2668.rst b/src/cve/2014-2668.rst index 7cdb725..1f4f733 100644 --- a/src/cve/2014-2668.rst +++ b/src/cve/2014-2668.rst @@ -10,6 +10,8 @@ .. License for the specific language governing permissions and limitations under .. the License. +.. lint: ignore errors for the next 5 lines + .. _cve/2014-2668: ================================================================================== http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/fauxton/install.rst ---------------------------------------------------------------------- diff --git a/src/fauxton/install.rst b/src/fauxton/install.rst index 0f6b06b..d9b7fcf 100644 --- a/src/fauxton/install.rst +++ b/src/fauxton/install.rst @@ -67,10 +67,11 @@ Deploy Fauxton to your local CouchDB instance: ./bin/grunt couchapp_deploy -The Fauxton be available by http://localhost:5984/fauxton/_design/fauxton/index.html +The Fauxton be available by `/fauxton/_design/fauxton/index.html +<http://localhost:5984/fauxton/_design/fauxton/index.html>`_ -Understang Fauxton Code layout ------------------------------- +Understanding Fauxton Code layout +--------------------------------- Each bit of functionality is its own separate module or addon. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/intro/overview.rst ---------------------------------------------------------------------- diff --git a/src/intro/overview.rst b/src/intro/overview.rst index 238ec8c..fc0f909 100644 --- a/src/intro/overview.rst +++ b/src/intro/overview.rst @@ -102,8 +102,9 @@ Wasted space is recovered by occasional compaction. On schedule, or when the database file exceeds a certain amount of wasted space, the compaction process clones all the active data to a new file and then discards the old file. The database remains completely online the entire time and all updates and -reads are allowed to complete successfully. The old database file is deleted only when -all the data has been copied and all users transitioned to the new file. +reads are allowed to complete successfully. The old database file is deleted +only when all the data has been copied and all users transitioned to the new +file. Views ===== @@ -130,9 +131,9 @@ View Model To address this problem of adding structure back to unstructured and semi-structured data, CouchDB integrates a view model. Views are the method of aggregating and reporting on the documents in a database, and are built -on-demand to aggregate, join and report on database documents. Because views are built -dynamically and donât affect the underlying document, you can have as many -different view representations of the same data as you like. +on-demand to aggregate, join and report on database documents. Because views +are built dynamically and donât affect the underlying document, you can have +as many different view representations of the same data as you like. View definitions are strictly virtual and only display the documents from the current database instance, making them separate from the data they display @@ -337,7 +338,7 @@ reliability and availability. Both in syntax and semantics, Erlang is very different from conventional programming languages like C or Java. Erlang uses lightweight "processes" and -message passing for concurrency, it has no shared state threading and all +message passing for concurrency, it has no shared state threading and all data is immutable. The robust, concurrent nature of Erlang is ideal for a database server. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/maintenance/compaction.rst ---------------------------------------------------------------------- diff --git a/src/maintenance/compaction.rst b/src/maintenance/compaction.rst index fa7d901..ca707a6 100644 --- a/src/maintenance/compaction.rst +++ b/src/maintenance/compaction.rst @@ -1,4 +1,4 @@ -.. Licensed under the Apache License, Version 2.0 (the "License")you may not +.. Licensed under the Apache License, Version 2.0 (the "License"); you may not .. use this file except in compliance with the License. You may obtain a copy of .. the License at .. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/maintenance/index.rst ---------------------------------------------------------------------- diff --git a/src/maintenance/index.rst b/src/maintenance/index.rst index 5f23922..d05f7e4 100644 --- a/src/maintenance/index.rst +++ b/src/maintenance/index.rst @@ -1,4 +1,4 @@ -.. Licensed under the Apache License, Version 2.0 (the "License")you may not +.. Licensed under the Apache License, Version 2.0 (the "License"); you may not .. use this file except in compliance with the License. You may obtain a copy of .. the License at .. http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/query-server/erlang.rst ---------------------------------------------------------------------- diff --git a/src/query-server/erlang.rst b/src/query-server/erlang.rst index ca6ef3b..4478c9b 100644 --- a/src/query-server/erlang.rst +++ b/src/query-server/erlang.rst @@ -121,7 +121,8 @@ Erlang :param Headers: Proplist of :ref:`response object<response_object>`. Initialize :ref:`listfun` response. At this point, response code and headers - may be defined. For example, this function redirects to the CouchDB web site: + may be defined. For example, this function redirects to the CouchDB + web site: .. code-block:: erlang http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/query-server/protocol.rst ---------------------------------------------------------------------- diff --git a/src/query-server/protocol.rst b/src/query-server/protocol.rst index 049a59d..9b8382c 100644 --- a/src/query-server/protocol.rst +++ b/src/query-server/protocol.rst @@ -231,8 +231,8 @@ keys and the list of values. When building a view, CouchDB will apply the reduce step directly to the output of the map step and the rereduce step to the output of a previous reduce step. -CouchDB will send a list of reduce functions and a list of values, with no keys or -document ids, to the rereduce step. +CouchDB will send a list of reduce functions and a list of values, with no keys +or document ids, to the rereduce step. CouchDB sends:: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/replication/conflicts.rst ---------------------------------------------------------------------- diff --git a/src/replication/conflicts.rst b/src/replication/conflicts.rst index 77b9c5c..27904c6 100644 --- a/src/replication/conflicts.rst +++ b/src/replication/conflicts.rst @@ -16,7 +16,8 @@ Replication and conflict model ============================== -Let's take the following example to illustrate replication and conflict handling. +Let's take the following example to illustrate replication and conflict +handling. - Alice has a document containing Bob's business card; - She synchronizes it between her desktop PC and her laptop; @@ -705,7 +706,7 @@ What is the CouchDB replication protocol? Is it like Git? :Author: Jason Smith :Date: 2011-01-29 -:Source: http://stackoverflow.com/questions/4766391/what-is-the-couchdb-replication-protocol-is-it-like-git +:Source: `StackOverflow <http://stackoverflow.com/questions/4766391/what-is-the-couchdb-replication-protocol-is-it-like-git>`_ **Key points** http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/replication/protocol.rst ---------------------------------------------------------------------- diff --git a/src/replication/protocol.rst b/src/replication/protocol.rst index b86f54c..94ca190 100644 --- a/src/replication/protocol.rst +++ b/src/replication/protocol.rst @@ -1252,7 +1252,6 @@ it as stream with lesser memory footprint. 5. ... 6. PROFIT! - --a81a77b0ca68389dda3243a43ca946f2-- --7b1596fc4940bc1be725ad67f11ec1c4 Content-Type: application/json; error="true" @@ -1480,7 +1479,6 @@ any serialization overhead. 5. ... 6. PROFIT! - --2fa48cba80d0cdba7829931fe8acce9d-- **Response**: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/whatsnew/0.9.rst ---------------------------------------------------------------------- diff --git a/src/whatsnew/0.9.rst b/src/whatsnew/0.9.rst index a49b1b2..15d4eaf 100644 --- a/src/whatsnew/0.9.rst +++ b/src/whatsnew/0.9.rst @@ -59,8 +59,14 @@ Moved View URLs --------------- The view URLs have been moved to design document resources. This means that -paths that used to be like http://hostname:5984/mydb/_view/designname/viewname?limit=10 -will now look like http://hostname:5984/mydb/_design/designname/_view/viewname?limit=10. +paths that used to be like:: + + http://hostname:5984/mydb/_view/designname/viewname?limit=10 + +will now look like:: + + http://hostname:5984/mydb/_design/designname/_view/viewname?limit=10. + See the `REST, Hypermedia, and CouchApps`_ thread on dev for details. .. _REST, Hypermedia, and CouchApps: http://mail-archives.apache.org/mod_mbox/couchdb-dev/200902.mbox/%3ce282921e0902242116n2cd207c4x7a9d0feced3f1...@mail.gmail.com%3E http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/921f0d22/src/whatsnew/1.3.rst ---------------------------------------------------------------------- diff --git a/src/whatsnew/1.3.rst b/src/whatsnew/1.3.rst index 66ed47d..61931fc 100644 --- a/src/whatsnew/1.3.rst +++ b/src/whatsnew/1.3.rst @@ -21,8 +21,9 @@ :local: .. warning:: - :ref:`release/1.3.x` is affected by the issue described in :ref:`cve/2014-2668`. - Upgrading to a more recent release is strongly recommended. + :ref:`release/1.3.x` is affected by the issue described in + :ref:`cve/2014-2668`. Upgrading to a more recent release is strongly + recommended. .. _release/1.3.x/upgrade: @@ -112,7 +113,7 @@ HTTP Interface * :issue:`764`, :issue:`514`, :issue:`430`: Fix sending HTTP headers from ``_list`` function, :commit:`2a74f88375` * :issue:`887`: Fix ``bytes`` and ``offset`` parameters semantic for `_log` - resource (`explanation <https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=blobdiff;f=src/couchdb/couch_log.erl;h=1b05f4db2;hp=0befe7aab;hb=ad700014;hpb=7809f3ca>`_) + resource (`explanation`_) :commit:`ad700014` * :issue:`986`: Added Server-Sent Events protocol to db changes API. See http://www.w3.org/TR/eventsource/ for details. :commit:`093d2aa6` @@ -159,6 +160,8 @@ HTTP Interface * Return ``X-Couch-Id`` header if doc is created, :commit:`98515bf0b9` * Support auth cookies with ``:`` characters, :commit:`d9566c831d` +.. _explanation: https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=blobdiff;f=src/couchdb/couch_log.erl;h=1b05f4db2;hp=0befe7aab;hb=ad700014;hpb=7809f3ca + Log System ----------
