From 6b76860c451251fd3c95e1e0e1af12c560bf4043 Mon Sep 17 00:00:00 2001 From: Richard Theis Date: Fri, 1 Apr 2016 16:16:08 -0500 Subject: Doc: Fix network command documentation issues Fix the following network command documentation issues: - Fix format of subnet pool positional arguments - Update port set options to match help - Fix network command documentation for Network v2 versus Compute v2 options and commands - Fix subnet command documentation errors and formatting problems in help text Change-Id: I808c2a70ca62eafc9e42d6873539cdd142ffe50c Related-Bug: #1558677 --- doc/source/command-objects/subnet.rst | 47 +++++++++++++++++------------------ 1 file changed, 23 insertions(+), 24 deletions(-) (limited to 'doc/source/command-objects/subnet.rst') diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index e81a3359..e5026f5a 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -42,7 +42,7 @@ Create new subnet .. option:: --use-default-subnet-pool - Use default subnet pool for --ip-version + Use default subnet pool for ``--ip-version`` .. option:: --prefix-length @@ -51,12 +51,12 @@ Create new subnet .. option:: --subnet-range Subnet range in CIDR notation - (required if --subnet-pool is not specified, optional otherwise) + (required if ``--subnet-pool`` is not specified, optional otherwise) .. 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`` (This option can be repeated) .. option:: --dhcp @@ -73,31 +73,30 @@ Create new subnet .. option:: --gateway Specify a gateway for the subnet. The three options are: - : Specific IP address to use as the gateway - 'auto': Gateway address should automatically be chosen from - within the subnet itself - 'none': This subnet will not use a gateway - e.g.: --gateway 192.168.9.1, --gateway auto, --gateway none - (default is 'auto') + : Specific IP address to use as the gateway, + 'auto': Gateway address should automatically be chosen from + within the subnet itself, 'none': This subnet will not use + a gateway, e.g.: ``--gateway 192.168.9.1``, ``--gateway auto``, + ``--gateway none`` (default is 'auto') .. option:: --host-route destination=,gateway= Additional route for this subnet e.g.: - 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) + ``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) .. option:: --ip-version {4,6} IP version (default is 4). Note that when subnet pool is specified, - IP version is determined from the subnet pool and this option - is ignored. + IP version is determined from the subnet pool and this option + is ignored. .. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} IPv6 RA (Router Advertisement) mode, - valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] .. option:: --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} @@ -163,7 +162,7 @@ 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`` (This option can be repeated) .. option:: --dhcp @@ -180,17 +179,17 @@ Set subnet properties .. option:: --gateway Specify a gateway for the subnet. The options are: - : Specific IP address to use as the gateway - 'none': This subnet will not use a gateway - e.g.: --gateway 192.168.9.1, --gateway none + : Specific IP address to use as the gateway, + 'none': This subnet will not use a gateway, + e.g.: ``--gateway 192.168.9.1``, ``--gateway none`` .. option:: --host-route destination=,gateway= Additional route for this subnet e.g.: - 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) + ``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) .. option:: --name -- cgit v1.2.1