couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject [1/8] git commit: updated refs/heads/master to 7d1533e
Date Mon, 20 May 2013 06:56:30 GMT
Updated Branches:
  refs/heads/1.3.x 47fc33222 -> 13ae34d01
  refs/heads/master 4adb5f3fc -> 7d1533eee


docs: merge API introduction and actual reference material

This gets rid of an empty database maintenance section for now.


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

Branch: refs/heads/master
Commit: 79bfcce8dfbd0d2147ef89ace1ba4723a7b8aa1a
Parents: 4adb5f3
Author: Dirkjan Ochtman <djc@apache.org>
Authored: Mon May 20 08:42:17 2013 +0200
Committer: Dirkjan Ochtman <djc@apache.org>
Committed: Mon May 20 08:42:17 2013 +0200

----------------------------------------------------------------------
 share/doc/src/api-basics.rst    |   57 ----------------------------------
 share/doc/src/api/dbmaint.rst   |   15 ---------
 share/doc/src/api/reference.rst |   28 ++++++++++++----
 3 files changed, 21 insertions(+), 79 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/79bfcce8/share/doc/src/api-basics.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api-basics.rst b/share/doc/src/api-basics.rst
index e837573..60ea74c 100644
--- a/share/doc/src/api-basics.rst
+++ b/share/doc/src/api-basics.rst
@@ -461,60 +461,3 @@ ranges. Read all about it in `RFC 2616`_.
    better algorithm to find byte ranges.
 
 .. _RFC 2616: http://tools.ietf.org/html/rfc2616#section-14.27
-
-.. _api-overview:
-
-CouchDB API Overview
-====================
-
-The components of the API URL path help determine the part of the
-CouchDB server that is being accessed. The result is the structure of
-the URL request both identifies and effectively describes the area of
-the database you are accessing.
-
-As with all URLs, the individual components are separated by a forward
-slash.
-
-As a general rule, URL components and JSON fields starting with the
-``_`` (underscore) character represent a special component or entity
-within the server or returned object. For example, the URL fragment
-``/_all_dbs`` gets a list of all of the databases in a CouchDB instance.
-
-The remainder of the URL API structure can be divided up according to
-the URL structure. The different sections are divided as follows:
-
--  ``/db``
-
-   Database methods, related to adding, updating or deleting databases,
-   and setting database parameters and operations. For more detailed
-   information, see :ref:`api-db`.
-
--  ``/db/doc``
-
-   Document methods, those that create, store, update or delete CouchDB
-   documents and their attachments. For more information, see :ref:`api-doc`.
-
--  ``/db/_local/local-doc``
-
-   Document methods, those that create, store, update or delete CouchDB
-   documents only within the local database. Local documents are not
-   synchronized with other databases. For more information, see
-   :ref:`api-local`.
-
--  ``/db/_design/design-doc``
-
-   Design documents provide the methods and structure for recovering
-   information from a CouchDB database in the form of views, shows and
-   lists. For more information, see :ref:`api-design`.
-
--  ``/_special``
-
-   Special methods that obtain or set information about the CouchDB
-   instance, including methods for configuring replication, accessing
-   the logs, and generate Universally Unique IDs (UUIDs). For more
-   information, see :ref:`api-misc`.
-
--  ``/_config``
-
-   Methods for getting, and settings, CouchDB configuration parameters.
-   For more information, see :ref:`api-config`.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/79bfcce8/share/doc/src/api/dbmaint.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/dbmaint.rst b/share/doc/src/api/dbmaint.rst
deleted file mode 100644
index 9b2019d..0000000
--- a/share/doc/src/api/dbmaint.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. 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://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-.. License for the specific language governing permissions and limitations under
-.. the License.
-
-====================
-Database Maintenance
-====================

http://git-wip-us.apache.org/repos/asf/couchdb/blob/79bfcce8/share/doc/src/api/reference.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/reference.rst b/share/doc/src/api/reference.rst
index fce650a..2014c7e 100644
--- a/share/doc/src/api/reference.rst
+++ b/share/doc/src/api/reference.rst
@@ -10,19 +10,33 @@
 .. License for the specific language governing permissions and limitations under
 .. the License.
 
-API Reference
-=============
+.. _api-overview:
 
-Contents:
+CouchDB API Reference
+=====================
+
+The components of the API URL path help determine the part of the
+CouchDB server that is being accessed. The result is the structure of
+the URL request both identifies and effectively describes the area of
+the database you are accessing.
+
+As with all URLs, the individual components are separated by a forward
+slash.
+
+As a general rule, URL components and JSON fields starting with the
+``_`` (underscore) character represent a special component or entity
+within the server or returned object. For example, the URL fragment
+``/_all_dbs`` gets a list of all of the databases in a CouchDB instance.
+
+This reference is structured according to the URL structure, as below.
 
 .. toctree::
    :maxdepth: 2
 
-   configuration
-   authn
    database
    documents
+   local
    design
    misc
-   local
-   dbmaint
+   configuration
+   authn


Mime
View raw message