From: Mark Nelson <mnelson@redhat.com>
Date: Mon, 10 Dec 2018 23:55:36 +0000 (-0600)
Subject: doc/install: Add note about default do_cmake.sh debug builds.
X-Git-Tag: v14.1.0~628^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=51e2d4c481feb6203b3bebc6c4904f127e6e085a;p=ceph.git

doc/install: Add note about default do_cmake.sh debug builds.

Signed-off-by: Mark Nelson <mnelson@redhat.com>
---

diff --git a/doc/install/build-ceph.rst b/doc/install/build-ceph.rst
index 3010909878eb..147986e4c7d0 100644
--- a/doc/install/build-ceph.rst
+++ b/doc/install/build-ceph.rst
@@ -32,6 +32,11 @@ repository and execute the following::
     cd build
     make
 
+.. note:: By default do_cmake.sh will build a debug version of ceph that may
+   perform up to 5 times slower with certain workloads. Pass 
+   '-DCMAKE_BUILD_TYPE=RelWithDebInfo' to do_cmake.sh if you would like to
+   build a release version of the ceph executables instead.
+
 .. topic:: Hyperthreading
 
 	You can use ``make -j`` to execute multiple jobs depending upon your system. For