From: Sage Weil <sage@redhat.com>
Date: Wed, 22 Jun 2016 18:13:28 +0000 (-0400)
Subject: README.md: simplify cmake instructions around do_cmake.sh
X-Git-Tag: v11.0.0~66^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=d30125e2b9845dfd483622f5b32e9be80cdd5d76;p=ceph.git

README.md: simplify cmake instructions around do_cmake.sh

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>
---

diff --git a/README.md b/README.md
index 5a2d8f15dcd6..8f6106b5bba8 100644
--- a/README.md
+++ b/README.md
@@ -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
 ==========================