openstack
/
python-openstackclient
Code Issues Proposed changes

Merge "Add ":option:` `" in the help message"

This commit is contained in:
Jenkins 2017-01-04 10:08:49 +00:00 committed by Gerrit Code Review
parent 6707957c87 75f2875a6e
commit c416aecb2f
8 changed files with 41 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/command-objects/aggregate.rst
View File

@ -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)

9
doc/source/command-objects/compute-service.rst
View File

@ -15,7 +15,7 @@ Delete compute service(s)
openstack compute service delete
<service> [<service> ...]
.. _compute-service-delete:
.. _compute_service_delete-service:
.. describe:: <service>
Compute service(s) to delete (ID only)
@ -33,7 +33,6 @@ List compute services
[--service <service>]
[--long]
.. _compute-service-list:
.. option:: --host <host>
List services on specified host (name only)
@ -46,7 +45,6 @@ List compute services
List additional fields in output
compute service set
-------------------
@ -61,7 +59,6 @@ Set compute service properties
[--up | --down]
<host> <service>
.. _compute-service-set:
.. option:: --enable
Enable service
@ -72,7 +69,7 @@ Set compute service properties
.. option:: --disable-reason <reason>
Reason for disabling the service (in quotes). Should be used with --disable option.
Reason for disabling the service (in quotes). Should be used with :option:`--disable` option.
.. option:: --up
@ -82,6 +79,7 @@ Set compute service properties
Force down service
.. _compute_service_set-host:
.. describe:: <host>
Name of host
@ -89,4 +87,3 @@ Set compute service properties
.. describe:: <service>
Name of service (Binary name)

28
doc/source/command-objects/image.rst
View File

@ -23,10 +23,12 @@ Associate project with image
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. _image_add_project-image:
.. describe:: <image>
Image to share (name or ID).
.. _image_add_project-project:
.. describe:: <project>
Project to associate with image (name or ID)
@ -83,7 +85,7 @@ Create/upload an image
.. option:: --size <size>
Image size, in bytes (only used with --location and --copy-from)
Image size, in bytes (only used with :option:`--location` and :option:`--copy-from`)
*Image version 1 only.*
@ -91,7 +93,7 @@ Create/upload an image
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
.. option:: --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
@ -103,7 +105,7 @@ Create/upload an image
.. option:: --copy-from <image-url>
Copy image from the data store (similar to --location)
Copy image from the data store (similar to :option:`--location`)
*Image version 1 only.*
@ -117,7 +119,7 @@ Create/upload an image
.. option:: --force
Force image creation if volume is in use (only meaningful with --volume)
Force image creation if volume is in use (only meaningful with :option:`--volume`)
.. option:: --checksum <checksum>
@ -163,6 +165,7 @@ Create/upload an image
.. versionadded:: 2
.. _image_create-image-name:
.. describe:: <image-name>
New image name
@ -178,6 +181,7 @@ Delete image(s)
openstack image delete
<image>
.. _image_delete-image:
.. describe:: <image>
Image(s) to delete (name or ID)
@ -246,13 +250,15 @@ Disassociate project with image
openstack image remove remove
[--project-domain <project-domain>]
<image> <project>
<image>
<project>
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. _image_remove_project:
.. describe:: <image>
Image to unshare (name or ID).
@ -277,6 +283,7 @@ Save an image locally
Downloaded image save filename (default: stdout)
.. _image_save-image:
.. describe:: <image>
Image to save (name or ID)
@ -294,7 +301,7 @@ Set image properties
openstack image set
[--name <name>]
[--min-disk <disk-gb>]
[--min-ram <disk-ram>]
[--min-ram <ram-mb>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--size <size>]
@ -328,7 +335,7 @@ Set image properties
Minimum disk size needed to boot image, in gigabytes
.. option:: --min-ram <disk-ram>
.. option:: --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
@ -377,7 +384,7 @@ Set image properties
.. option:: --copy-from <image-url>
Copy image from the data store (similar to --location)
Copy image from the data store (similar to :option:`--location`)
*Image version 1 only.*
@ -395,7 +402,7 @@ Set image properties
.. option:: --force
Force image update if volume is in use (only meaningful with --volume)
Force image update if volume is in use (only meaningful with :option:`--volume`)
*Image version 1 only.*
@ -483,6 +490,7 @@ Set image properties
.. versionadded:: 2
.. _image_set-image:
.. describe:: <image>
Image to modify (name or ID)
@ -498,6 +506,7 @@ Display image details
openstack image show
<image>
.. _image_show-image:
.. describe:: <image>
Image to display (name or ID)
@ -525,6 +534,7 @@ Unset image tags or properties
Unset a property on this image (repeat option to unset multiple properties)
.. _image_unset-image:
.. describe:: <image>
Image to modify (name or ID)

4
doc/source/command-objects/limits.rst
View File

@ -34,8 +34,8 @@ Show compute and block storage limits
.. option:: --project <project>
Show limits for a specific project (name or ID) [only valid with --absolute]
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 --absolute]
Domain the project belongs to (name or ID) [only valid with :option:`--absolute`]

4
doc/source/command-objects/port.rst
View File

@ -214,7 +214,7 @@ Set port properties
.. option:: --no-fixed-ip
Clear existing information of fixed IP addresses.
Specify both --fixed-ip and --no-fixed-ip
Specify both :option:`--fixed-ip` and :option:`--no-fixed-ip`
to overwrite the current fixed IP addresses.
.. option:: --device <device-id>
@ -240,7 +240,7 @@ Set port properties
.. option:: --no-binding-profile
Clear existing information of binding:profile.
Specify both --binding-profile and --no-binding-profile
Specify both :option:`--binding-profile` and :option:`--no-binding-profile`
to overwrite the current binding:profile information.
.. option:: --host <host-id>

2
doc/source/command-objects/service.rst
View File

@ -54,7 +54,7 @@ Delete service(s)
openstack service delete
<service> [<service> ...]
.. _service_delete-type:
.. _service_delete-service:
.. describe:: <service>
Service(s) to delete (type, name or ID)

10
doc/source/command-objects/subnet.rst
View File

@ -49,7 +49,7 @@ Create new subnet
.. option:: --use-default-subnet-pool
Use default subnet pool for ``--ip-version``
Use default subnet pool for :option:`--ip-version`
.. option:: --prefix-length <prefix-length>
@ -58,7 +58,7 @@ Create new subnet
.. option:: --subnet-range <subnet-range>
Subnet range in CIDR notation
(required if ``--subnet-pool`` is not specified, optional otherwise)
(required if :option:`--subnet-pool` is not specified, optional otherwise)
.. option:: --allocation-pool start=<ip-address>,end=<ip-address>
@ -249,7 +249,7 @@ Set subnet properties
.. option:: --no-allocation-pool
Clear associated allocation pools from this subnet.
Specify both --allocation-pool and --no-allocation-pool
Specify both :option:`--allocation-pool` and :option:`--no-allocation-pool`
to overwrite the current allocation pool information.
.. option:: --dhcp
@ -267,7 +267,7 @@ Set subnet properties
.. option:: --no-dns-nameservers
Clear existing information of DNS servers.
Specify both --dns-nameserver and --no-dns-nameservers
Specify both :option:`--dns-nameserver` and :option:`--no-dns-nameservers`
to overwrite the current DNS server information.
.. option:: --gateway <gateway>
@ -287,7 +287,7 @@ Set subnet properties
.. option:: --no-host-route
Clear associated host routes from this subnet.
Specify both --host-route and --no-host-route
Specify both :option:`--host-route` and :option:`--no-host-route`
to overwrite the current host route information.
.. option:: --service-type <service-type>

6
doc/source/command-objects/volume-service.rst
View File

@ -17,7 +17,6 @@ List volume service
[--service <service>]
[--long]
.. _volume-service-list:
.. option:: --host <host>
List services on specified host (name only)
@ -54,9 +53,10 @@ Set volume service properties
.. option:: --disable-reason <reason>
Reason for disabling the service (should be used with --disable option)
Reason for disabling the service
(should be used with :option:`--disable` option)
.. _volume-service-set:
.. _volume_service_set-host:
.. describe:: <host>
Name of host