Skip to content

Commit cfa3a1f

Browse files
authored
Merge pull request ceph#59091 from zdover23/wip-doc-2024-08-08-README-md-alerts
doc/README.md - add "tip" alert styling Reviewed-by: Cole Mitchell <[email protected]>
2 parents ad8264e + a7e8779 commit cfa3a1f

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,19 +92,20 @@ To build Ceph, follow this procedure:
9292

9393
``ninja``
9494

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.
95+
> [!TIP]
96+
> [Ninja](https://ninja-build.org/) is the build system used by the Ceph
97+
> project to build test builds. The number of jobs used by `ninja` is
98+
> derived from the number of CPU cores of the building host if unspecified.
99+
> Use the `-j` option to limit the job number if build jobs are running
100+
> out of memory. If you attempt to run `ninja` and receive a message that
101+
> reads `g++: fatal error: Killed signal terminated program cc1plus`, then
102+
> you have run out of memory.
103+
>
104+
> Using the `-j` option with an argument appropriate to the hardware on
105+
> which the `ninja` command is run is expected to result in a successful
106+
> build. For example, to limit the job number to 3, run the command `ninja
107+
> -j 3`. On average, each `ninja` job run in parallel needs approximately
108+
> 2.5 GiB of RAM.
108109
109110
This documentation assumes that your build directory is a subdirectory of the
110111
`ceph.git` checkout. If the build directory is located elsewhere, point

0 commit comments

Comments
 (0)