From 9b487571e662993d207a3429f5a9a461a6ed3123 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Thu, 12 Apr 2012 11:35:45 -0700 Subject: [PATCH] Minor cleanup. Signed off by: John Wilkins Signed-off-by: Tommi Virtanen --- .../build_from_source/build_prerequisites.rst | 46 +++++++++---------- doc/install/building_ceph_from_source.rst | 9 ++-- doc/install/index.rst | 15 +++--- 3 files changed, 36 insertions(+), 34 deletions(-) diff --git a/doc/install/build_from_source/build_prerequisites.rst b/doc/install/build_from_source/build_prerequisites.rst index 481cd3ef2a9b9..5d364c9c9bb87 100644 --- a/doc/install/build_from_source/build_prerequisites.rst +++ b/doc/install/build_from_source/build_prerequisites.rst @@ -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 `_ -Follow the directions at `Sphinx 1.1.3 `_ -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 `_ +Follow the directions at `Sphinx 1.1.3 `_ +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 + diff --git a/doc/install/building_ceph_from_source.rst b/doc/install/building_ceph_from_source.rst index 29a4957fdbbf3..34a3dbae7bb58 100644 --- a/doc/install/building_ceph_from_source.rst +++ b/doc/install/building_ceph_from_source.rst @@ -2,14 +2,13 @@ Building Ceph from Source ========================= - +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 ` 2. Get Source Code - - a. :doc:`Downloading a Ceph Release ` - b. :doc:`Cloning the Ceph Source Code Repository ` - + * :doc:`Downloading a Ceph Release ` + * :doc:`Cloning the Ceph Source Code Repository ` 3. :doc:`Building Ceph` 4. :doc:`Installing RADOS Processes and Daemons ` diff --git a/doc/install/index.rst b/doc/install/index.rst index 6cfa0b499cb01..48355472a6b1d 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -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 ` -2. :doc:`File System Requirements ` -3. :doc:`Download Packages ` +The following sections provide guidance for configuring a storage cluster and installing Ceph components: + +1. :doc:`Hardware Recommendations ` +2. :doc:`File System Recommendations ` +3. :doc:`Download Ceph Packages ` 4. :doc:`Building Ceph from Source ` -- 2.39.5