Improve help text to notify users of iperf3 option LP: #1614649

1 files changed, 8 insertions, 1 deletions

diff --git a/bin/network b/bin/network
index 190b68f..a4d0ed2 100755
--- a/bin/network
+++ b/bin/network
@@ -537,6 +537,11 @@ network test -i eth0 -t iperf --target 192.168.0.1
 NOTE: The iperf test requires an iperf server running on the same network
 segment that the test machine is running on.
 
+Also, you can use iperf3 rather than iperf2 by specifying the -3 or --iperf3
+option like so:
+
+network test -i eth0 -t iperf -3 --target 192.168.0.1
+
 Configuration
 =============
 
@@ -585,7 +590,9 @@ TEST_TARGET_IPERF = iperf-server.example.com
 choices=("iperf", "stress"), default="iperf",
 help=("[iperf *Default*]"))
 test_parser.add_argument(
- '-3', '--iperf3', default=False, action="store_true")
+ '-3', '--iperf3', default=False, action="store_true",
+ help=("Tells the script to use iperf3 for testing, rather than the "
+ "default of iperf2"))
 test_parser.add_argument('--target', type=str)
 action.add_argument(
 '--datasize', type=str,