summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Trautman <ctrautma@redhat.com>2016-03-24 18:08:30 -0400
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-04-11 16:22:52 +0000
commit01bff4c5650f4cfb992276278d170a21c91431c3 (patch)
treee3cf5e2469d48b3dd5d7253247fb4d0378fd62dd
parent77aa724da2c879e1af079daae340d17e01b85601 (diff)
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 <ctrautma@redhat.com>
-rw-r--r--conf/04_vnf.conf2
-rw-r--r--docs/configguide/trafficgen.rst4
-rwxr-xr-xdocs/userguide/testusage.rst8
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=<path_to_custom_conf>/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=<path_to_custom_conf>/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
ef='#n323'>323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517