]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/README.md: improve formatting 59787/head
authorZac Dover <zac.dover@proton.me>
Wed, 11 Sep 2024 12:50:35 +0000 (22:50 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 21 Jan 2025 05:19:56 +0000 (15:19 +1000)
Improve the formatting in the section "Building Ceph" in the file
README.md.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit b9ca3957303989bbba9301cbbd18ba8faa0b8168)

README.md

index fea37891069fa5bbad32bb74474f3ec47b9b4fc9..ab609541dd9d36ac5cceef539957426fdbd52eb9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -96,16 +96,32 @@ five times slower than a non-debug build.  Pass
 ``-DCMAKE_BUILD_TYPE=RelWithDebInfo`` to ``do_cmake.sh`` to create a non-debug
 build.
 
-[Ninja](https://ninja-build.org/) is the buildsystem used by the Ceph project
-to build test builds.  The number of jobs used by `ninja` is derived from the
-number of CPU cores of the building host if unspecified. Use the `-j` option to
-limit the job number if the build jobs are running out of memory. If you
-attempt to run `ninja` and receive a message that reads `g++: fatal error:
-Killed signal terminated program cc1plus`, then you have run out of memory.
-Using the `-j` option with an argument appropriate to the hardware on which the
-`ninja` command is run is expected to result in a successful build. For example,
-to limit the job number to 3, run the command `ninja -j 3`. On average, each
-`ninja` job run in parallel needs approximately 2.5 GiB of RAM.
+          ``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``
+       4. Use the `ninja` buildsystem to build the development environment:
+
+              ninja -j3
+
+          > [IMPORTANT]
+          >
+          > [Ninja](https://ninja-build.org/) is the build system used by the Ceph
+          > project to build test builds.  The number of jobs used by `ninja` is 
+          > derived from the number of CPU cores of the building host if unspecified. 
+          > Use the `-j` option to limit the job number if build jobs are running 
+          > out of memory. If you attempt to run `ninja` and receive a message that 
+          > reads `g++: fatal error: Killed signal terminated program cc1plus`, then 
+          > you have run out of memory.
+          >
+          > Using the `-j` option with an argument appropriate to the hardware on
+          > which the `ninja` command is run is expected to result in a successful
+          > build. For example, to limit the job number to 3, run the command `ninja
+          > -j3`. On average, each `ninja` job run in parallel needs approximately
+          > 2.5 GiB of RAM.
 
    This documentation assumes that your build directory is a subdirectory of
    the `ceph.git` checkout. If the build directory is located elsewhere, point
@@ -117,11 +133,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