From: Zac Dover Date: Mon, 9 Sep 2024 15:21:18 +0000 (+1000) Subject: doc/README.md: improve formatting X-Git-Tag: testing/wip-mchangir-testing-20241122.051535-debug~127^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=0bf75d6f7cf1fcf440d604b1a6a7149ce0dc7375;p=ceph-ci.git doc/README.md: improve formatting Improve the formatting of the section "Building Ceph" in the file README.md. Signed-off-by: Zac Dover (cherry picked from commit 7171f73c81d603f8ff62198fc1e5f50c20a0aa05) --- diff --git a/README.md b/README.md index 7cb2c240f34..a6f75b9bc2e 100644 --- a/README.md +++ b/README.md @@ -93,19 +93,19 @@ Using the `-j` option with an argument appropriate to the hardware on which the 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. -This documentation assumes that your build directory is a subdirectory of the -`ceph.git` checkout. If the build directory is located elsewhere, point -`CEPH_GIT_DIR` to the correct path of the checkout. Additional CMake args can -be specified by setting ARGS before invoking ``do_cmake.sh``. See [cmake -options](#cmake-options) for more details. For example: + This documentation assumes that your build directory is a subdirectory of + the `ceph.git` checkout. If the build directory is located elsewhere, point + `CEPH_GIT_DIR` to the correct path of the checkout. Additional CMake args + can be specified by setting ARGS before invoking ``do_cmake.sh``. + See [cmake options](#cmake-options) for more details. For example: - ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh + ARGS="-DCMAKE_C_COMPILER=gcc-7" ./do_cmake.sh -To build only certain targets, run a command of the following form: + To build only certain targets, run a command of the following form: ninja [target name] -To install: +5. Install the vstart cluster: ninja install