doc/api/s3 <-chipping away at objectops and clean up. Added Copy Object.

doc/source <-fixed a typo, updates for installing on precise, rm $ from cmds
doc/start  <-replaced clone link with tarball link. Link to Ceph Source Code.

Signed-off-by: John Wilkins <john.wilkins@inktank.com>

diff --git a/doc/api/s3/commons.rst b/doc/api/s3/commons.rst
index 0b8e1f4f4c2178763d0fe46feb28226e394d2f29..f102e52447abe85d8db15aa587a6c52c74f056ce 100644 (file)
--- a/doc/api/s3/commons.rst
+++ b/doc/api/s3/commons.rst
@@ -1,6 +1,6 @@
-===============
-Common Entities
-===============
+=================
+ Common Entities
+=================
 
 .. toctree::
    :maxdepth: -1

diff --git a/doc/api/s3/objectops.rst b/doc/api/s3/objectops.rst
index 9f3c8c436e2939e657ae0ff40c6a31792b826ee3..ea25aaf4fd372938e67de79df4cfc61731292821 100644 (file)
--- a/doc/api/s3/objectops.rst
+++ b/doc/api/s3/objectops.rst
@@ -44,34 +44,37 @@ Syntax
 Request Headers
 ~~~~~~~~~~~~~~~
 
-+--------------------------------------+---------------+----------------+------------+
-| Name                                 | Description   | Valid Values   | Required   |
-+======================================+===============+================+============+
-| **x-amz-copy-source**                |               |                | Yes        |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-acl**                        |               |                | No         |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-modified-since**     |               |                | No         |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-unmodified-since**   |               |                | No         |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-match**              |               |                | No         |
-+--------------------------------------+---------------+----------------+------------+
-| **x-amz-copy-if-none-match**         |               |                | No         |
-+--------------------------------------+---------------+----------------+------------+
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| Name                                 | Description                                     | Valid Values           | Required   |
++======================================+=================================================+========================+============+
+| **x-amz-copy-source**                | The source bucket name + object name.           | {bucket}/{obj}         | Yes        |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-acl**                        | A canned ACL.                                   | ``private``,           | No         |
+|                                      |                                                 | ``public-read``,       |            |
+|                                      |                                                 | ``public-read-write``, |            |
+|                                      |                                                 | ``authenticated-read`` |            |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-modified-since**     |  Copies only if modified since the timestamp.   |   Timestamp            | No         |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-unmodified-since**   |  Copies only if unmodified since the timestamp. |   Timestamp            | No         |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-match**              |  Copies only if object ETag matches ETag.       |   Entity Tag           | No         |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
+| **x-amz-copy-if-none-match**         |  Copies only if object ETag doesn't match.      |   Entity Tag           | No         |
++--------------------------------------+-------------------------------------------------+------------------------+------------+
 
 Response Entities
 ~~~~~~~~~~~~~~~~~
 
-+------------------------+-------------+---------------+
-| Name                   | Type        | Description   |
-+========================+=============+===============+
-| **CopyObjectResult**   | Container   |               |
-+------------------------+-------------+---------------+
-| **LastModified**       | Date        |               |
-+------------------------+-------------+---------------+
-| **Etag**               | String      |               |
-+------------------------+-------------+---------------+
++------------------------+-------------+-----------------------------------------------+
+| Name                   | Type        | Description                                   |
++========================+=============+===============================================+
+| **CopyObjectResult**   | Container   |  A container for the response elements.       |
++------------------------+-------------+-----------------------------------------------+
+| **LastModified**       | Date        |  The last modified date of the source object. |
++------------------------+-------------+-----------------------------------------------+
+| **Etag**               | String      |  The ETag of the new object.                  |
++------------------------+-------------+-----------------------------------------------+
 
 Remove Object
 -------------

diff --git a/doc/source/build-prerequisites.rst b/doc/source/build-prerequisites.rst
index 7c62ea86282cc8891b4c38b74cd79b650f19f091..640dda5148bed5aacbf74bf4b66f2479f293d9bd 100644 (file)
--- a/doc/source/build-prerequisites.rst
+++ b/doc/source/build-prerequisites.rst
@@ -48,7 +48,7 @@ Ubuntu Requirements
 -------------------
 
 - ``uuid-dev``
-- ``libkeytutils-dev``
+- ``libkeyutils-dev``
 - ``libgoogle-perftools-dev``
 - ``libatomic-ops-dev``
 - ``libaio-dev``
@@ -58,7 +58,7 @@ Ubuntu Requirements
 Execute ``sudo apt-get install`` for each dependency that isn't installed on 
 your host. ::
 
-       sudo apt-get install uuid-dev libkeytutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
+       sudo apt-get install uuid-dev libkeyutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
 
 Debian
 ------

diff --git a/doc/source/clone-source.rst b/doc/source/clone-source.rst
new file mode 100644 (file)
index 0000000..60eed07
--- /dev/null
+++ b/doc/source/clone-source.rst
@@ -0,0 +1,74 @@
+=========================================
+ Cloning the Ceph Source Code Repository
+=========================================
+
+To check out the Ceph source code, you must have ``git`` installed
+on your local host. To install ``git``, execute::
+
+       sudo apt-get install git
+
+You must also have a ``github`` account. If you do not have a
+``github`` account, go to `github.com <http://github.com>`_ and register.
+Follow the directions for setting up git at 
+`Set Up Git <http://help.github.com/linux-set-up-git/>`_.
+
+Generate SSH Keys
+-----------------
+You must generate SSH keys for github to clone the Ceph
+repository. If you do not have SSH keys for ``github``, execute::
+
+       ssh-keygen
+
+Get the key to add to your ``github`` account (the following example
+assumes you used the default file path)::
+
+       cat .ssh/id_rsa.pub
+
+Copy the public key.
+
+Add the Key
+-----------
+Go to your your ``github`` account,
+click on "Account Settings" (i.e., the 'tools' icon); then,
+click "SSH Keys" on the left side navbar.
+
+Click "Add SSH key" in the "SSH Keys" list, enter a name for
+the key, paste the key you generated, and press the "Add key"
+button.
+
+Clone the Source
+----------------
+To clone the Ceph source code repository, execute::
+
+       git clone git@github.com:ceph/ceph.git
+
+Once ``git clone`` executes, you should have a full copy of the Ceph 
+repository.
+
+Clone the Submodules
+--------------------
+Before you can build Ceph, you must navigate to your new repository and get 
+the ``init`` submodule and the ``update`` submodule::
+
+       cd ceph
+       git submodule init
+       git submodule update
+
+.. tip:: Make sure you maintain the latest copies of these submodules. 
+   Running ``git status`` will tell you if the submodules are out of date::
+
+       git status
+
+Choose a Branch
+---------------
+Once you clone the source code and submodules, your Ceph repository 
+will be on the ``master`` branch by default, which is the unstable 
+development branch. You may choose other branches too.
+
+- ``master``: The unstable development branch.
+- ``stable``: The bugfix branch.
+- ``next``: The release candidate branch.
+
+::
+
+       git checkout master

diff --git a/doc/source/cloning-the-ceph-source-code-repository.rst b/doc/source/cloning-the-ceph-source-code-repository.rst
deleted file mode 100644 (file)
index 72d52be..0000000
--- a/doc/source/cloning-the-ceph-source-code-repository.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-=======================================
-Cloning the Ceph Source Code Repository
-=======================================
-To check out the Ceph source code, you must have ``git`` installed
-on your local host. To install ``git``, execute::
-
-       $ sudo apt-get install git
-
-You must also have a ``github`` account. If you do not have a
-``github`` account, go to `github.com <http://github.com>`_ and register.
-Follow the directions for setting up git at `Set Up Git <http://help.github.com/linux-set-up-git/>`_.
-
-Clone the Source
-----------------
-To clone the Ceph source code repository, execute::
-
-       $ git clone git@github.com:ceph/ceph.git
-
-Once ``git clone`` executes, you should have a full copy of the Ceph repository.
-
-Clone the Submodules
---------------------
-Before you can build Ceph, you must navigate to your new repository and get the ``init`` submodule and the ``update`` submodule::
-
-       $ cd ceph
-       $ git submodule init
-       $ git submodule update
-
-.. tip:: Make sure you maintain the latest copies of these submodules. Running ``git status`` will tell you if the submodules are out of date::
-
-       $ git status
-
-Choose a Branch
----------------
-Once you clone the source code and submodules, your Ceph repository will be on the ``master`` branch by default, which is the unstable development branch. You may choose other branches too.
-
-- ``master``: The unstable development branch.
-- ``stable``: The bugfix branch.
-- ``next``: The release candidate branch.
-
-::
-
-       git checkout master

diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index ef63f26d9cf62c964934e9c9207f9ef1c91de461..6340cd49cec53cb9c517b443a7c06a40fe6e1a12 100644 (file)
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1,30 +1,5 @@
 ==========================
  Contributing Source Code
 ==========================
-If you are making source contributions, you must be added to the Ceph
-project on github. You must also generate keys and add them to your
-github account.
-
-Generate SSH Keys
------------------
-You must generate SSH keys for github to clone the Ceph
-repository. If you do not have SSH keys for ``github``, execute::
-
-       ssh-keygen -d
-
-Get the key to add to your ``github`` account (the following example
-assumes you used the default file path)::
-
-       cat .ssh/id_dsa.pub
-
-Copy the public key.
-
-Add the Key
------------
-Go to your your ``github`` account,
-click on "Account Settings" (i.e., the 'tools' icon); then,
-click "SSH Keys" on the left side navbar.
-
-Click "Add SSH key" in the "SSH Keys" list, enter a name for
-the key, paste the key you generated, and press the "Add key"
-button.
+If you are making source contributions to the Ceph project, 
+you must be added to the Ceph project on github.
\ No newline at end of file

diff --git a/doc/source/downloading-a-ceph-release.rst b/doc/source/downloading-a-ceph-release.rst
deleted file mode 100644 (file)
index 816795a..0000000
--- a/doc/source/downloading-a-ceph-release.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-====================================
- Downloading a Ceph Release Tarball
-====================================
-
-As Ceph development progresses, the Ceph team releases new versions of the
-source code. You may download source code tarballs for Ceph releases here:
-
-`Ceph Release Tarballs`_
-
-
-.. _Ceph Release Tarballs: http://ceph.com/download/
\ No newline at end of file

diff --git a/doc/source/get-tarballs.rst b/doc/source/get-tarballs.rst
new file mode 100644 (file)
index 0000000..816795a
--- /dev/null
+++ b/doc/source/get-tarballs.rst
@@ -0,0 +1,11 @@
+====================================
+ Downloading a Ceph Release Tarball
+====================================
+
+As Ceph development progresses, the Ceph team releases new versions of the
+source code. You may download source code tarballs for Ceph releases here:
+
+`Ceph Release Tarballs`_
+
+
+.. _Ceph Release Tarballs: http://ceph.com/download/
\ No newline at end of file

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 1f10d77adc2c807865704ce2c35601d897546e0d..8b80c5a4dc64b00aeb84238101370fabb476039a 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,8 +10,8 @@ will save you time.
 .. toctree::
 
    Prerequisites <build-prerequisites>
-   Get a Tarball <downloading-a-ceph-release>
-   Clone the Source <cloning-the-ceph-source-code-repository>
+   Get a Tarball <get-tarballs>
+   Clone the Source <clone-source>
    Build the Source <building-ceph>
    Build a Package <build-packages>
    Contributing Code <contributing>

diff --git a/doc/start/get-involved-in-the-ceph-community.rst b/doc/start/get-involved-in-the-ceph-community.rst
deleted file mode 100644 (file)
index 58af4a8..0000000
--- a/doc/start/get-involved-in-the-ceph-community.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-=====================================
- Get Involved in the Ceph Community!
-=====================================
-These are exciting times in the Ceph community! Get involved!
-
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-|Channel          | Description                                     | Contact Info                                  |
-+=================+=================================================+===============================================+
-| **Blog**        | Check the Ceph Blog_ periodically to keep track | http://ceph.com/community/blog/               |
-|                 | of Ceph progress and important announcements.   |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-| **IRC**         | As you delve into Ceph, you may have questions  |                                               |
-|                 | or feedback for the Ceph development team. Ceph | - **Domain:** ``irc.oftc.net``                |
-|                 | developers are often available on the ``#ceph`` | - **Channel:** ``#ceph``                      |
-|                 | IRC channel particularly during daytime hours   |                                               |
-|                 | in the US Pacific Standard Time zone.           |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-| **Email List**  | Keep in touch with developer activity by        |                                               |
-|                 | subscribing_ to the email list at               | - Subscribe_                                  |
-|                 | ceph-devel@vger.kernel.org. You can opt out of  | - Unsubscribe_                                |
-|                 | the email list at any time by unsubscribing_.   | - Gmane_                                      |
-|                 | A simple email is all it takes! If you would    |                                               |
-|                 | like to view the archives, go to Gmane_.        |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-| **Bug Tracker** | You can help keep Ceph production worthy by     | http://tracker.newdream.net/projects/ceph     |
-|                 | filing and tracking bugs, and providing feature |                                               |
-|                 | requests using the Bug Tracker_.                |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-| **Source Code** | If you would like to participate in             |                                               |
-|                 | development, bug fixing, or if you just want    | - http://github.com:ceph/ceph.git             |
-|                 | the very latest code for Ceph, you can get it   | - ``git clone git@github.com:ceph/ceph.git``  |
-|                 | at http://github.com.                           |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-| **Support**     | If you have a very specific problem, an         | http://inktank.com                            |
-|                 | immediate need, or if your deployment requires  |                                               |
-|                 | significant help, consider commercial support_. |                                               |
-+-----------------+-------------------------------------------------+-----------------------------------------------+
-
-
-
-.. _Subscribe: mailto:majordomo@vger.kernel.org?body=subscribe+ceph-devel
-.. _Unsubscribe: mailto:majordomo@vger.kernel.org?body=unsubscribe+ceph-devel
-.. _subscribing: mailto:majordomo@vger.kernel.org?body=subscribe+ceph-devel
-.. _unsubscribing: mailto:majordomo@vger.kernel.org?body=unsubscribe+ceph-devel
-.. _Gmane: http://news.gmane.org/gmane.comp.file-systems.ceph.devel
-.. _Tracker: http://tracker.newdream.net/projects/ceph
-.. _Blog: http://ceph.com/community/blog/
-.. _support: http://inktank.com

diff --git a/doc/start/get-involved.rst b/doc/start/get-involved.rst
new file mode 100644 (file)
index 0000000..0a350a5
--- /dev/null
+++ b/doc/start/get-involved.rst
@@ -0,0 +1,50 @@
+=====================================
+ Get Involved in the Ceph Community!
+=====================================
+These are exciting times in the Ceph community! Get involved!
+
++-----------------+-------------------------------------------------+-----------------------------------------------+
+|Channel          | Description                                     | Contact Info                                  |
++=================+=================================================+===============================================+
+| **Blog**        | Check the Ceph Blog_ periodically to keep track | http://ceph.com/community/blog/               |
+|                 | of Ceph progress and important announcements.   |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+| **IRC**         | As you delve into Ceph, you may have questions  |                                               |
+|                 | or feedback for the Ceph development team. Ceph | - **Domain:** ``irc.oftc.net``                |
+|                 | developers are often available on the ``#ceph`` | - **Channel:** ``#ceph``                      |
+|                 | IRC channel particularly during daytime hours   |                                               |
+|                 | in the US Pacific Standard Time zone.           |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+| **Email List**  | Keep in touch with developer activity by        |                                               |
+|                 | subscribing_ to the email list at               | - Subscribe_                                  |
+|                 | ceph-devel@vger.kernel.org. You can opt out of  | - Unsubscribe_                                |
+|                 | the email list at any time by unsubscribing_.   | - Gmane_                                      |
+|                 | A simple email is all it takes! If you would    |                                               |
+|                 | like to view the archives, go to Gmane_.        |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+| **Bug Tracker** | You can help keep Ceph production worthy by     | http://tracker.newdream.net/projects/ceph     |
+|                 | filing and tracking bugs, and providing feature |                                               |
+|                 | requests using the Bug Tracker_.                |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+| **Source Code** | If you would like to participate in             |                                               |
+|                 | development, bug fixing, or if you just want    | - http://github.com:ceph/ceph                 |
+|                 | the very latest code for Ceph, you can get it   | - http://ceph.com/download                    |
+|                 | at http://github.com. See `Ceph Source Code`_   |                                               |
+|                 | for details on cloning from github.             |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+| **Support**     | If you have a very specific problem, an         | http://inktank.com                            |
+|                 | immediate need, or if your deployment requires  |                                               |
+|                 | significant help, consider commercial support_. |                                               |
++-----------------+-------------------------------------------------+-----------------------------------------------+
+
+
+
+.. _Subscribe: mailto:majordomo@vger.kernel.org?body=subscribe+ceph-devel
+.. _Unsubscribe: mailto:majordomo@vger.kernel.org?body=unsubscribe+ceph-devel
+.. _subscribing: mailto:majordomo@vger.kernel.org?body=subscribe+ceph-devel
+.. _unsubscribing: mailto:majordomo@vger.kernel.org?body=unsubscribe+ceph-devel
+.. _Gmane: http://news.gmane.org/gmane.comp.file-systems.ceph.devel
+.. _Tracker: http://tracker.newdream.net/projects/ceph
+.. _Blog: http://ceph.com/community/blog/
+.. _support: http://inktank.com
+.. _Ceph Source Code: ../../source/
\ No newline at end of file

diff --git a/doc/start/index.rst b/doc/start/index.rst
index 62cbdeea933c6f5937b74cc7b0bd189080fcba96..29fa0ac6e2d5153ba1de5e4b94b8de6da6051a25 100644 (file)
--- a/doc/start/index.rst
+++ b/doc/start/index.rst
@@ -6,5 +6,5 @@ get started:
 
 .. toctree::
 
-   Get Involved <get-involved-in-the-ceph-community>
+   Get Involved <get-involved>
    quick-start