Merge "updating documentation on devstack usage"

devstack/README.rst

@@ -0,0 +1,21 @@
+======================
+ Enabling in Devstack
+======================
+
+1. Download DevStack
+
+2. Add this repo as an external repository in ``local.conf``
+
+.. sourcecode:: bash
+
+     [[local|localrc]]
+     enable_plugin sahara git://git.openstack.org/openstack/sahara
+
+Optionally, a git refspec may be provided as follows:
+
+.. sourcecode:: bash
+
+     [[local|localrc]]
+     enable_plugin sahara git://git.openstack.org/openstack/sahara <refspec>
+
+3. run ``stack.sh``

doc/source/devref/devstack.rst

@@ -93,7 +93,15 @@ Ubuntu 12.04 system.
     # OFFLINE=True
 
     # Enable Sahara
-    enable_service sahara
+    enable_plugin sahara git://git.openstack.org/openstack/sahara
+
+In cases where you need to specify a git refspec (branch, tag, or commit hash)
+for the sahara in-tree devstack plugin (or sahara repo), it should be
+appended after the git repo URL as follows:
+
+.. sourcecode:: bash
+
+    enable_plugin sahara git://git.openstack.org/openstack/sahara <some_git_refspec>
 
 3. Sahara can send notifications to Ceilometer, if Ceilometer is enabled.
    If you want to enable Ceilometer add the following lines to ``local.conf`` file:

tox.ini

@@ -44,7 +44,7 @@ commands =
     bash -c "find sahara -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
     # Run bashate checks
     bash -c "find sahara -iname '*.sh' -print0 | xargs -0 bashate -v"
-    bash -c "find devstack -type f -print0 | xargs -0 bashate -v"
+    bash -c "find devstack -not -name README.rst -type f -print0 | xargs -0 bashate -v"
 
 [testenv:doc8]
 deps =