]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/README.md - improve "Running a test cluster" 53259/head
authorZac Dover <zac.dover@proton.me>
Fri, 1 Sep 2023 00:19:58 +0000 (10:19 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 1 Sep 2023 18:33:18 +0000 (04:33 +1000)
Improve the English in the section "Running a test cluster in the
ceph/README.md file.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 420ecc7addaad1969cb634289c2399ea38ea9a90)

README.md

index a7e662f6a90857bebedd7e8504db347320d3b8af..ce9d21fa41353b7c1347ed36c9d5afb7f8941d8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -156,24 +156,25 @@ are committed to git.)
 
 ## Running a test cluster
 
-To run a functional test cluster,
+From the `ceph/` directory, run the following commands to launch a test Ceph
+cluster:
 
        cd build
        ninja vstart        # builds just enough to run vstart
        ../src/vstart.sh --debug --new -x --localhost --bluestore
        ./bin/ceph -s
 
-Almost all of the usual commands are available in the bin/ directory.
-For example,
+Most Ceph commands are available in the `bin/` directory. For example:
 
        ./bin/rados -p rbd bench 30 write
        ./bin/rbd create foo --size 1000
 
-To shut down the test cluster,
+To shut down the test cluster, run the following command from the `build/`
+directory:
 
        ../src/stop.sh
 
-To start or stop individual daemons, the sysvinit script can be used:
+Use the sysvinit script to start or stop individual daemons: 
 
        ./bin/init-ceph restart osd.0
        ./bin/init-ceph stop