mirror of
https://github.com/ceph/ceph
synced 2024-12-15 07:56:12 +00:00
93dcc9886f
This makes the-separate-words in the url match as separate words in searches, where this_way only matches an explicit "this_way" search. http://www.mattcutts.com/blog/dashes-vs-underscores/ Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
39 lines
1.3 KiB
ReStructuredText
39 lines
1.3 KiB
ReStructuredText
=============
|
||
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::
|
||
|
||
$ 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 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::
|
||
|
||
$ 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.
|