From 75f2875a6e2be5c7fef56ebc1f3c235aa5ae1521 Mon Sep 17 00:00:00 2001 From: "zhiyong.dai" Date: Mon, 19 Dec 2016 17:23:35 +0800 Subject: [PATCH] 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 --- doc/source/command-objects/aggregate.rst | 7 ++++- .../command-objects/compute-service.rst | 9 ++---- doc/source/command-objects/image.rst | 28 +++++++++++++------ doc/source/command-objects/limits.rst | 4 +-- doc/source/command-objects/port.rst | 4 +-- doc/source/command-objects/service.rst | 2 +- doc/source/command-objects/subnet.rst | 10 +++---- doc/source/command-objects/volume-service.rst | 6 ++-- 8 files changed, 41 insertions(+), 29 deletions(-) diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 0d2926db7d..2029a6c8cf 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 to add to :ref:`\ ` @@ -49,6 +50,7 @@ Create a new aggregate Property to add to this aggregate (repeat option to set multiple properties) +.. _aggregate_create-name: .. describe:: New aggregate name @@ -64,6 +66,7 @@ Delete existing aggregate(s) openstack aggregate delete [ ...] +.. _aggregate_delete-aggregate: .. describe:: 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 to remove from :ref:`\ ` @@ -135,7 +139,7 @@ Set aggregate properties .. option:: --no-property Remove all properties from :ref:`\ ` - (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_show-aggregate: .. describe:: Aggregate to display (name or ID) diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 66347214e4..ba624ea0a4 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -15,7 +15,7 @@ Delete compute service(s) openstack compute service delete [ ...] -.. _compute-service-delete: +.. _compute_service_delete-service: .. describe:: Compute service(s) to delete (ID only) @@ -33,7 +33,6 @@ List compute services [--service ] [--long] -.. _compute-service-list: .. option:: --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] -.. _compute-service-set: .. option:: --enable Enable service @@ -72,7 +69,7 @@ Set compute service properties .. option:: --disable-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:: Name of host @@ -89,4 +87,3 @@ Set compute service properties .. describe:: Name of service (Binary name) - diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 1913355ebf..7ebcb54ad2 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -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 to share (name or ID). +.. _image_add_project-project: .. describe:: Project to associate with image (name or ID) @@ -83,7 +85,7 @@ Create/upload an image .. option:: --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 +.. option:: --min-ram Minimum RAM size needed to boot image, in megabytes @@ -103,7 +105,7 @@ Create/upload an image .. option:: --copy-from - 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 @@ -163,6 +165,7 @@ Create/upload an image .. versionadded:: 2 +.. _image_create-image-name: .. describe:: New image name @@ -178,6 +181,7 @@ Delete image(s) openstack image delete +.. _image_delete-image: .. describe:: Image(s) to delete (name or ID) @@ -246,13 +250,15 @@ Disassociate project with image openstack image remove remove [--project-domain ] - + + .. option:: --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 to unshare (name or ID). @@ -277,6 +283,7 @@ Save an image locally Downloaded image save filename (default: stdout) +.. _image_save-image: .. describe:: Image to save (name or ID) @@ -294,7 +301,7 @@ Set image properties openstack image set [--name ] [--min-disk ] - [--min-ram ] + [--min-ram ] [--container-format ] [--disk-format ] [--size ] @@ -328,7 +335,7 @@ Set image properties Minimum disk size needed to boot image, in gigabytes -.. option:: --min-ram +.. option:: --min-ram Minimum RAM size needed to boot image, in megabytes @@ -377,7 +384,7 @@ Set image properties .. option:: --copy-from - 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 to modify (name or ID) @@ -498,6 +506,7 @@ Display image details openstack image show +.. _image_show-image: .. describe:: 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 to modify (name or ID) diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index 9a302fbfd9..9261420951 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -34,8 +34,8 @@ Show compute and block storage limits .. option:: --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 the project belongs to (name or ID) [only valid with --absolute] + Domain the project belongs to (name or ID) [only valid with :option:`--absolute`] diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 3f6e3fc02c..34656f32b4 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -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 @@ -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 diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst index 250d19ec3d..a69c69504b 100644 --- a/doc/source/command-objects/service.rst +++ b/doc/source/command-objects/service.rst @@ -54,7 +54,7 @@ Delete service(s) openstack service delete [ ...] -.. _service_delete-type: +.. _service_delete-service: .. describe:: Service(s) to delete (type, name or ID) diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index fb28793e76..5eb55c23c8 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -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 @@ -58,7 +58,7 @@ Create new subnet .. option:: --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=,end= @@ -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 @@ -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 diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/command-objects/volume-service.rst index 842d9cb23a..2ad23240d3 100644 --- a/doc/source/command-objects/volume-service.rst +++ b/doc/source/command-objects/volume-service.rst @@ -17,7 +17,6 @@ List volume service [--service ] [--long] -.. _volume-service-list: .. option:: --host List services on specified host (name only) @@ -54,9 +53,10 @@ Set volume service properties .. option:: --disable-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:: Name of host