summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2012-08-22 23:42:26 -0500
committerDean Troyer <dtroyer@gmail.com>2012-08-23 14:40:09 -0500
commitd7b09bd097265691b60608f6cf32fd4f4ea3bc65 (patch)
treee1365569691fea3406b9b4d6c95a5615b1648b78 /doc
parent0bba3857d19bdfbc7ac3a408b3889b92245ed812 (diff)
downloadpython-cinderclient-d7b09bd097265691b60608f6cf32fd4f4ea3bc65.tar.gz
Change '_' to '-' in options
This changes every command-line option with a '_' in its name and changes them to '-'. The old option names are maintained for backward compatibility but are no longer in the help text. BP command-options Change-Id: If926bb3b8fa85d628aea197496cf976f71bcdd08
Diffstat (limited to 'doc')
-rw-r--r--doc/source/shell.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/source/shell.rst b/doc/source/shell.rst
index cff5cc7..9458cee 100644
--- a/doc/source/shell.rst
+++ b/doc/source/shell.rst
@@ -11,8 +11,8 @@ First, you'll need an OpenStack Nova account and an API key. You get this
by using the `cinder-manage` command in OpenStack Nova.
You'll need to provide :program:`cinder` with your OpenStack username and
-API key. You can do this with the :option:`--os_username`, :option:`--os_password`
-and :option:`--os_tenant_id` options, but it's easier to just set them as
+API key. You can do this with the :option:`--os-username`, :option:`--os-password`
+and :option:`--os-tenant-id` options, but it's easier to just set them as
environment variables by setting two environment variables:
.. envvar:: OS_USERNAME