summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorZac Dover <zac.dover@proton.me>2025-01-03 10:23:54 +0100
committerZac Dover <zac.dover@proton.me>2025-01-03 10:23:54 +0100
commit639cfc5975e11922017f78f2abb2665d17f8fe6c (patch)
treea645ca7ab70dc64a935f84b8d384bd94f168f4ab /README.md
parentMerge pull request #59980 from kchheda3/wip-fix-v1-v2-notification (diff)
downloadceph-639cfc5975e11922017f78f2abb2665d17f8fe6c.tar.xz
ceph-639cfc5975e11922017f78f2abb2665d17f8fe6c.zip
doc: README.md - format "Tips and Tricks"
Format "Tips and Tricks" into its own section so that it doesn't confuse readers of the vstart installation procedure. Signed-off-by: Zac Dover <zac.dover@proton.me>
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/README.md b/README.md
index 5a5ac07206d..3c781e532f3 100644
--- a/README.md
+++ b/README.md
@@ -127,18 +127,15 @@ To build Ceph, follow this procedure:
ninja install
- >vstart.sh is commonly used to quickly deploy a development cluster.
-
- > [TIPS & TRICKS]
- >
- >Use Debug Builds Only When Needed
- >
- >While debugging builds are helpful for development, they can slow down performance.
- >
- >Use `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
-
- Enable Selective Daemons if you're testing specific components, don't start unnecessary daemons.
- Preserve Existing Data skip cluster reinitialization between tests by using the `-n` flag
+## Tips and Tricks
+
+ * Use "debug builds" only when needed. Debugging builds are helpful for
+ development, but they can slow down performance. Use
+ `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
+ * Enable Selective Daemons when testing specific components. Don't start
+ unnecessary daemons.
+ * Preserve Existing Data skip cluster reinitialization between tests by
+ using the `-n` flag.
> [TROUBLESHOOTING]
>