diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-29 16:22:18 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | 4c0f3bfa89dfc9f207c4f6d6dc6ded85b86fee87 (patch) | |
| tree | 20538d81091a5eeaf0818bb02e936fb2a46cb996 /doc/source/cli/command-objects/versions.rst | |
| parent | c7dbe857055a04402f12dfaa3b261b0ecbf86d7c (diff) | |
| download | python-openstackclient-4c0f3bfa89dfc9f207c4f6d6dc6ded85b86fee87.tar.gz | |
common: autogenerate docs
$namespace = openstack.common
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
This incorporates a correction to `openstack versions show`: The command
`openstack versions show --help` showed a copy/paste error, using
<region-name> for the metavar for both --service and --status. Fix.
Change-Id: I7658fed40d71f4c20ee27908ade433534657cfe5
Co-Authored-By: Pierre Prinetti <pierreprinetti@redhat.com>
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
Diffstat (limited to 'doc/source/cli/command-objects/versions.rst')
| -rw-r--r-- | doc/source/cli/command-objects/versions.rst | 47 |
1 files changed, 2 insertions, 45 deletions
diff --git a/doc/source/cli/command-objects/versions.rst b/doc/source/cli/command-objects/versions.rst index 0aa9a1b7..ebebec19 100644 --- a/doc/source/cli/command-objects/versions.rst +++ b/doc/source/cli/command-objects/versions.rst @@ -4,48 +4,5 @@ versions Get a list of every version of every service in a given cloud. -versions show -------------- - -Show service versions: - -.. program:: versions show -.. code:: bash - - openstack versions show - [--all-interfaces] - [--interface <interface>] - [--region-name <region-name>] - [--service <service>] - [--status <status>] - -.. option:: --all-interfaces - - Return results for every interface of every service. - [Mutually exclusive with --interface] - -.. option:: --interface <interface> - - Limit results to only those on given interface. - [Default 'public'. Mutually exclusive with --all-interfaces] - -.. option:: --region-name <region-name> - - Limit results to only those from a given region. - -.. option:: --service <service> - - Limit results to only those for service. The argument should be either - an exact match to what is in the catalog or a known official value or - alias from `service-types-authority`_. - -.. option:: --status <status> - - Limit results to only those in the given state. Valid values are: - - - SUPPORTED - - CURRENT - - DEPRECATED - - EXPERIMENTAL - -.. _service-types-authority: https://service-types.openstack.org/ +.. autoprogram-cliff:: openstack.common + :command: versions show |