diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/trafficgen.rst | 4 | ||||
| -rw-r--r-- | docs/design/trafficgen_integration_guide.rst | 10 | ||||
| -rwxr-xr-x | docs/design/vswitchperf_design.rst | 10 | ||||
| -rwxr-xr-x | docs/userguide/yardstick.rst | 2 |
4 files changed, 13 insertions, 13 deletions
diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst index 7b2944e9..798248ac 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/configguide/trafficgen.rst @@ -72,12 +72,12 @@ OR from the commandline: $ ./vsperf --test-params "pkt_sizes=x,y" $TESTNAME You can also modify the traffic transmission duration and the number -of trials run by the traffic generator by extending the example +of tests run by the traffic generator by extending the example commandline above to: .. code-block:: console - $ ./vsperf --test-params "pkt_sizes=x,y;duration=10;rfc2455_trials=3" $TESTNAME + $ ./vsperf --test-params "pkt_sizes=x,y;duration=10;rfc2544_tests=1" $TESTNAME Dummy Setup ------------ diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst index a30b2d61..266c6bc0 100644 --- a/docs/design/trafficgen_integration_guide.rst +++ b/docs/design/trafficgen_integration_guide.rst @@ -161,9 +161,9 @@ Example of synchronous interfaces: .. code-block:: python - def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20, + def send_rfc2544_throughput(self, traffic=None, tests=1, duration=20, lossrate=0.0): - def send_rfc2544_back2back(self, traffic=None, trials=1, duration=20, + def send_rfc2544_back2back(self, traffic=None, tests=1, duration=20, lossrate=0.0): def send_cont_traffic(self, traffic=None, duration=20): @@ -171,11 +171,11 @@ Example of asynchronous interfaces: .. code-block:: python - def start_rfc2544_throughput(self, traffic=None, trials=3, duration=20, + def start_rfc2544_throughput(self, traffic=None, tests=1, duration=20, lossrate=0.0): def wait_rfc2544_throughput(self): - def start_rfc2544_back2back(self, traffic=None, trials=1, duration=20, + def start_rfc2544_back2back(self, traffic=None, tests=1, duration=20, lossrate=0.0): def wait_rfc2544_back2back(self): @@ -221,7 +221,7 @@ functions: * param **vlan**: A dictionary with vlan specific parameters, e.g. **priority**, **cfi**, **id** and vlan on/off switch **enabled**. - * param **trials**: Number of trials to execute. + * param **tests**: Number of times the test is executed. * param **duration**: Duration of continuous test or per iteration duration in case of RFC2544 throughput or back2back traffic types. * param **lossrate**: Acceptable lossrate percentage. diff --git a/docs/design/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst index 53515249..e61b3ea6 100755 --- a/docs/design/vswitchperf_design.rst +++ b/docs/design/vswitchperf_design.rst @@ -53,7 +53,7 @@ for development purposes: .. code-block:: console - $ ./vsperf --test-params 'duration=10;rfc2544_trials=1;pkt_sizes=64' --tests 'pvp_tput' + $ ./vsperf --test-params 'duration=10;rfc2544_tests=1;pkt_sizes=64' --tests 'pvp_tput' Typical Test Sequence ===================== @@ -155,12 +155,12 @@ ITrafficGenerator start_cont_traffic(traffic, time, framerate) stop_cont_traffic(self): - send_rfc2544_throughput(traffic, trials, duration, lossrate) - start_rfc2544_throughput(traffic, trials, duration, lossrate) + send_rfc2544_throughput(traffic, tests, duration, lossrate) + start_rfc2544_throughput(traffic, tests, duration, lossrate) wait_rfc2544_throughput(self) - send_rfc2544_back2back(traffic, trials, duration, lossrate) - start_rfc2544_back2back(traffic, , trials, duration, lossrate) + send_rfc2544_back2back(traffic, tests, duration, lossrate) + start_rfc2544_back2back(traffic, , tests, duration, lossrate) wait_rfc2544_back2back() Note ``send_xxx()`` blocks whereas ``start_xxx()`` does not and must be followed by a subsequent call to ``wait_xxx()``. diff --git a/docs/userguide/yardstick.rst b/docs/userguide/yardstick.rst index 3d249e1b..ec306d57 100755 --- a/docs/userguide/yardstick.rst +++ b/docs/userguide/yardstick.rst @@ -130,7 +130,7 @@ argument. Following options are supported: - **bidirectional** - specifies if traffic will be uni (False) or bi-directional (True); Default: False - **iload** - specifies frame rate; Default: 100 -- **rfc2544_trials** - specifies the number of trials performed for each packet +- **rfc2544_tests** - specifies the number of tests performed for each packet size - **multistream** - specifies the number of simulated streams; Default: 0 (i.e. multistream feature is disabled) |