]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/README.md: create selectable commands 59836/head
authorZac Dover <zac.dover@proton.me>
Sat, 14 Sep 2024 08:46:56 +0000 (18:46 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 17 Sep 2024 13:17:55 +0000 (23:17 +1000)
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 <zac.dover@proton.me>
(cherry picked from commit 36c620b04f3a88562d75955b46cc1864de60ce70)

README.md

index da1663a3a8eea34cc2e63d3ffa87bafbc16ece47..fea37891069fa5bbad32bb74474f3ec47b9b4fc9 100644 (file)
--- 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