$ make -j4
+To install Ceph locally, you may also use::
+
+ $ make install
+
Building Ceph Documentation
===========================
Ceph utilizes Python’s Sphinx documentation tool. For details on the Sphinx documentation tool, refer to: `Sphinx <http://sphinx.pocoo.org>`_. To build the Ceph documentaiton, navigate to the Ceph repository and execute the build script::
$ ssh-keygen -d
-Get the key to add to your ``github`` account::
+Get the key to add to your ``github`` account (the following example assumes you used the default file path)::
$ cat .ssh/id_dsa.pub
Clone the Submodules
--------------------
-Before you can build Ceph, you must get the ``init`` submodule and the ``update`` submodule::
+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.
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
- * :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>`
+- :doc:`Build Prerequisites <build_from_source/build_prerequisites>`
+- :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>`
+- :doc:`Building Ceph<build_from_source/building_ceph>`
+- :doc:`Building Ceph Install Packages <build_from_source/build_packages>`
+
.. toctree::
:hidden:
Get a Release <build_from_source/downloading_a_ceph_release>
Clone the Source <build_from_source/cloning_the_ceph_source_code_repository>
Build the Source <build_from_source/building_ceph>
- Installation <build_from_source/installing_rados_processes_and_daemons>
+ Build a Package <build_from_source/build_packages>
\ No newline at end of file