From 08ae2a2bbc7883cc242102cf70813ab2911d4d5d Mon Sep 17 00:00:00 2001 From: Christian Trautman Date: Mon, 2 Oct 2017 17:55:06 -0400 Subject: doc_review: Review docs for accuracy and grammar Fix issues with grammar and accuracy. JIRA: VSPERF-536 Change-Id: Ia703d306bb7a14b11e09ab4077b8adfa5fb5e6af Signed-off-by: Christian Trautman --- .../developer/devguide/design/trafficgen_integration_guide.rst | 10 +++++++--- docs/testing/developer/devguide/design/vswitchperf_design.rst | 10 +++++----- docs/testing/developer/devguide/results/scenario.rst | 3 ++- 3 files changed, 14 insertions(+), 9 deletions(-) (limited to 'docs/testing/developer') 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 -- cgit 1.2.3-korg