Merge "doc_review: Review docs for accuracy and grammar"

8 files changed, 35 insertions, 23 deletions

diff --git a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
index 7dae19ba..c88b80ed 100644
--- a/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
+++ b/docs/testing/developer/devguide/design/trafficgen_integration_guide.rst
@@ -64,16 +64,20 @@ Output should look like:
    Classes derived from: ITrafficGenerator
    ======
 
-   * Ixia:             A wrapper around the IXIA traffic generator.
+   * Dummy:            A dummy traffic generator whose data is generated by the user.
 
    * IxNet:            A wrapper around IXIA IxNetwork applications.
 
-   * Dummy:            A dummy traffic generator whose data is generated by the user.
+   * Ixia:             A wrapper around the IXIA traffic generator.
 
-   * SampleTG:         A sample traffic generator implementation
+   * Moongen:          Moongen Traffic generator wrapper.
 
    * TestCenter:       Spirent TestCenter
 
+   * Trex:             Trex Traffic generator wrapper.
+
+   * Xena:             Xena Traffic generator wrapper class
+
 
 Step 3 - configuration
 ======================
diff --git a/docs/testing/developer/devguide/design/vswitchperf_design.rst b/docs/testing/developer/devguide/design/vswitchperf_design.rst
index 58563845..55614d33 100644
--- a/docs/testing/developer/devguide/design/vswitchperf_design.rst
+++ b/docs/testing/developer/devguide/design/vswitchperf_design.rst
@@ -131,7 +131,7 @@ the content of PATHS dictionary accordingly.
 
 Dictionary has a specific section of configuration options for every tool type, it means:
 
-    * ``PATHS['vswitch']`` - contains a separete dictionary for each of vswitches supported by VSPEF
+    * ``PATHS['vswitch']`` - contains a separate dictionary for each of vswitches supported by VSPEF
 
       Example:
 
@@ -277,7 +277,7 @@ TRAFFIC dictionary is used for configuration of traffic generator. Default value
 can be found in configuration file ``conf/03_traffic.conf``. These default values
 can be modified by (first option has the highest priorty):
 
-    1. ``Parameters`` section of testcase defintion
+    1. ``Parameters`` section of testcase definition
     2. command line options specified by ``--test-params`` argument
     3. custom configuration file
 
@@ -437,7 +437,7 @@ First option can contain macros starting with ``#`` to generate VM specific valu
 These macros can be used only for options of ``list`` or ``str`` types with ``GUEST_``
 prefix.
 
-Example of macros and their expnasion for 2 VMs:
+Example of macros and their expansion for 2 VMs:
 
     .. code-block:: python
 
@@ -629,7 +629,7 @@ by deployment name as follows:
     optional ``number`` of VMs. In case that ``number`` is not specified, then
     2 VMs will be used. Multistream feature is used to route traffic to particular
     VMs (or NIC pairs of every VM). It means, that VSPERF will enable multistream
-    feaure and sets the number of streams to the number of VMs and their NIC
+    feature and sets the number of streams to the number of VMs and their NIC
     pairs. Traffic will be dispatched based on Stream Type, i.e. by UDP port,
     IP address or MAC address.
 
@@ -710,7 +710,7 @@ bridge inside the VM.
 VM, vSwitch, Traffic Generator Independence
 ===========================================
 
-VSPERF supports different vSwithes, Traffic Generators, VNFs
+VSPERF supports different VSwitches, Traffic Generators, VNFs
 and Forwarding Applications by using standard object-oriented polymorphism:
 
   * Support for vSwitches is implemented by a class inheriting from IVSwitch.
diff --git a/docs/testing/developer/devguide/results/scenario.rst b/docs/testing/developer/devguide/results/scenario.rst
index a57d6a03..dbdc7877 100644
--- a/docs/testing/developer/devguide/results/scenario.rst
+++ b/docs/testing/developer/devguide/results/scenario.rst
@@ -5,7 +5,7 @@
 VSPERF Test Scenarios
 =====================
 
-Predefined Tests run with CI:
+Predefined Tests suitable for automated execution with CI:
 
 ===================== ===========================================================
    Test                          Definition
@@ -45,3 +45,4 @@ Supported traffic generators:
 * Xena
 * MoonGen
 * Dummy
+* T-Rex
diff --git a/docs/testing/user/configguide/installation.rst b/docs/testing/user/configguide/installation.rst
index 0a98c945..8bad4efd 100644
--- a/docs/testing/user/configguide/installation.rst
+++ b/docs/testing/user/configguide/installation.rst
@@ -63,6 +63,7 @@ The vSwitch must support Open Flow 1.3 or greater.
 * Open vSwitch
 * Open vSwitch with DPDK support
 * TestPMD application from DPDK (supports p2p and pvp scenarios)
+* Cisco VPP
 
 Supported Hypervisors
 ---------------------
@@ -342,7 +343,7 @@ following location:
 
 http://www.tuned-project.org/2017/04/27/tuned-2-8-0-released/
 
-Follow instructions to install the latest tuned-adm onto your system. For
+Follow the instructions to install the latest tuned-adm onto your system. For
 current RHEL customers you should already have the most current version. You
 just need to install the cpu-partitioning profile.
 
diff --git a/docs/testing/user/configguide/trafficgen.rst b/docs/testing/user/configguide/trafficgen.rst
index 2d2b9a9e..597f566b 100644
--- a/docs/testing/user/configguide/trafficgen.rst
+++ b/docs/testing/user/configguide/trafficgen.rst
@@ -248,7 +248,7 @@ Ixia
 ----
 
 VSPERF can use both IxNetwork and IxExplorer TCL servers to control Ixia chassis.
-However usage of IxNetwork TCL server is a preferred option. Following sections
+However, usage of IxNetwork TCL server is a preferred option. The following sections
 will describe installation and configuration of IxNetwork components used by VSPERF.
 
 Installation
@@ -675,11 +675,15 @@ https://github.com/emmericp/MoonGen
 For VSPERF use, MoonGen should be cloned from here (as opposed to the
 previously mentioned GitHub):
 
-git clone https://github.com/atheurer/lua-trafficgen
+.. code-block:: console
+
+    git clone https://github.com/atheurer/lua-trafficgen
 
 and use the master branch:
 
-git checkout master
+.. code-block:: console
+
+    git checkout master
 
 VSPERF uses a particular Lua script with the MoonGen project:
 
@@ -808,10 +812,10 @@ Example of this configuration is in conf/03_traffic.conf or conf/10_custom.conf.
     TRAFFICGEN_TREX_USER = ''
     TRAFFICGEN_TREX_BASE_DIR = ''
 
-TRAFFICGEN_TREX_USER has to have sudo permission and passwordless access.
+TRAFFICGEN_TREX_USER has to have sudo permission and password-less access.
 TRAFFICGEN_TREX_BASE_DIR is the place, where is stored 't-rex-64' file.
 
-It is possible to specify the accurancy of RFC2544 Throughput measurement.
+It is possible to specify the accuracy of RFC2544 Throughput measurement.
 Threshold below defines maximal difference between frame rate of successful
 (i.e. defined frameloss was reached) and unsuccessful (i.e. frameloss was
 exceeded) iterations.
@@ -825,7 +829,7 @@ Default value of this parameter is defined in conf/03_traffic.conf as follows:
 SR-IOV
 ~~~~~~
 T-Rex by default only accepts packets on the receive side if the destination mac matches the
-MAC address specificed in the /etc/trex-cfg.yaml on the server side. For SR-IOV this creates
+MAC address specified in the /etc/trex-cfg.yaml on the server side. For SR-IOV this creates
 challenges with modifying the MAC address in the traffic profile to correctly flow packets
 through specified VFs. To remove this limitation enable promiscuous mode on T-Rex to allow
 all packets regardless of the destination mac to be accepted.
diff --git a/docs/testing/user/configguide/upgrade.rst b/docs/testing/user/configguide/upgrade.rst
index cf92572c..a41683ee 100644
--- a/docs/testing/user/configguide/upgrade.rst
+++ b/docs/testing/user/configguide/upgrade.rst
@@ -35,6 +35,7 @@ List of stable releases:
    colorado.2.0
    colorado.3.0
    danube.1.0
+   euphrates.1.0
 
 You could select which stable release should be used. For example, select ``danube.1.0``:
 
@@ -180,4 +181,3 @@ parameters and update them according to the documentation:
    rfc2544_tests
    stream_type
    traffic_type
-
diff --git a/docs/testing/user/userguide/integration.rst b/docs/testing/user/userguide/integration.rst
index 83b29da6..249a03c4 100644
--- a/docs/testing/user/userguide/integration.rst
+++ b/docs/testing/user/userguide/integration.rst
@@ -457,7 +457,7 @@ To run GENEVE decapsulation tests:
 Executing Tunnel encapsulation+decapsulation tests
 --------------------------------------------------
 
-The OVS DPDK encapsulation_decapsulation tests requires IPs, MAC addresses,
+The OVS DPDK encapsulation/decapsulation tests requires IPs, MAC addresses,
 bridge names and WHITELIST_NICS for DPDK.
 
 The test cases can test the tunneling encap and decap without using any ingress
diff --git a/docs/testing/user/userguide/testusage.rst b/docs/testing/user/userguide/testusage.rst
index 4d3528d0..20c30a40 100644
--- a/docs/testing/user/userguide/testusage.rst
+++ b/docs/testing/user/userguide/testusage.rst
@@ -20,6 +20,8 @@ support in VSPERF includes:
   Traffic generator modules.
 - Moongen software traffic generator. Requires a separate machine running
   moongen to execute packet generation.
+- T-Rex software traffic generator. Requires a separate machine running T-Rex
+  Server to execute packet generation.
 
 If you want to use another traffic generator, please select the :ref:`trafficgen-dummy`
 generator.
@@ -475,7 +477,7 @@ For example:
 
 * vSwitch tests with DPDK or without DPDK support to verify impact
   of VF usage on vSwitch performance
-* tests without vSwitch, where traffic is forwared directly
+* tests without vSwitch, where traffic is forwarded directly
   between VF interfaces by packet forwarder (e.g. testpmd application)
 * tests without vSwitch, where VM accesses VF interfaces directly
   by PCI-passthrough_ to measure raw VM throughput performance.
@@ -486,11 +488,11 @@ Using QEMU with PCI passthrough support
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Raw virtual machine throughput performance can be measured by execution of PVP
-test with direct access to NICs by PCI passthrough. To execute VM with direct
+test with direct access to NICs by PCI pass-through. To execute VM with direct
 access to PCI devices, enable vfio-pci_. In order to use virtual functions,
 SRIOV-support_ must be enabled.
 
-Execution of test with PCI passthrough with vswitch disabled:
+Execution of test with PCI pass-through with vswitch disabled:
 
 .. code-block:: console
 
@@ -498,9 +500,9 @@ Execution of test with PCI passthrough with vswitch disabled:
                --vswitch none --vnf QemuPciPassthrough pvp_tput
 
 Any of supported guest-loopback-application_ can be used inside VM with
-PCI passthrough support.
+PCI pass-through support.
 
-Note: Qemu with PCI passthrough support can be used only with PVP test
+Note: Qemu with PCI pass-through support can be used only with PVP test
 deployment.
 
 .. _guest-loopback-application: