Skip to content

Commit 639cfc5

Browse files
committed
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 <[email protected]>
1 parent 5c8c1d8 commit 639cfc5

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,15 @@ To build Ceph, follow this procedure:
127127

128128
ninja install
129129

130-
>vstart.sh is commonly used to quickly deploy a development cluster.
131-
132-
> [TIPS & TRICKS]
133-
>
134-
>Use Debug Builds Only When Needed
135-
>
136-
>While debugging builds are helpful for development, they can slow down performance.
137-
>
138-
>Use `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
139-
140-
Enable Selective Daemons if you're testing specific components, don't start unnecessary daemons.
141-
Preserve Existing Data skip cluster reinitialization between tests by using the `-n` flag
130+
## Tips and Tricks
131+
132+
* Use "debug builds" only when needed. Debugging builds are helpful for
133+
development, but they can slow down performance. Use
134+
`-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
135+
* Enable Selective Daemons when testing specific components. Don't start
136+
unnecessary daemons.
137+
* Preserve Existing Data skip cluster reinitialization between tests by
138+
using the `-n` flag.
142139

143140
> [TROUBLESHOOTING]
144141
>

0 commit comments

Comments
 (0)