From 01bff4c5650f4cfb992276278d170a21c91431c3 Mon Sep 17 00:00:00 2001 From: Christian Trautman Date: Thu, 24 Mar 2016 18:08:30 -0400 Subject: docs: Fix param name test-param to test-params Repair of documentation and configuration files where test-params is incorrectly listed as test-param. JIRA: VSPERF-266 Change-Id: I6be6c387fd57338f5dc5fba2ca8e1438dada0852 Signed-off-by: Christian Trautman --- conf/04_vnf.conf | 2 +- docs/configguide/trafficgen.rst | 4 ++-- docs/userguide/testusage.rst | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/conf/04_vnf.conf b/conf/04_vnf.conf index dc15fd15..a78564c3 100644 --- a/conf/04_vnf.conf +++ b/conf/04_vnf.conf @@ -42,7 +42,7 @@ GUEST_TIMEOUT = [180, 180] # 'buildin' - nothing will be configured by vsperf; VM image must # ensure traffic forwarding between its interfaces # This configuration option can be overridden by CLI SCALAR option -# guest_loopback, e.g. --test-param "guest_loopback=l2fwd" +# guest_loopback, e.g. --test-params "guest_loopback=l2fwd" # For 2 VNFs you may use ['testpmd', 'l2fwd'] GUEST_LOOPBACK = ['testpmd', 'testpmd'] diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst index 360db079..06503b33 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/configguide/trafficgen.rst @@ -67,7 +67,7 @@ OR from the commandline: .. code-block:: console - $ ./vsperf --test-param "pkt_sizes=x,y" $TESTNAME + $ ./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 @@ -75,7 +75,7 @@ commandline above to: .. code-block:: console - $ ./vsperf --test-param "pkt_sizes=x,y;duration=10;rfc2455_trials=3" $TESTNAME + $ ./vsperf --test-params "pkt_sizes=x,y;duration=10;rfc2455_trials=3" $TESTNAME Dummy Setup ------------ diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst index c20651b5..ac46ba3f 100755 --- a/docs/userguide/testusage.rst +++ b/docs/userguide/testusage.rst @@ -174,7 +174,7 @@ Some tests allow for configurable parameters, including test duration $ ./vsperf --conf-file user_settings.py --tests RFC2544Tput - --test-param "duration=10;pkt_sizes=128" + --test-params "duration=10;pkt_sizes=128" For all available options, check out the help dialog: @@ -291,7 +291,7 @@ To run tests using Vanilla OVS: or use --test-param $ ./vsperf --conf-file=/10_custom.conf - --test-param "vanilla_tgen_tx_ip=n.n.n.n; + --test-params "vanilla_tgen_tx_ip=n.n.n.n; vanilla_tgen_tx_mac=nn:nn:nn:nn:nn:nn" @@ -361,7 +361,7 @@ or use --test-param .. code-block:: console $ ./vsperf --conf-file=/10_custom.conf - --test-param "guest_loopback=testpmd" + --test-params "guest_loopback=testpmd" Supported loopback applications are: @@ -443,7 +443,7 @@ Mode of operation is driven by configuration parameter -m or --mode "trafficgen-pause" - execute vSwitch and VNF but wait before traffic transmission In case, that VSPERF is executed in "trafficgen" mode, then configuration -of traffic generator should be configured through --test-param option. +of traffic generator should be configured through --test-params option. Supported CLI options useful for traffic generator configuration are: .. code-block:: console -- cgit 1.2.3-korg