Skip to content

Commit 711c10c

Browse files
authored
Merge pull request ceph#59732 from zdover23/wip-doc-2024-09-11-README-md-formatting
doc/README.md: improve formatting Reviewed-by: Anthony D'Atri <[email protected]>
2 parents 1c941a6 + b9ca395 commit 711c10c

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,10 @@ To build Ceph, follow this procedure:
9292
``cd build``
9393
4. Use the `ninja` buildsystem to build the development environment:
9494

95-
``ninja``
95+
ninja -j3
9696

97-
> [!TIP]
97+
> [IMPORTANT]
98+
>
9899
> [Ninja](https://ninja-build.org/) is the build system used by the Ceph
99100
> project to build test builds. The number of jobs used by `ninja` is
100101
> derived from the number of CPU cores of the building host if unspecified.
@@ -106,7 +107,7 @@ To build Ceph, follow this procedure:
106107
> Using the `-j` option with an argument appropriate to the hardware on
107108
> which the `ninja` command is run is expected to result in a successful
108109
> build. For example, to limit the job number to 3, run the command `ninja
109-
> -j 3`. On average, each `ninja` job run in parallel needs approximately
110+
> -j3`. On average, each `ninja` job run in parallel needs approximately
110111
> 2.5 GiB of RAM.
111112
112113
This documentation assumes that your build directory is a subdirectory of
@@ -119,11 +120,11 @@ To build Ceph, follow this procedure:
119120

120121
To build only certain targets, run a command of the following form:
121122

122-
ninja [target name]
123+
``ninja [target name]``
123124

124125
5. Install the vstart cluster:
125126

126-
ninja install
127+
``ninja install``
127128

128129
### CMake Options
129130

0 commit comments

Comments
 (0)