From 32c627eaf0481eb593388d2d76abffcf2b721136 Mon Sep 17 00:00:00 2001 From: Tang Chen Date: Tue, 12 Apr 2016 15:57:17 +0800 Subject: Doc: Unify repeatable option comments There are lots of "this option can be repeated" comments in the doc, which are not consistent to other similar docs. This patch changes them to the following format: "repeat option to do something" Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7 --- doc/source/command-objects/identity-provider.rst | 8 ++++---- doc/source/command-objects/network.rst | 5 +++-- doc/source/command-objects/port.rst | 8 ++++---- doc/source/command-objects/router.rst | 13 +++++++------ doc/source/command-objects/server.rst | 15 +++++++++------ doc/source/command-objects/subnet-pool.rst | 8 ++++---- doc/source/command-objects/subnet.rst | 14 ++++++++------ doc/source/command-objects/trust.rst | 2 +- 8 files changed, 40 insertions(+), 33 deletions(-) (limited to 'doc/source/command-objects') diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/command-objects/identity-provider.rst index ac462736..ca773d81 100644 --- a/doc/source/command-objects/identity-provider.rst +++ b/doc/source/command-objects/identity-provider.rst @@ -22,8 +22,8 @@ Create new identity provider .. option:: --remote-id - Remote IDs to associate with the Identity Provider (repeat to provide - multiple values) + Remote IDs to associate with the Identity Provider + (repeat option to provide multiple values) .. option:: --remote-id-file @@ -87,8 +87,8 @@ Set identity provider properties .. option:: --remote-id - Remote IDs to associate with the Identity Provider (repeat to provide - multiple values) + Remote IDs to associate with the Identity Provider + (repeat option to provide multiple values) .. option:: --remote-id-file diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 029e82e3..622568e4 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -58,8 +58,9 @@ Create new network .. option:: --availability-zone-hint - Availability Zone in which to create this network (requires the Network - Availability Zone extension, this option can be repeated). + Availability Zone in which to create this network + (requires the Network Availability Zone extension, + repeat option to set multiple availability zones) *Network version 2 only* diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index c2295249..cc7723ea 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -33,7 +33,7 @@ Create new port Desired IP and/or subnet (name or ID) for this port: subnet=,ip-address= - (this option can be repeated) + (repeat option to set multiple fixed IP addresses) .. option:: --device @@ -51,7 +51,7 @@ Create new port .. option:: --binding-profile Custom data to be passed as binding:profile: = - (this option can be repeated) + (repeat option to set multiple binding:profile data) .. option:: --host @@ -137,7 +137,7 @@ Set port properties Desired IP and/or subnet (name or ID) for this port: subnet=,ip-address= - (this option can be repeated) + (repeat option to set multiple fixed IP addresses) .. option:: --no-fixed-ip @@ -159,7 +159,7 @@ Set port properties .. option:: --binding-profile Custom data to be passed as binding:profile: = - (this option can be repeated) + (repeat option to set multiple binding:profile data) .. option:: --no-binding-profile diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 9479af5f..dc645712 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -86,8 +86,9 @@ Create new router .. option:: --availability-zone-hint - Availability Zone in which to create this router (requires the Router - Availability Zone extension, this option can be repeated). + Availability Zone in which to create this router + (requires the Router Availability Zone extension, + repeat option to set multiple availability zones) .. _router_create-name: .. describe:: @@ -206,10 +207,10 @@ Set router properties .. option:: --route destination=,gateway= - Routes associated with the router. - Repeat this option to set multiple routes. - destination: destination subnet (in CIDR notation). - gateway: nexthop IP address. + Routes associated with the router + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (repeat option to set multiple routes) .. option:: --clear-routes diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 5141600d..bf972986 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -90,7 +90,7 @@ Create a new server .. option:: --security-group Security group to assign to this server (name or ID) - (repeat for multiple groups) + (repeat option to set multiple groups) .. option:: --key-name @@ -98,11 +98,13 @@ Create a new server .. option:: --property - Set a property on this server (repeat for multiple values) + Set a property on this server + (repeat option to set multiple values) .. option:: --file - File to inject into image before boot (repeat for multiple files) + File to inject into image before boot + (repeat option to set multiple files) .. option:: --user-data @@ -569,8 +571,8 @@ Set server properties .. option:: --property - Property to add/change for this server (repeat option to set - multiple properties) + Property to add/change for this server + (repeat option to set multiple properties) .. describe:: @@ -764,7 +766,8 @@ Unset server properties .. option:: --property - Property key to remove from server (repeat to remove multiple values) + Property key to remove from server + (repeat option to remove multiple values) .. describe:: diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 5eff2dcd..ce2ac60d 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -22,8 +22,8 @@ Create subnet pool .. option:: --pool-prefix - Set subnet pool prefixes (in CIDR notation). - Repeat this option to set multiple prefixes. + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) .. option:: --default-prefix-length @@ -104,8 +104,8 @@ Set subnet pool properties .. option:: --pool-prefix - Set subnet pool prefixes (in CIDR notation). - Repeat this option to set multiple prefixes. + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) .. option:: --default-prefix-length diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index e5026f5a..50be5b0a 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -56,7 +56,8 @@ Create new subnet .. option:: --allocation-pool start=,end= Allocation pool IP addresses for this subnet e.g.: - ``start=192.168.199.2,end=192.168.199.254`` (This option can be repeated) + ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to add multiple IP addresses) .. option:: --dhcp @@ -68,7 +69,7 @@ Create new subnet .. option:: --dns-nameserver - DNS name server for this subnet (This option can be repeated) + DNS server for this subnet (repeat option to set multiple DNS servers) .. option:: --gateway @@ -85,7 +86,7 @@ Create new subnet ``destination=10.10.0.0/16,gateway=192.168.71.254`` destination: destination subnet (in CIDR notation) gateway: nexthop IP address - (This option can be repeated) + (repeat option to add multiple routes) .. option:: --ip-version {4,6} @@ -162,7 +163,8 @@ Set subnet properties .. option:: --allocation-pool start=,end= Allocation pool IP addresses for this subnet e.g.: - ``start=192.168.199.2,end=192.168.199.254`` (This option can be repeated) + ``start=192.168.199.2,end=192.168.199.254`` + (repeat option to add multiple IP addresses) .. option:: --dhcp @@ -174,7 +176,7 @@ Set subnet properties .. option:: --dns-nameserver - DNS name server for this subnet (This option can be repeated) + DNS server for this subnet (repeat option to set multiple DNS servers) .. option:: --gateway @@ -189,7 +191,7 @@ Set subnet properties ``destination=10.10.0.0/16,gateway=192.168.71.254`` destination: destination subnet (in CIDR notation) gateway: nexthop IP address - (This option can be repeated) + (repeat option to add multiple routes) .. option:: --name diff --git a/doc/source/command-objects/trust.rst b/doc/source/command-objects/trust.rst index 556edc54..cb44c6b6 100644 --- a/doc/source/command-objects/trust.rst +++ b/doc/source/command-objects/trust.rst @@ -29,7 +29,7 @@ Create new trust .. option:: --role - Roles to authorize (name or ID) (repeat to set multiple values) (required) + Roles to authorize (name or ID) (repeat option to set multiple values, required) .. option:: --impersonate -- cgit v1.2.1