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>

Author: 3 people

doc/source/cli/command-objects/availability-zone.rst

@@ -7,32 +7,5 @@ compute and network services.
 
 Block Storage v2, Compute v2, Network v2
 
-availability zone list
-----------------------
-
-List availability zones and their status
-
-.. program availability zone list
-.. code:: bash
-
-    openstack availability zone list
-        [--compute]
-        [--network]
-        [--volume]
-        [--long]
-
-.. option:: --compute
-
-    List compute availability zones
-
-.. option:: --network
-
-    List network availability zones
-
-.. option:: --volume
-
-    List volume availability zones
-
-.. option:: --long
-
-    List additional fields in output
+.. autoprogram-cliff:: openstack.common
+   :command: availability zone list

doc/source/cli/command-objects/configuration.rst

@@ -6,24 +6,5 @@ Available for all services
 
 .. _configuration-show:
 
-configuration show
-------------------
-
-Show the current openstack client configuration.  This command is a little
-different from other show commands because it does not take a resource name
-or id to show.  The command line options, such as --os-cloud, can be used to
-show different configurations.
-
-.. program:: configuration show
-.. code:: bash
-
-    openstack configuration show
-        [--mask | --unmask]
-
-.. option:: --mask
-
-    Attempt to mask passwords (default)
-
-.. option:: --unmask
-
-    Show password in clear text
+.. autoprogram-cliff:: openstack.common
+   :command: configuration show

doc/source/cli/command-objects/extension.rst

@@ -5,54 +5,6 @@ extension
 Many OpenStack server APIs include API extensions that enable
 additional functionality.
 
-extension list
---------------
 
-List API extensions
-
-.. program:: extension list
-.. code:: bash
-
-    openstack extension list
-        [--compute]
-        [--identity]
-        [--network]
-        [--volume]
-        [--long]
-
-.. option:: --compute
-
-    List extensions for the Compute API
-
-.. option:: --identity
-
-    List extensions for the Identity API
-
-.. option:: --network
-
-    List extensions for the Network API
-
-.. option:: --volume
-
-    List extensions for the Block Storage API
-
-.. option:: --long
-
-    List additional fields in output
-
-extension show
---------------
-
-Show API extension
-
-.. program:: extension show
-.. code:: bash
-
-    openstack extension show
-        <extension>
-
-.. _extension_show:
-.. describe:: <extension>
-
-   Extension to display. Currently, only network extensions are supported.
-   (Name or Alias)
+.. autoprogram-cliff:: openstack.common
+   :command: extension *

doc/source/cli/command-objects/limits.rst

@@ -6,36 +6,6 @@ The Compute and Block Storage APIs have resource usage limits.
 
 Compute v2, Block Storage v1
 
-limits show
------------
 
-Show compute and block storage limits
-
-.. program:: limits show
-.. code:: bash
-
-    openstack limits show
-        --absolute | --rate
-        [--reserved]
-        [--project <project>]
-        [--domain <domain>]
-
-.. option:: --absolute
-
-    Show absolute limits
-
-.. option:: --rate
-
-    Show rate limits
-
-.. option:: --reserved
-
-    Include reservations count [only valid with :option:`--absolute`]
-
-.. option:: --project <project>
-
-    Show limits for a specific project (name or ID) [only valid with :option:`--absolute`]
-
-.. option:: --domain <domain>
-
-    Domain the project belongs to (name or ID) [only valid with :option:`--absolute`]
+.. autoprogram-cliff:: openstack.common
+   :command: limits *

doc/source/cli/command-objects/project-purge.rst

@@ -6,37 +6,6 @@ Clean resources associated with a specific project.
 
 Block Storage v1, v2; Compute v2; Image v1, v2
 
-project purge
--------------
-
-Clean resources associated with a project
-
-.. program:: project purge
-.. code:: bash
-
-    openstack project purge
-        [--dry-run]
-        [--keep-project]
-        [--auth-project | --project <project>]
-        [--project-domain <project-domain>]
-
-.. option:: --dry-run
-
-    List a project's resources
-
-.. option:: --keep-project
-
-    Clean project resources, but don't delete the project.
-
-.. option:: --auth-project
-
-    Delete resources of the project used to authenticate
-
-.. option:: --project <project>
-
-    Project to clean (name or ID)
-
-.. option:: --project-domain <project-domain>
 
-    Domain the project belongs to (name or ID). This can be
-    used in case collisions between project names exist.
+.. autoprogram-cliff:: openstack.common
+   :command: project purge