From cc9d68cf09944e4eb7d3a541fc41854bf252f07e Mon Sep 17 00:00:00 2001
From: Antony Messerli <amesserl@rackspace.com>
Date: Sun, 7 Aug 2011 14:00:23 -0500
Subject: [PATCH] Added documentation for NOVA_VERSION

---
 README.rst     | 17 +++++++++++------
 docs/shell.rst |  5 +++++
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.rst b/README.rst
index 4d7f4faca..02ce10d87 100644
--- a/README.rst
+++ b/README.rst
@@ -43,16 +43,19 @@ set them as environment variables::
     export NOVA_API_KEY=yadayada
     export NOVA_PROJECT_ID=myproject
 
-You will also need to define the authentication url with ``--url``. Or set it as
-an environment variable as well::
+You will also need to define the authentication url with ``--url`` and the
+version of the API with ``--version``.  Or set them as an environment 
+variables as well::
 
     export NOVA_URL=http://myserver:port/v1.0/
+    export NOVA_VERSION=1.0
     
 You'll find complete documentation on the shell by running 
 ``nova help``::
-    
-    usage: nova [--username USERNAME] [--apikey APIKEY] 
-                        [--projectid PROJECTID] [--url AUTH_URL] <subcommand> ...
+
+    usage: nova [--username USERNAME] [--apikey APIKEY] [--projectid PROJECTID]
+                   [--url URL] [--version VERSION]
+                   <subcommand> ...
 
     Command-line interface to the OpenStack Nova API.
 
@@ -107,7 +110,9 @@ You'll find complete documentation on the shell by running
       --apikey PROJECTID    Defaults to env[NOVA_PROJECT_ID].
       --url AUTH_URL        Defaults to env[NOVA_URL] or
                             https://auth.api.rackspacecloud.com/v1.0
-                            if undefined. 
+                            if undefined.
+      --version VERSION     Accepts 1.0 or 1.1, defaults to 
+                            env[NOVA_VERSION].
 
     See "nova help COMMAND" for help on a specific command.
     
diff --git a/docs/shell.rst b/docs/shell.rst
index 0b8c18e66..70a1ab6db 100644
--- a/docs/shell.rst
+++ b/docs/shell.rst
@@ -31,12 +31,17 @@ environment variables by setting two environment variables:
 
     The OpenStack API server URL.
 
+.. envvar:: NOVA_VERSION
+
+    The OpenStack API version.
+
 For example, in Bash you'd use::
 
     export NOVA_USERNAME=yourname
     export NOVA_API_KEY=yadayadayada
     export NOVA_PROJECT_ID=myproject
     export NOVA_URL=http://...
+    export NOVA_VERSION=1.0
     
 From there, all shell commands take the form::