From 8ed4398260eabc0ae374d0c8c30c060ab7ab133b Mon Sep 17 00:00:00 2001
From: Michael McCune <msm@redhat.com>
Date: Mon, 20 Jul 2015 13:11:48 -0400
Subject: [PATCH] updating documentation on devstack usage

The docs contain the older, non-plugin registry based, instructions for
activating sahara in devstack. This change also adds a small convenience
readme file to the devstack directory to help make it clear how to
integrate the plugin.

* fixing devstack documentation
* adding a convenience readme to the plugin directory
* changing tox bashate tests to ignore the readme

Change-Id: I58e604479de39f52a516fa6b428dfdc958b3b92d
---
 devstack/README.rst            | 21 +++++++++++++++++++++
 doc/source/devref/devstack.rst | 10 +++++++++-
 tox.ini                        |  2 +-
 3 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 devstack/README.rst

diff --git a/devstack/README.rst b/devstack/README.rst
new file mode 100644
index 0000000000..99df00416b
--- /dev/null
+++ b/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``
diff --git a/doc/source/devref/devstack.rst b/doc/source/devref/devstack.rst
index 9f432d66b6..7fc1cdb831 100644
--- a/doc/source/devref/devstack.rst
+++ b/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:
diff --git a/tox.ini b/tox.ini
index 1d631898c8..d4b25fbfa1 100644
--- a/tox.ini
+++ b/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 =