Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

do_cmake: warn users about slow debug builds #25478

Merged
merged 3 commits into from
Dec 13, 2018
Merged

do_cmake: warn users about slow debug builds #25478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d433522
do_cmake: Warn user about slow debug performance by default.
Dec 10, 2018
51e2d4c
doc/install: Add note about default do_cmake.sh debug builds.
Dec 10, 2018
3214b71
README.md: Add note about default do_cmake.sh debug builds.
Dec 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ Build instructions:
cd build
make

(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
release.)

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
Expand Down
8 changes: 8 additions & 0 deletions do_cmake.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,11 @@ erasure code dir = lib
EOF

echo done.
cat <<EOF

****
WARNING: do_cmake.sh now creates debug builds by default. Performance
may be severely affected. Please use -DCMAKE_BUILD_TYPE=RelWithDebInfo
if a performance sensitive build is required.
****
EOF
5 changes: 5 additions & 0 deletions doc/install/build-ceph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down