From d0d161647985ff826addc743fab208a917a516b1 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sat, 14 Sep 2024 18:46:56 +1000 Subject: [PATCH] doc/README.md: create selectable commands An indentation of five spaces relative to the previous line creates a command that is copyable with a single mouse click. This commit adds those copyabale commands to the procedure in the section "Building Ceph". Signed-off-by: Zac Dover (cherry picked from commit 36c620b04f3a88562d75955b46cc1864de60ce70) --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2fadda20366f..a978bad80ff8 100644 --- a/README.md +++ b/README.md @@ -78,10 +78,15 @@ To build Ceph, follow this procedure: contains `do_cmake.sh` and `CONTRIBUTING.rst`. 2. Run the `do_cmake.sh` script: - >``./do_cmake.sh`` + ./do_cmake.sh + + ``do_cmake.sh`` by default creates a "debug build" of Ceph, which can be + up to five times slower than a non-debug build. Pass + ``-DCMAKE_BUILD_TYPE=RelWithDebInfo`` to ``do_cmake.sh`` to create a + non-debug build. 3. Move into the `build` directory: - >``cd build`` + cd build 4. Use the `ninja` buildsystem to build the development environment: >``ninja`` @@ -112,11 +117,11 @@ to limit the job number to 3, run the command `ninja -j 3`. On average, each To build only certain targets, run a command of the following form: - ninja [target name] + ninja [target name] 5. Install the vstart cluster: - ninja install + ninja install ### CMake Options -- 2.47.3