← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/source/building-ceph.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/building-ceph.rst
 
1
===============
 
2
 Building Ceph
 
3
===============
 
4
Ceph provides build scripts for source code and for documentation.
 
5
 
 
6
Building Ceph
 
7
-------------
 
8
Ceph provides ``automake`` and ``configure`` scripts to streamline the build 
 
9
process. To build Ceph, navigate to your cloned Ceph repository and execute the 
 
10
following::
 
11
 
 
12
        cd ceph
 
13
        ./autogen.sh
 
14
        ./configure
 
15
        make
 
16
 
 
17
You can use ``make -j`` to execute multiple jobs depending upon your system. For 
 
18
example::
 
19
 
 
20
        make -j4
 
21
 
 
22
To install Ceph locally, you may also use::
 
23
 
 
24
        sudo make install
 
25
 
 
26
If you install Ceph locally, ``make`` will place the executables in 
 
27
``usr/local/bin``. You may add the ``ceph.conf`` file to the ``usr/local/bin`` 
 
28
directory to run an evaluation environment of Ceph from a single directory.
 
29
 
 
30
Building Ceph Documentation
 
31
---------------------------
 
32
Ceph utilizes Python’s Sphinx documentation tool. For details on the Sphinx 
 
33
documentation tool, refer to: `Sphinx`_. To build the Ceph documentaiton, 
 
34
navigate to the Ceph repository and execute the build script::
 
35
 
 
36
        cd ceph
 
37
        admin/build-doc
 
38
 
 
39
Once you build the documentation set, you may navigate to the source directory to view it::
 
40
 
 
41
        cd build-doc/output
 
42
 
 
43
There should be an ``/html`` directory and a ``/man`` directory containing 
 
44
documentation in HTML and manpage formats respectively.
 
45
 
 
46
.. _Sphinx: http://sphinx.pocoo.org
 
 
b'\\ No newline at end of file'