summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-06-04 13:05:30 +0000
committerGerrit Code Review <review@openstack.org>2016-06-04 13:05:30 +0000
commit55a7ba890d9c3a53b7728efe41053b79ba1e60d3 (patch)
tree2c093d1e78fee714a3cf3e57f9ccbf91ad3cec04 /doc/source
parent416792f079e7d15d8747736ee792d1f5c30aa389 (diff)
parent6f2c1734e3d66e261f231711455821321c1fc254 (diff)
downloadpython-openstackclient-55a7ba890d9c3a53b7728efe41053b79ba1e60d3.tar.gz
Merge "Fix --enable options on commands"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-beta.rst12
-rw-r--r--doc/source/command-objects/network-segment.rst4
-rw-r--r--doc/source/man/openstack.rst6
3 files changed, 9 insertions, 13 deletions
diff --git a/doc/source/command-beta.rst b/doc/source/command-beta.rst
index 53a44204..f0a4f851 100644
--- a/doc/source/command-beta.rst
+++ b/doc/source/command-beta.rst
@@ -33,7 +33,7 @@ example list
List examples
.. caution:: This is a beta command and subject to change.
- Use global option ``--enable-beta-commands`` to
+ Use global option ``--os-beta-command`` to
enable this command.
.. program:: example list
@@ -52,7 +52,7 @@ The command help must label the command as a beta.
"""Display example details
(Caution: This is a beta command and subject to change.
- Use global option --enable-beta-commands to enable
+ Use global option --os-beta-command to enable
this command)
"""
@@ -60,13 +60,9 @@ Implementation
--------------
The command must raise a ``CommandError`` exception if beta commands
-are not enabled via ``--enable-beta-commands`` global option.
+are not enabled via ``--os-beta-command`` global option.
.. code-block:: python
def take_action(self, parsed_args):
- if not self.app.options.enable_beta_commands:
- msg = _('Caution: This is a beta command and subject to '
- 'change. Use global option --enable-beta-commands '
- 'to enable this command.')
- raise exceptions.CommandError(msg)
+ self.validate_os_beta_command_enabled()
diff --git a/doc/source/command-objects/network-segment.rst b/doc/source/command-objects/network-segment.rst
index 8e177d6a..56a11e1e 100644
--- a/doc/source/command-objects/network-segment.rst
+++ b/doc/source/command-objects/network-segment.rst
@@ -15,7 +15,7 @@ network segment list
List network segments
.. caution:: This is a beta command and subject to change.
- Use global option ``--enable-beta-commands`` to
+ Use global option ``--os-beta-command`` to
enable this command.
.. program:: network segment list
@@ -39,7 +39,7 @@ network segment show
Display network segment details
.. caution:: This is a beta command and subject to change.
- Use global option ``--enable-beta-commands`` to
+ Use global option ``--os-beta-command`` to
enable this command.
.. program:: network segment show
diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst
index e14f1f95..7af380a3 100644
--- a/doc/source/man/openstack.rst
+++ b/doc/source/man/openstack.rst
@@ -132,6 +132,9 @@ OPTIONS
This key should be the value of one of the HMAC keys defined in the
configuration files of OpenStack services to be traced.
+:option:`--os-beta-command`
+ Enable beta commands which are subject to change
+
:option:`--log-file` <LOGFILE>
Specify a file to log output. Disabled by default.
@@ -144,9 +147,6 @@ OPTIONS
:option:`--debug`
Show tracebacks on errors and set verbosity to debug
-:option:`--enable-beta-commands`
- Enable beta commands which are subject to change
-
COMMANDS
========