summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorYushiro FURUKAWA <y.furukawa_2@jp.fujitsu.com>2016-09-29 20:02:02 +0900
committerYushiro FURUKAWA <y.furukawa_2@jp.fujitsu.com>2016-09-29 20:02:58 +0900
commitf11ad708fbfd7bce10befb2b5b22d63c187d86d9 (patch)
tree441a895339419df9557b77bfd5be540c80695ff7 /doc/source
parent2a36c060bf9df21ec87f9d5f4b31b6682ee300cc (diff)
downloadpython-ironicclient-f11ad708fbfd7bce10befb2b5b22d63c187d86d9.tar.gz
Add prefix "$" for command examples
This commits adds "$" as a prefix for command examples. Change-Id: I372cee5305acc26115ff4ffca58aaa2283a3a033
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/cli.rst28
-rw-r--r--doc/source/testing.rst8
2 files changed, 18 insertions, 18 deletions
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
index f5fe205..8b14d20 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli.rst
@@ -28,11 +28,11 @@ configuration options :option:`--os-username`, :option:`--os-password`,
and :option:`--os-auth-url`, or set the corresponding
environment variables::
- export OS_USERNAME=user
- export OS_PASSWORD=password
- export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b # or OS_TENANT_NAME
- export OS_TENANT_NAME=project # or OS_TENANT_ID
- export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+ $ export OS_USERNAME=user
+ $ export OS_PASSWORD=password
+ $ export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b # or OS_TENANT_NAME
+ $ export OS_TENANT_NAME=project # or OS_TENANT_ID
+ $ export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command-line tool will attempt to reauthenticate using the provided
credentials for every request. You can override this behavior by manually
@@ -40,8 +40,8 @@ supplying an auth token using :option:`--ironic-url` and
:option:`--os-auth-token`, or by setting the corresponding environment
variables::
- export IRONIC_URL=http://ironic.example.org:6385/
- export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
+ $ export IRONIC_URL=http://ironic.example.org:6385/
+ $ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Since Keystone can return multiple regions in the Service Catalog, you can
specify the one you want with :option:`--os-region-name` or set the following
@@ -56,7 +56,7 @@ fill partially typed commands. To use this feature, source the below file
https://git.openstack.org/cgit/openstack/python-ironicclient/tree/tools/ironic.bash_completion)
to your terminal and then bash completion should work::
- source ironic.bash_completion
+ $ source ironic.bash_completion
To avoid doing this every time, add this to your ``.bashrc`` or copy the
ironic.bash_completion file to the default bash completion scripts directory
@@ -67,11 +67,11 @@ OPTIONS
To get a list of available (sub)commands and options, run::
- ironic help
+ $ ironic help
To get usage and options of a command, run::
- ironic help <command>
+ $ ironic help <command>
EXAMPLES
@@ -79,16 +79,16 @@ EXAMPLES
Get information about the node-create command::
- ironic help node-create
+ $ ironic help node-create
Get a list of available drivers::
- ironic driver-list
+ $ ironic driver-list
Enroll a node with "fake" deploy driver and "ipmitool" power driver::
- ironic node-create -d fake_ipmitool -i ipmi_address=1.2.3.4
+ $ ironic node-create -d fake_ipmitool -i ipmi_address=1.2.3.4
Get a list of nodes::
- ironic node-list
+ $ ironic node-list
diff --git a/doc/source/testing.rst b/doc/source/testing.rst
index f45e1d6..90c7483 100644
--- a/doc/source/testing.rst
+++ b/doc/source/testing.rst
@@ -10,7 +10,7 @@ Python Guideline Enforcement
All code has to pass the pep8 style guideline to merge into OpenStack, to
validate the code against these guidelines you can run::
- tox -e pep8
+ $ tox -e pep8
Unit Testing
............
@@ -19,12 +19,12 @@ It is strongly encouraged to run the unit tests locally under one or more
test environments prior to submitting a patch. To run all the recommended
environments sequentially and pep8 style guideline run::
- tox
+ $ tox
You can also selectively pick specific test environments by listing your
chosen environments after a -e flag::
- tox -e py27,py33,py34,pep8
+ $ tox -e py27,py33,py34,pep8
.. note::
Tox sets up virtual environment and installs all necessary dependencies.
@@ -44,7 +44,7 @@ cloud installation along with admin credentials. The test.conf file lives in
ironicclient/tests/functional/ directory. To run functional tests in that way
create test.conf manually and run::
- tox -e functional
+ $ tox -e functional
An example test.conf file::