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/project-purge.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/project-purge.rst')
| -rw-r--r-- | doc/source/cli/command-objects/project-purge.rst | 35 |
1 files changed, 2 insertions, 33 deletions
diff --git a/doc/source/cli/command-objects/project-purge.rst b/doc/source/cli/command-objects/project-purge.rst index 0ad0bbf9..8f10a774 100644 --- a/doc/source/cli/command-objects/project-purge.rst +++ b/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 |