ceph/doc/source/building-ceph.rst
John Wilkins 812989bf35 doc: misc updates
doc/architecture.rst - removed broken reference.
doc/config-cluster - cleanup and added chef
doc/install - Made generic to add Chef, OpenStack and libvert installs
doc/init - Created light start | stop and health section
doc/source - Removed $ from code examples. Trimmed paras to 80 char
doc/images - Added preliminary diagram for Chef.
doc/rec - Added reference to hardware. Added filesystem info.

Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-21 16:39:15 -07:00

46 lines
1.3 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

===============
Building Ceph
===============
Ceph provides build scripts for source code and for documentation.
Building Ceph
-------------
Ceph provides ``automake`` and ``configure`` scripts to streamline the build
process. To build Ceph, navigate to your cloned Ceph repository and execute the
following::
cd ceph
./autogen.sh
./configure
make
You can use ``make -j`` to execute multiple jobs depending upon your system. For
example::
make -j4
To install Ceph locally, you may also use::
sudo make install
If you install Ceph locally, ``make`` will place the executables in
``usr/local/bin``. You may add the ``ceph.conf`` file to the ``usr/local/bin``
directory to run an evaluation environment of Ceph from a single directory.
Building Ceph Documentation
---------------------------
Ceph utilizes Pythons Sphinx documentation tool. For details on the Sphinx
documentation tool, refer to: `Sphinx`_. To build the Ceph documentaiton,
navigate to the Ceph repository and execute the build script::
cd ceph
admin/build-doc
Once you build the documentation set, you may navigate to the source directory to view it::
cd build-doc/output
There should be an ``/html`` directory and a ``/man`` directory containing
documentation in HTML and manpage formats respectively.
.. _Sphinx: http://sphinx.pocoo.org