RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-03-25 11:48:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

README.md: simplify cmake instructions around do_cmake.sh

Browse Source 
Be prescriptive about the 'build' subdir, at least for the purposes of
this document (developer quick start).

Signed-off-by: Sage Weil <sage@redhat.com>
This commit is contained in:
Sage Weil 2016-06-22 14:13:28 -04:00
parent 563c71d97f
commit d30125e2b9
1 changed files with 13 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -4,6 +4,7 @@ Ceph - a scalable distributed storage system
Please see http://ceph.com/ for current info.
Contributing Code
=================
@ -72,9 +73,8 @@ Prerequisite:
Build instructions:
mkdir build
./do_cmake.sh
cd build
cmake [options] ..
make
This assumes you make your build dir a subdirectory of the ceph.git
@ -126,14 +126,11 @@ To start or stop individual daemons, the sysvinit script should work:
CMake
-----
Any commands or paths related to CMake are from the "build"
directory. This directory, known as ${CMAKE_BINARY_DIR} to cmake, was created
in the section above titled "Building Ceph".
To run a functional test cluster,
cd build
./path/to/ceph/src/vstart.sh -d -n -x -l
../src/vstart.sh -d -n -x -l
./bin/ceph -s
Almost all of the usual commands are available in the bin/ directory.
@ -144,13 +141,14 @@ For example,
To shut down the test cluster,
./path/to/ceph/src/stop.sh
../src/stop.sh
To start or stop individual daemons, the sysvinit script should work:
To start or stop individual daemons, the sysvinit script can be used:
./bin/init-ceph restart osd.0
./bin/init-ceph stop
Running unit tests
==================
@ -184,24 +182,18 @@ like so:
CMake
-----
Any commands or paths related to CMake are from the "build"
directory. This directory, known as ${CMAKE_BINARY_DIR} to cmake, was created
in the section above titled "Building Ceph".
To run build and run all tests, run `make check`. `make check` builds all the
unit tests, all the dependencies for other tests, and executes them with ctest
command.
To run build and run all tests, use ctest:
cd build
cmake [options] ..
make check
ctest -j$(nproc)
To run an individual test manually, run the ctest command with -R (regex matching):
To run an individual test manually, run the ctest command with -R
(regex matching):
ctest -R [test name]
To run an individual test manually and see all the tests output, run the ctest
command with the -V (verbose) flag:
To run an individual test manually and see all the tests output, run
the ctest command with the -V (verbose) flag:
ctest -V -R [test name]
@ -215,6 +207,7 @@ over manual test execution. To view these options run:
man ctest
Building the Documentation
==========================