diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 16:02:31 -0600 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | c6266b5ab22b911ae7e0ca5077d0c04a23dabca9 (patch) | |
| tree | 8e2f4ff670b4b272184ecc877cd9838b5ad4873b /doc/source/cli/command-objects/usage.rst | |
| parent | da56b8f4cf15cc5a77249b680dd0c4d05137be9a (diff) | |
| download | python-openstackclient-c6266b5ab22b911ae7e0ca5077d0c04a23dabca9.tar.gz | |
compute: autogenerate docs
$namespace = openstack.compute.v2
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.
Many of these were already being generated. Some were missing a few
sub-subcommands, so those are added.
Change-Id: I1aa4b2655bafd2f6a5d83b658742f65d180eb128
Diffstat (limited to 'doc/source/cli/command-objects/usage.rst')
| -rw-r--r-- | doc/source/cli/command-objects/usage.rst | 49 |
1 files changed, 2 insertions, 47 deletions
diff --git a/doc/source/cli/command-objects/usage.rst b/doc/source/cli/command-objects/usage.rst index bb13176c..c2bcde06 100644 --- a/doc/source/cli/command-objects/usage.rst +++ b/doc/source/cli/command-objects/usage.rst @@ -4,50 +4,5 @@ usage Compute v2 -usage list ----------- - -List resource usage per project - -Compute API v2.40+ returns all matching entities rather than being -limited to the API server configured maximum (``CONF.api.max_limit``). - -.. program:: usage list -.. code:: bash - - openstack usage list - [--start <start>] - [--end <end>] - -.. option:: --start <start> - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end <end> - - Usage range end date, ex 2012-01-20 (default: tomorrow) - -usage show ----------- - -Show resource usage for a single project - -.. program:: usage show -.. code:: bash - - openstack usage show - [--project <project>] - [--start <start>] - [--end <end>] - -.. option:: --project <project> - - Name or ID of project to show usage for - -.. option:: --start <start> - - Usage range start date, ex 2012-01-20 (default: 4 weeks ago) - -.. option:: --end <end> - - Usage range end date, ex 2012-01-20 (default: tomorrow) +.. autoprogram-cliff:: openstack.compute.v2 + :command: usage * |