From 7fa3dd2881be537ec6144850064ad1419dc12f3e Mon Sep 17 00:00:00 2001 From: Paul Vinciguerra Date: Sun, 27 Oct 2019 17:28:10 -0400 Subject: docs: cleanup typos on readthrough Type: style Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880 Signed-off-by: Paul Vinciguerra --- docs/reference/cmdreference/index.rst | 2 +- docs/reference/cmdreference/interface/create_interface.rst | 9 ++++----- docs/reference/cmdreference/show/show.rst | 2 +- docs/reference/cmdreference/vhost/vhostuser.rst | 4 ++-- docs/reference/vppvagrant/Vagrantfile | 4 ++-- docs/reference/vppvagrant/boxSetup.rst | 4 ++-- 6 files changed, 12 insertions(+), 13 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/cmdreference/index.rst b/docs/reference/cmdreference/index.rst index c51dd367ae0..c791992f779 100644 --- a/docs/reference/cmdreference/index.rst +++ b/docs/reference/cmdreference/index.rst @@ -27,7 +27,7 @@ The debug CLI can be executed from a su (superuser) shell using the vppctl comma drops 1498 local0 0 down -Commands can also be executed from the vppct shell. +Commands can also be executed from the vppctl shell. .. code-block:: console diff --git a/docs/reference/cmdreference/interface/create_interface.rst b/docs/reference/cmdreference/interface/create_interface.rst index c646a9947ad..9aeae33e98b 100644 --- a/docs/reference/cmdreference/interface/create_interface.rst +++ b/docs/reference/cmdreference/interface/create_interface.rst @@ -133,14 +133,13 @@ This command has several variations: - **create sub-interfaces** <*interface*> <*subId*>-<*subId*> - Create a range of subinterfaces to handle a range of VLAN IDs. - **create sub-interfaces** <*interface*> <*subId*> dot1q|dot1ad <*vlanId*>|any - [exact-match] - Use this command to specify the outer VLAN ID, to - either be explicited or to make the VLAN ID different from the - *subId*. + [exact-match] - Use this command to explicitly specify the outer VLAN ID, + or to make the VLAN ID different from the *subId*. - **create sub-interfaces** <*interface*> <*subId*> dot1q|dot1ad <*vlanId*>|any inner-dot1q <*vlanId*>|any [exact-match] - Use this command to - specify the outer VLAN ID and the innner VLAN ID. + specify the outer VLAN ID and the inner VLAN ID. -When *dot1q* or *dot1ad* is explictly entered, subinterfaces can be +When *dot1q* or *dot1ad* is explicitly entered, subinterfaces can be configured as either *exact-match* or *non-exact match*. *Non-exact match* is the CLI default. If *exact-match* is specified, packets must have the same number of VLAN tags as the configuration. For *non-exact-match*, diff --git a/docs/reference/cmdreference/show/show.rst b/docs/reference/cmdreference/show/show.rst index ba4938edac6..61c53604594 100644 --- a/docs/reference/cmdreference/show/show.rst +++ b/docs/reference/cmdreference/show/show.rst @@ -64,7 +64,7 @@ This command displays the IPv4 FIB Tables (VRF Tables) and the route entries for .. note:: This command will run for a long time when the FIB tables are comprised of - millions of entries. For those senarios, consider displaying a single table or summary mode. + millions of entries. For those scenarios, consider displaying a single table or summary mode. Example Usage -------------- diff --git a/docs/reference/cmdreference/vhost/vhostuser.rst b/docs/reference/cmdreference/vhost/vhostuser.rst index 04669bc5dea..0c2498b7f2c 100644 --- a/docs/reference/cmdreference/vhost/vhostuser.rst +++ b/docs/reference/cmdreference/vhost/vhostuser.rst @@ -28,7 +28,7 @@ There are several parameters associated with a vHost interface: Interface. In '*client*' mode, VPP can be reset without bringing down the VM and tearing down the vHost Interface. - **feature-mask ** - Optional virtio/vhost feature set negotiated - at startup. **This is intended for degugging only.** It is + at startup. **This is intended for debugging only.** It is recommended that this parameter not be used except by experienced users. By default, all supported features will be advertised. Otherwise, provide the set of features desired. @@ -91,7 +91,7 @@ Show Vhost-User Display the attributes of a single vHost User interface (provide interface name), multiple vHost User interfaces (provide a list of -interface names seperated by spaces) or all Vhost User interfaces (omit +interface names separated by spaces) or all Vhost User interfaces (omit an interface name to display all vHost interfaces). Summary/Usage diff --git a/docs/reference/vppvagrant/Vagrantfile b/docs/reference/vppvagrant/Vagrantfile index 32a13adedd8..457e37c8274 100644 --- a/docs/reference/vppvagrant/Vagrantfile +++ b/docs/reference/vppvagrant/Vagrantfile @@ -60,7 +60,7 @@ Vagrant.configure(2) do |config| config.vm.network "private_network", type: "dhcp" end - # use http proxy if avaiable + # use http proxy if available if ENV['http_proxy'] && Vagrant.has_plugin?("vagrant-proxyconf") config.proxy.http = ENV['http_proxy'] config.proxy.https = ENV['https_proxy'] @@ -112,4 +112,4 @@ Vagrant.configure(2) do |config| vws.vmx["memsize"] = "#{vmram}" vws.vmx["numvcpus"] = "#{vmcpu}" end -end \ No newline at end of file +end diff --git a/docs/reference/vppvagrant/boxSetup.rst b/docs/reference/vppvagrant/boxSetup.rst index 374ba349458..a8aa1f3c132 100644 --- a/docs/reference/vppvagrant/boxSetup.rst +++ b/docs/reference/vppvagrant/boxSetup.rst @@ -62,7 +62,7 @@ Looking further in the :ref:`vppVagrantfile`, you can see more Ruby variables be config.vm.network "private_network", type: "dhcp" end - # use http proxy if avaiable + # use http proxy if available if ENV['http_proxy'] && Vagrant.has_plugin?("vagrant-proxyconf") config.proxy.http = ENV['http_proxy'] config.proxy.https = ENV['https_proxy'] @@ -122,4 +122,4 @@ To confirm it is up, show the status and information of Vagrant boxes with: $ vagrant destroy - Note that "destroying" a VM does not erase the box, but rather destroys all resources allocated for that VM. For other Vagrant commands, such as destroying a box, refer to the `Vagrant CLI Page `_. \ No newline at end of file + Note that "destroying" a VM does not erase the box, but rather destroys all resources allocated for that VM. For other Vagrant commands, such as destroying a box, refer to the `Vagrant CLI Page `_. -- cgit 1.2.3-korg