Permalink
Browse files

doc: Whitespace cleanup.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
  • Loading branch information...
1 parent 93dcc98 commit 5465e810977d5621f107bf1fea1a4740e11a3290 Tommi Virtanen committed May 3, 2012
View
56 README
@@ -27,8 +27,8 @@ Building Ceph
=============
To prepare the source tree after it has been git cloned,
-
- $ git submodule update --init
+
+ $ git submodule update --init
To build the server daemons, and FUSE client, execute the following:
@@ -72,19 +72,19 @@ Building the Documentation
Prerequisites
-------------
-To build the documentation, you must install the following:
+To build the documentation, you must install the following:
-- python-dev
-- python-pip
-- python-virualenv
-- doxygen
+- python-dev
+- python-pip
+- python-virualenv
+- doxygen
- ditaa
-- libxml2-dev
-- libxslt-dev
-- dot
+- libxml2-dev
+- libxslt-dev
+- dot
- graphviz
-For example:
+For example:
sudo apt-get install python-dev python-pip python-virualenv doxygen ditaa libxml2-dev libxslt-dev dot graphviz
@@ -98,25 +98,23 @@ To build the documentation, ensure that you are in the top-level `/ceph director
Build Prerequisites
-------------------
-To build the source code, you must install the following:
-
-- automake
-- autoconf
-- automake
-- gcc
-- g++
-- libboost-dev
-- libedit-dev
-- libssl-dev
-- libtool
-- libfcgi
-- libfcgi-dev
-- libfuse-dev
-- linux-kernel-headers
+To build the source code, you must install the following:
+
+- automake
+- autoconf
+- automake
+- gcc
+- g++
+- libboost-dev
+- libedit-dev
+- libssl-dev
+- libtool
+- libfcgi
+- libfcgi-dev
+- libfuse-dev
+- linux-kernel-headers
- libcrypto++-dev
-For example:
+For example:
$ apt-get install automake autoconf automake gcc g++ libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev
-
-
View
@@ -11,7 +11,7 @@ API
- :doc:`Authentication and ACLs <s3/authentication>`
- :doc:`Service Operations <s3/serviceops>`
- :doc:`Bucket Operations <s3/bucketops>`
-- :doc:`Object Operations <s3/objectops>`
+- :doc:`Object Operations <s3/objectops>`
.. toctree::
@@ -23,7 +23,7 @@ API
Service Ops <s3/serviceops>
Bucket Ops <s3/bucketops>
Object Ops <s3/objectops>
-
+
Features Support
----------------
@@ -1,8 +1,8 @@
Authentication and ACLs
=======================
-Requests to the RADOS Gateway (RGW) can be either authenticated or unauthenticated.
-RGW assumes unauthenticated requests are sent by an anonymous user. RGW supports
-canned ACLs.
+Requests to the RADOS Gateway (RGW) can be either authenticated or unauthenticated.
+RGW assumes unauthenticated requests are sent by an anonymous user. RGW supports
+canned ACLs.
Authentication
--------------
@@ -22,7 +22,7 @@ approach. The HTTP header signing is similar to OAuth 1.0, but avoids the comple
Authorization: AWS {access-key}:{hash-of-header-and-secret}
-In the foregoing example, replace ``{access-key}`` with the value for your access key ID followed by
+In the foregoing example, replace ``{access-key}`` with the value for your access key ID followed by
a colon (``:``). Replace ``{hash-of-header-and-secret}`` with a hash of the header string and the secret
corresponding to the access key ID.
@@ -32,13 +32,13 @@ To generate the hash of the header string and secret, you must:
str = "HTTP/1.1\nPUT /buckets/bucket/object.mpeg\nHost: cname.domain.com\n
Date: Mon, 2 Jan 2012 00:01:01 +0000\nContent-Length: 9999999\nContent-Encoding: mpeg";
-
+
secret = "valueOfSecret";
2. Generate an HMAC using a SHA-1 hashing algorithm. ::
-
+
hmac = object.hmac-sha1(str, secret);
-
+
3. Encode the ``hmac`` result using base-64. ::
encodedHmac = someBase64Encoder.encode(hmac);
@@ -64,4 +64,4 @@ Each grant has a different meaning when applied to a bucket versus applied to an
| ``WRITE_ACP`` | Grantee can write bucket ACL. | Grantee can write to the object ACL. |
+------------------+--------------------------------------------------------+----------------------------------------------+
| ``FULL_CONTROL`` | Grantee has full permissions for object in the bucket. | Grantee can read or write to the object ACL. |
-+------------------+--------------------------------------------------------+----------------------------------------------+
++------------------+--------------------------------------------------------+----------------------------------------------+
View
@@ -10,11 +10,11 @@ create buckets as an anonymous user.
Constraints
~~~~~~~~~~~
-In general, bucket names should follow domain name constraints.
+In general, bucket names should follow domain name constraints.
- Bucket names must be unique.
-- Bucket names must begin and end with a lowercase letter.
-- Bucket names may contain a dash (-).
+- Bucket names must begin and end with a lowercase letter.
+- Bucket names may contain a dash (-).
Syntax
~~~~~~
@@ -24,7 +24,7 @@ Syntax
PUT /{bucket} HTTP/1.1
Host: cname.domain.com
x-amz-acl: public-read-write
-
+
Authorization: AWS {access-key}:{hash-of-header-and-secret}
Parameters
@@ -41,8 +41,8 @@ Parameters
HTTP Response
~~~~~~~~~~~~~
-If the bucket name is unique, within constraints and unused, the operation will succeed.
-If a bucket with the same name already exists and the user is the bucket owner, the operation will succeed.
+If the bucket name is unique, within constraints and unused, the operation will succeed.
+If a bucket with the same name already exists and the user is the bucket owner, the operation will succeed.
If the bucket name is already in use, the operation will fail.
+---------------+-----------------------+----------------------------------------------------------+
@@ -63,7 +63,7 @@ Syntax
DELETE /{bucket} HTTP/1.1
Host: cname.domain.com
-
+
Authorization: AWS {access-key}:{hash-of-header-and-secret}
HTTP Response
@@ -115,7 +115,7 @@ HTTP Response
Bucket Response Entities
~~~~~~~~~~~~~~~~~~~~~~~~
-``GET /{bucket}`` returns a container for buckets with the following fields.
+``GET /{bucket}`` returns a container for buckets with the following fields.
+------------------------+-----------+----------------------------------------------------------------------------------+
| Name | Type | Description |
@@ -238,7 +238,7 @@ List Bucket Multipart Uploads
-----------------------------
``GET /?uploads`` returns a list of the current in-progress multipart uploads--i.e., the application initiates a multipart upload, but
-the service hasn't completed all the uploads yet.
+the service hasn't completed all the uploads yet.
Syntax
~~~~~~
@@ -266,7 +266,7 @@ You may specify parameters for ``GET /{bucket}?uploads``, but none of them are r
| ``max-uploads`` | Integer | The maximum number of multipart uploads. The range from 1-1000. The default is 1000. |
+------------------------+-----------+--------------------------------------------------------------------------------------+
| ``upload-id-marker`` | String | Ignored if ``key-marker`` isn't specified. Specifies the ``ID`` of first |
-| | | upload to list in lexicographical order at or following the ``ID``. |
+| | | upload to list in lexicographical order at or following the ``ID``. |
+------------------------+-----------+--------------------------------------------------------------------------------------+
View
@@ -7,7 +7,7 @@ Common Entities
Bucket and Host Name
--------------------
-There are two different modes of accessing the buckets. The first (preferred) method
+There are two different modes of accessing the buckets. The first (preferred) method
identifies the bucket as the top-level directory in the URI. ::
GET /mybucket HTTP/1.1
View
@@ -334,7 +334,7 @@ Syntax
::
- POST /{bucket}/{object}?uploadId= HTTP/1.1
+ POST /{bucket}/{object}?uploadId= HTTP/1.1
Request Entities
~~~~~~~~~~~~~~~~
@@ -377,5 +377,3 @@ Syntax
::
DELETE /{bucket}/{object}?uploadId= HTTP/1.1
-
-
@@ -3,7 +3,7 @@ Service Operations
List Buckets
------------
-``GET /`` returns a list of buckets created by the user making the request. ``GET /`` only
+``GET /`` returns a list of buckets created by the user making the request. ``GET /`` only
returns buckets created by an authenticated user. You cannot make an anonymous request.
Syntax
@@ -12,7 +12,7 @@ Syntax
GET / HTTP/1.1
Host: cname.domain.com
-
+
Authorization: AWS {access-key}:{hash-of-header-and-secret}
Response Entities
@@ -37,4 +37,3 @@ Response Entities
+----------------------------+-------------+-----------------------------------------------------------------+
| ``DisplayName`` | String | The bucket owner's display name. |
+----------------------------+-------------+-----------------------------------------------------------------+
-
Oops, something went wrong.

0 comments on commit 5465e81

Please sign in to comment.