diff options
| author | Zac Dover <zac.dover@proton.me> | 2024-08-05 15:02:49 +0200 |
|---|---|---|
| committer | Zac Dover <zac.dover@proton.me> | 2024-08-05 15:02:49 +0200 |
| commit | 1f21057e4166f2ea9f51ee037eb8e234c1390cfb (patch) | |
| tree | 21a0766f440ae745bfe4b1d3abf066a33769a9c0 /README.md | |
| parent | Merge pull request #58891 from zdover23/wip-doc-2024-07-28-cephfs-file-layout... (diff) | |
| download | ceph-1f21057e4166f2ea9f51ee037eb8e234c1390cfb.tar.xz ceph-1f21057e4166f2ea9f51ee037eb8e234c1390cfb.zip | |
doc/README.md - add ordered list
Add ordered-list formatting to the "Building Ceph" section of README.md.
Signed-off-by: Zac Dover <zac.dover@proton.me>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md index 41699563369..8acb1ba7a81 100644 --- a/README.md +++ b/README.md @@ -73,12 +73,19 @@ we recommend that you build `.deb` or `.rpm` packages, or refer to ``ceph.spec.in`` or ``debian/rules`` to see which configuration options are specified for production builds. -To build Ceph, make sure that you are in the top-level `ceph` directory that -contains `do_cmake.sh` and `CONTRIBUTING.rst` and run the following commands: +To build Ceph, follow this procedure: - ./do_cmake.sh - cd build - ninja +1. Make sure that you are in the top-level `ceph` directory that + contains `do_cmake.sh` and `CONTRIBUTING.rst`. +2. Run the `do_cmake.sh` script: + + >``./do_cmake.sh`` +3. Move into the `build` directory: + + >``cd build`` +4. Use the `ninja` buildsystem to build the development environment: + + >``ninja`` ``do_cmake.sh`` by default creates a "debug build" of Ceph, which can be up to five times slower than a non-debug build. Pass |