Skip to content

Commit

Permalink
Merge pull request ceph#59732 from zdover23/wip-doc-2024-09-11-README…
Browse files Browse the repository at this point in the history
…-md-formatting

doc/README.md: improve formatting

Reviewed-by: Anthony D'Atri <[email protected]>
  • Loading branch information
zdover23 authored Sep 14, 2024
2 parents 1c941a6 + b9ca395 commit 711c10c
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,10 @@ To build Ceph, follow this procedure:
``cd build``
4. Use the `ninja` buildsystem to build the development environment:

``ninja``
ninja -j3

> [!TIP]
> [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.
Expand All @@ -106,7 +107,7 @@ To build Ceph, follow this procedure:
> 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
> -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
Expand All @@ -119,11 +120,11 @@ To build Ceph, follow this procedure:

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

Expand Down

0 comments on commit 711c10c

Please sign in to comment.