From: John Spray <john.spray@redhat.com>
Date: Wed, 21 Sep 2016 07:59:45 +0000 (+0100)
Subject: doc: update vstart guide for cmake-ish paths
X-Git-Tag: v11.0.1~146^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F11163%2Fhead;p=ceph.git

doc: update vstart guide for cmake-ish paths

Signed-off-by: John Spray <john.spray@redhat.com>
---

diff --git a/doc/dev/quick_guide.rst b/doc/dev/quick_guide.rst
index 6a4fe08eb4fc..b703ebd0162f 100644
--- a/doc/dev/quick_guide.rst
+++ b/doc/dev/quick_guide.rst
@@ -24,21 +24,21 @@ deployment using the following command:
 
 .. code::
 
-	$ cd src
-	$ ./vstart.sh -d -n -x
+	$ cd ceph/build  # Assuming this is where you ran cmake
+	$ ../src/vstart.sh -d -n -x
 
 You can also configure ``vstart.sh`` to use only one monitor and one metadata server by using the following:
 
 .. code::
 
-	$ MON=1 MDS=1 ./vstart.sh -d -n -x
+	$ MON=1 MDS=1 ../src/vstart.sh -d -n -x
 
 The system creates three pools on startup: `cephfs_data`, `cephfs_metadata`, and `rbd`.  Let's get some stats on
 the current pools:
 
 .. code::
 
-	$ ./ceph osd pool stats
+	$ bin/ceph osd pool stats
 	*** DEVELOPER MODE: setting PATH, PYTHONPATH and LD_LIBRARY_PATH ***
 	pool rbd id 0
 	  nothing is going on
@@ -49,7 +49,7 @@ the current pools:
 	pool cephfs_metadata id 2
 	  nothing is going on
 	
-	$ ./ceph osd pool stats cephfs_data
+	$ bin/ceph osd pool stats cephfs_data
 	*** DEVELOPER MODE: setting PATH, PYTHONPATH and LD_LIBRARY_PATH ***
 	pool cephfs_data id 1
 	  nothing is going on
@@ -68,27 +68,40 @@ Make a pool and run some benchmarks against it:
 
 .. code::
 
-	$ ./rados mkpool mypool
-	$ ./rados -p mypool bench 10 write -b 123
+	$ bin/rados mkpool mypool
+	$ bin/rados -p mypool bench 10 write -b 123
 
 Place a file into the new pool:
 
 .. code::
 
-	$ ./rados -p mypool put objectone <somefile>
-	$ ./rados -p mypool put objecttwo <anotherfile>
+	$ bin/rados -p mypool put objectone <somefile>
+	$ bin/rados -p mypool put objecttwo <anotherfile>
 
 List the objects in the pool:
 
 .. code::
 
-	$ ./rados -p mypool ls
+	$ bin/rados -p mypool ls
 
 Once you are done, type the following to stop the development ceph deployment:
 
 .. code::
 
-	$ ./stop.sh
+	$ ../src/stop.sh
+
+Resetting your vstart environment
+---------------------------------
+
+The vstart script creates out/ and dev/ directories which contain
+the cluster's state.  If you want to quickly reset your environment,
+you might do something like this:
+
+.. code::
+
+    [build]$ ../src/stop.sh
+    [build]$ rm -rf out dev
+    [build]$ MDS=1 MON=1 OSD=3 ../src/vstart.sh -n -d
 
 Running a RadosGW development environment
 -----------------------------------------
@@ -96,8 +109,8 @@ Add the ``-r`` to vstart.sh to enable the RadosGW
 
 .. code::
 
-	$ cd src
-	$ ./vstart.sh -d -n -x -r
+	$ cd build
+	$ ../src/vstart.sh -d -n -x -r
 
 You can now use the swift python client to communicate with the RadosGW.