## Contributing Code
Most of Ceph is dual licensed under the LGPL version 2.1 or 3.0. Some
-miscellaneous code is under BSD-style license or is public domain.
+miscellaneous code is under a BSD-style license or is public domain.
The documentation is licensed under Creative Commons
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
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,
+suitable for installation we recommend you build deb or rpm packages
or refer to the `ceph.spec.in` or `debian/rules` to see which
configuration options are specified for production builds.
This assumes you make your build dir a subdirectory of the ceph.git
checkout. If you put it elsewhere, just point `CEPH_GIT_DIR` to the correct
-path to the checkout. Any additional CMake args can be specified setting ARGS
+path to the checkout. Any additional CMake args can be specified by setting ARGS
before invoking do_cmake. See [cmake options](#cmake-options)
for more details. Eg.
### CMake Options
If you run the `cmake` command by hand, there are many options you can
-set with "-D". For example the option to build the RADOS Gateway is
+set with "-D". For example, the option to build the RADOS Gateway is
defaulted to ON. To build without the RADOS Gateway:
- cmake -DWITH_RADOSGW=OFF [path to top level ceph directory]
+ cmake -DWITH_RADOSGW=OFF [path to top-level ceph directory]
Another example below is building with debugging and alternate locations
for a couple of external dependencies:
diagnostic colors for errors and warnings (and if your compiler
supports it), you can invoke `cmake` with:
- cmake -DDIAGNOSTICS_COLOR=always ..
+ cmake -DDIAGNOSTICS_COLOR=always ...
Then you'll get the diagnostic colors when you execute:
ctest -V -R [regex matching test name(s)]
-To run an tests manually and run the jobs in parallel, run `ctest` with
+To run tests manually and run the jobs in parallel, run `ctest` with
the `-j` flag:
ctest -j [number of jobs]