summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthew Oliver <moliver@suse.com>2019-10-25 07:20:22 +0200
committerMatthew Oliver <moliver@suse.com>2019-11-04 01:30:09 +0100
commiteb33b30d3db3191dcca67136653db32f2fed3aff (patch)
treece07c0203b57970466d4bfd573918f63783e12dd /README.md
parentMerge pull request #31326 from cbodley/wip-cmake-mgr-cap (diff)
downloadceph-eb33b30d3db3191dcca67136653db32f2fed3aff.tar.xz
ceph-eb33b30d3db3191dcca67136653db32f2fed3aff.zip
do_cmake.sh: Add CEPH_GIT_DIR
This patch adds a new env variables that users can set to define the location of the checked out ceph git repo. The documentation mentions having to go edit the script directly to point to the ceph git directory if the build dir isn't in the top directory of the checked out git repo. This patch changes the '..' into an env variable, CEPH_GIT_DIR, that defaults to '..'. To make it easy to script and change. This allows someone to do things like: export CEPH_GIT_DIR=~/git/ceph ./do_cmake.sh or CEPH_GIT_DIR=~/git/ceph ./do_cmake.sh Which is much better then editing the script directly. The README.md has been modified to mention this variable and also includes a drive by to mention `make -j` for new contributors to build ceph quicker. Signed-off-by: Matthew Oliver <moliver@suse.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2db7458450e..fd66a06f381 100644
--- a/README.md
+++ b/README.md
@@ -61,13 +61,17 @@ Build instructions:
(Note: do_cmake.sh now defaults to creating a debug build of ceph that can
be up to 5x slower with some workloads. Please pass
-"-DCMAKE_BUILD_TYPE=RelWithDebInfo" to do_cmake.sh to create a non-debug
+"-DCMAKE_BUILD_TYPE=RelWithDebInfo" to do_cmake.sh to create a non-debug
release.)
+(Note: `make` alone will use only one CPU thread, this could take a while. use
+the `-j` option to use more threads. Something like `make -j$(nproc)` would be
+a good start.
+
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
-correct path to the checkout. Any additional CMake args can be specified
-setting ARGS before invoking do_cmake. See [cmake options](#cmake-options)
+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
+before invoking do_cmake. See [cmake options](#cmake-options)
for more details. Eg.
ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh