diff options
| author | zhiyong.dai <zhiyong.dai@easystack.cn> | 2016-12-19 17:23:35 +0800 |
|---|---|---|
| committer | zhiyong.dai <zhiyong.dai@easystack.cn> | 2017-01-03 12:13:10 +0800 |
| commit | 75f2875a6e2be5c7fef56ebc1f3c235aa5ae1521 (patch) | |
| tree | eafb583417e545e89f19ef1155780db8ece33195 /doc/source/command-objects/aggregate.rst | |
| parent | 5d62981beb28f81ddd376466f296fc40b6b7eb8d (diff) | |
| download | python-openstackclient-75f2875a6e2be5c7fef56ebc1f3c235aa5ae1521.tar.gz | |
Add ":option:` `" in the help message
This patch mainly adds ":option:` `" in several help messages in the doc.
This modification will create one link which helps the readers find the relative
option quickly and conveniently in website.
Change-Id: Ia047e15c3b2064e4822ee7df7922d4774d862602
Diffstat (limited to 'doc/source/command-objects/aggregate.rst')
| -rw-r--r-- | doc/source/command-objects/aggregate.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 0d2926db..2029a6c8 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -24,6 +24,7 @@ Add host to aggregate Aggregate (name or ID) +.. _aggregate_add_host-host: .. describe:: <host> Host to add to :ref:`\<aggregate\> <aggregate_add_host-aggregate>` @@ -49,6 +50,7 @@ Create a new aggregate Property to add to this aggregate (repeat option to set multiple properties) +.. _aggregate_create-name: .. describe:: <name> New aggregate name @@ -64,6 +66,7 @@ Delete existing aggregate(s) openstack aggregate delete <aggregate> [<aggregate> ...] +.. _aggregate_delete-aggregate: .. describe:: <aggregate> Aggregate(s) to delete (name or ID) @@ -100,6 +103,7 @@ Remove host from aggregate Aggregate (name or ID) +.. _aggregate_remove_host-host: .. describe:: <host> Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>` @@ -135,7 +139,7 @@ Set aggregate properties .. option:: --no-property Remove all properties from :ref:`\<aggregate\> <aggregate_set-aggregate>` - (specify both --property and --no-property to + (specify both :option:`--property` and :option:`--no-property` to overwrite the current properties) .. _aggregate_set-aggregate: @@ -154,6 +158,7 @@ Display aggregate details openstack aggregate show <aggregate> +.. _aggregate_show-aggregate: .. describe:: <aggregate> Aggregate to display (name or ID) |