Skip to content

Commit

Permalink
doc: README.md - format "Tips and Tricks"
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
zdover23 committed Jan 3, 2025
1 parent 5c8c1d8 commit 639cfc5
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
>
Expand Down

0 comments on commit 639cfc5

Please sign in to comment.