]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Minor cleanup.
authorJohn Wilkins <john.wilkins@dreamhost.com>
Thu, 12 Apr 2012 18:35:45 +0000 (11:35 -0700)
committerTommi Virtanen <tommi.virtanen@dreamhost.com>
Wed, 2 May 2012 19:09:55 +0000 (12:09 -0700)
Signed off by: John Wilkins <john.wilkins@dreamhost.com>

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
doc/install/build_from_source/build_prerequisites.rst
doc/install/building_ceph_from_source.rst
doc/install/index.rst

index 481cd3ef2a9b9376cbb7882dfbcc5428c27c7247..5d364c9c9bb875d14611b915f8887377166f3cd8 100644 (file)
@@ -2,31 +2,10 @@
 Build Prerequisites
 ===================
 
-Before you can build Ceph documentation or Ceph source code, you need to install several libraries and tools.
+Before you can build Ceph source code or Ceph documentation, you need to install several libraries and tools.
 
 .. tip:: Check this section to see if there are specific prerequisites for your Linux/Unix distribution.
 
-
-Prerequisites for Building Ceph Documentation
-=============================================
-Ceph utilizes Python's Sphinx documentation tool. For details on
-the Sphinx documentation tool, refer to: `Sphinx <http://sphinx.pocoo.org>`_
-Follow the directions at `Sphinx 1.1.3 <http://pypi.python.org/pypi/Sphinx>`_
-to install Sphinx. To run Sphinx, with `admin/build-doc`, at least the following are required:
-
-- ``python-dev``
-- ``python-pip``
-- ``python-virtualenv``
-- ``libxml2-dev``
-- ``libxslt-dev``
-- ``doxygen``
-- ``ditaa``
-- ``graphviz``
-
-Execute ``sudo apt-get install`` for each dependency that isn't installed on your host. ::
-
-       $ sudo apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz
-
 Prerequisites for Building Ceph Source Code
 ===========================================
 Ceph provides ``autoconf`` and ``automake`` scripts to get you started quickly. Ceph build scripts
@@ -102,4 +81,25 @@ openSUSE 11.2 (and later)
 
 Execute ``zypper install`` for each dependency that isn't installed on your host. ::
 
-       $zypper install boost-devel gcc-c++ libedit-devel libopenssl-devel fuse-devel   
\ No newline at end of file
+       $zypper install boost-devel gcc-c++ libedit-devel libopenssl-devel fuse-devel   
+
+Prerequisites for Building Ceph Documentation
+=============================================
+Ceph utilizes Python's Sphinx documentation tool. For details on
+the Sphinx documentation tool, refer to: `Sphinx <http://sphinx.pocoo.org>`_
+Follow the directions at `Sphinx 1.1.3 <http://pypi.python.org/pypi/Sphinx>`_
+to install Sphinx. To run Sphinx, with `admin/build-doc`, at least the following are required:
+
+- ``python-dev``
+- ``python-pip``
+- ``python-virtualenv``
+- ``libxml2-dev``
+- ``libxslt-dev``
+- ``doxygen``
+- ``ditaa``
+- ``graphviz``
+
+Execute ``sudo apt-get install`` for each dependency that isn't installed on your host. ::
+
+       $ sudo apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz
+
index 29a4957fdbbf3c58a89f0e3c20f8dda8b4f576e2..34a3dbae7bb58cadbb6fd9f81c76b2208e061eac 100644 (file)
@@ -2,14 +2,13 @@
 Building Ceph from Source
 =========================
 
-<placeholder>
+You can build Ceph from source by downloading a release or cloning the ``ceph`` repository at github. If you intend to build Ceph
+from source, please see the build pre-requisites first. Making sure you have all the pre-requisites will save you time.
 
 1. :doc:`Build Prerequisites <build_from_source/build_prerequisites>`
 2. Get Source Code
-
-       a. :doc:`Downloading a Ceph Release <build_from_source/downloading_a_ceph_release>`
-       b. :doc:`Cloning the Ceph Source Code Repository <build_from_source/cloning_the_ceph_source_code_repository>`
-
+       * :doc:`Downloading a Ceph Release <build_from_source/downloading_a_ceph_release>`
+       * :doc:`Cloning the Ceph Source Code Repository <build_from_source/cloning_the_ceph_source_code_repository>`
 3. :doc:`Building Ceph<build_from_source/building_ceph>`
 4. :doc:`Installing RADOS Processes and Daemons <build_from_source/installing_rados_processes_and_daemons>`
 
index 6cfa0b499cb018eaf6a5c460394114c542fb5da1..48355472a6b1d795047178d4bd9250e3ce870eca 100644 (file)
@@ -1,13 +1,16 @@
 ==========================
 Installing Ceph Components
 ==========================
-Storage clusters are the foundation of the Ceph file system, and they can also provide
-object storage to ``librados``, ``rbd`` and ``radosgw``. The following sections 
-provide guidance for configuring a storage cluster:
+Storage clusters are the foundation of the Ceph system. Ceph storage hosts provide object storage. 
+Clients access the Ceph storage cluster directly from an application (using ``librados``),
+over an object storage protocol such as Amazon S3 or OpenStack Swift (using ``radosgw``), or with a block
+device (using ``rbd``). To begin using Ceph, you must first set up a storage cluster.
 
-1. :doc:`Hardware Requirements <hardware_recommendations>`
-2. :doc:`File System Requirements <file_system_recommendations>`
-3. :doc:`Download Packages <download_packages>`
+The following sections provide guidance for configuring a storage cluster and installing Ceph components:
+
+1. :doc:`Hardware Recommendations <hardware_recommendations>`
+2. :doc:`File System Recommendations <file_system_recommendations>`
+3. :doc:`Download Ceph Packages <download_packages>`
 4. :doc:`Building Ceph from Source <building_ceph_from_source>`