Most of Ceph is licensed under the LGPL version 2.1. Some
miscellaneous code is under BSD-style license or is public domain.
The documentation is licensed under Creative Commons
-Attribution-ShareAlike (CC BY-SA). There are a handful of headers
+Attribution Share Alike 3.0 (CC-BY-SA-3.0). There are a handful of headers
included here that are licensed under the GPL. Please see the file
COPYING for a full inventory of licenses by file.
Note that these instructions are meant for developers who are
compiling the code for development and testing. To build binaries
suitable for installation we recommend you build deb or rpm packages,
-or refer to the ceph.spec.in or debian/rules to see which
+or refer to the `ceph.spec.in` or `debian/rules` to see which
configuration options are specified for production builds.
Prerequisite: CMake 2.8.11
make
This assumes you make your build dir a subdirectory of the ceph.git
-checkout. If you put it elsewhere, just replace .. in do_cmake.sh with a
+checkout. If you put it elsewhere, just replace `..` in do_cmake.sh with a
correct path to the checkout.
To build only certain targets use:
ctest -V -R [regex matching test name(s)]
To run an tests manually and run the jobs in parallel, run `ctest` with
-the -j flag:
+the `-j` flag:
ctest -j [number of jobs]
### Prerequisites
The list of package dependencies for building the documentation can be
-found in doc_deps.deb.txt:
+found in `doc_deps.deb.txt`:
sudo apt-get install `cat doc_deps.deb.txt`
### Building the Documentation
To build the documentation, ensure that you are in the top-level
-`/ceph directory, and execute the build script. For example:
+`/ceph` directory, and execute the build script. For example:
admin/build-doc