Skip to content

Commit c105a45

Browse files
doc/README.md - allocate information correctly
Add information in the "Building Ceph" procedure to the steps where it belongs. Add information about "do_cmake.sh" to the step about "do_cmake.sh". Add information about Ninja to the step about Ninja. Co-authored-by: Anthony D'Atri <[email protected]> Signed-off-by: Zac Dover <[email protected]>
1 parent 56744af commit c105a45

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,29 +79,32 @@ To build Ceph, follow this procedure:
7979
contains `do_cmake.sh` and `CONTRIBUTING.rst`.
8080
2. Run the `do_cmake.sh` script:
8181

82-
>``./do_cmake.sh``
82+
``./do_cmake.sh``
83+
84+
``do_cmake.sh`` by default creates a "debug build" of Ceph, which can be
85+
up to five times slower than a non-debug build. Pass
86+
``-DCMAKE_BUILD_TYPE=RelWithDebInfo`` to ``do_cmake.sh`` to create a
87+
non-debug build.
8388
3. Move into the `build` directory:
8489

85-
>``cd build``
90+
``cd build``
8691
4. Use the `ninja` buildsystem to build the development environment:
8792

88-
>``ninja``
89-
90-
``do_cmake.sh`` by default creates a "debug build" of Ceph, which can be up to
91-
five times slower than a non-debug build. Pass
92-
``-DCMAKE_BUILD_TYPE=RelWithDebInfo`` to ``do_cmake.sh`` to create a non-debug
93-
build.
94-
95-
[Ninja](https://ninja-build.org/) is the buildsystem used by the Ceph project
96-
to build test builds. The number of jobs used by `ninja` is derived from the
97-
number of CPU cores of the building host if unspecified. Use the `-j` option to
98-
limit the job number if the build jobs are running out of memory. If you
99-
attempt to run `ninja` and receive a message that reads `g++: fatal error:
100-
Killed signal terminated program cc1plus`, then you have run out of memory.
101-
Using the `-j` option with an argument appropriate to the hardware on which the
102-
`ninja` command is run is expected to result in a successful build. For example,
103-
to limit the job number to 3, run the command `ninja -j 3`. On average, each
104-
`ninja` job run in parallel needs approximately 2.5 GiB of RAM.
93+
``ninja``
94+
95+
[Ninja](https://ninja-build.org/) is the build system used by the Ceph
96+
project to build test builds. The number of jobs used by `ninja` is
97+
derived from the number of CPU cores of the building host if unspecified.
98+
Use the `-j` option to limit the job number if build jobs are running
99+
out of memory. If you attempt to run `ninja` and receive a message that
100+
reads `g++: fatal error: Killed signal terminated program cc1plus`, then
101+
you have run out of memory.
102+
103+
Using the `-j` option with an argument appropriate to the hardware on which
104+
the `ninja` command is run is expected to result in a successful build. For
105+
example, to limit the job number to 3, run the command `ninja -j 3`. On
106+
average, each `ninja` job run in parallel needs approximately 2.5 GiB
107+
of RAM.
105108

106109
This documentation assumes that your build directory is a subdirectory of the
107110
`ceph.git` checkout. If the build directory is located elsewhere, point

0 commit comments

Comments
 (0)