Skip to content

Commit

Permalink
trim excess whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
a1346054 committed Sep 3, 2021
1 parent 50d6cce commit e919e8c
Show file tree
Hide file tree
Showing 36 changed files with 324 additions and 337 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ os:
- linux
- osx
- freebsd

notifications:
slack:
secure: ImUmX7hcYotHWCDBfOcIvF6H7kkeGqiaUCy7SVPFtgPbz33ttpbRd94E7oxWVmZMLKb+i6+JCujTEWGwGBimzH+DjL0LLWs0ShzXZIUa1UzEPTc4hgV6VAxucYKFg2WrbXgOPWbulkMG1VZ6pX7GlAEGf0qyNqn44F7S2ay9m18=
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Invoking iperf3
iperf3 includes a manual page listing all of the command-line options.
The manual page is the most up-to-date reference to the various flags and parameters.

For sample command line usage, see:
For sample command line usage, see:

https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/

Expand Down Expand Up @@ -119,7 +119,7 @@ Some iperf2 options are not available in iperf3:

-r, --tradeoff Do a bidirectional test individually
-T, --ttl time-to-live, for multicast (default 1)
-x, --reportexclude [CDMSV] exclude C(connection) D(data) M(multicast)
-x, --reportexclude [CDMSV] exclude C(connection) D(data) M(multicast)
S(settings) V(server) reports
-y, --reportstyle C report as a Comma-Separated Values

Expand Down
9 changes: 4 additions & 5 deletions contrib/iperf3.gp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# sample Gnuplot command file for iperf3 results
set term x11
#set term png
#set term png
#set term postscript landscape color
set key width -12

Expand All @@ -19,11 +19,11 @@ set grid linewidth 1
set title "TCP performance: 40G to 10G host"
set xlabel "time (seconds)"
set ylabel "Bandwidth (Gbits/second)"
set xrange [0:60]
set yrange [0:15]
set xrange [0:60]
set yrange [0:15]
set ytics nomirror
set y2tics
set y2range [0:2500]
set y2range [0:2500]
# dont plot when retransmits = 0
set datafile missing '0'
set pointsize 1.6
Expand All @@ -34,4 +34,3 @@ plot "40Gto10G.old.dat" using 1:3 title '3.10 kernel' with linespoints lw 3 pt 5

#plot "iperf3.old.dat" using 1:3 title '3.10 kernel' with linespoints lw 3 pt 5, \
# "iperf3.new.dat" using 1:3 title '4.2 kernel' with linespoints lw 3 pt 7

2 changes: 1 addition & 1 deletion docs/2017-04-27.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ State of the iperf3 World, as seen from ESnet...
------------------------------------------------

iperf3 was originally written to be a "better", more maintainable
follow-on to iperf2. This was seen to be necessary to fill the
follow-on to iperf2. This was seen to be necessary to fill the
requirements for the perfSONAR project (http://www.perfsonar.net).

In the past few years, iperf2 development has been restarted by Bob
Expand Down
1 change: 0 additions & 1 deletion docs/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ help to run ``./bootstrap.sh`` first from the top-level directory.
By default, the ``libiperf`` library is built in both shared and
static forms. Either can be suppressed by using the
``--disabled-shared`` or ``--disable-static`` configure-time options.

10 changes: 5 additions & 5 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Bug Reports
-----------

Before submitting a bug report, try checking out the latest version of
the code, and confirm that it's not already fixed. Also see the :doc:`faq`.
the code, and confirm that it's not already fixed. Also see the :doc:`faq`.
Then submit to the iperf3 issue tracker on GitHub:

https://github.com/esnet/iperf/issues
Expand All @@ -47,7 +47,7 @@ for a complete list of iperf3 options)::
-T, --title str prefix every output line with this string
-F, --file name xmit/recv the specified file
-A, --affinity n/n,m set CPU affinity (Linux and FreeBSD only)
-k, --blockcount #[KMG] number of blocks (packets) to transmit (instead
-k, --blockcount #[KMG] number of blocks (packets) to transmit (instead
of -t or -n)
-L, --flowlabel set IPv6 flow label (Linux only)

Expand All @@ -62,7 +62,7 @@ Deprecated flags (currently no plans to support)::
-d, --dualtest Do a bidirectional test simultaneously
-r, --tradeoff Do a bidirectional test individually
-T, --ttl time-to-live, for multicast (default 1)
-x, --reportexclude [CDMSV] exclude C(connection) D(data) M(multicast)
-x, --reportexclude [CDMSV] exclude C(connection) D(data) M(multicast)
S(settings) V(server) reports
-y, --reportstyle C report as a Comma-Separated Values

Expand Down Expand Up @@ -176,7 +176,7 @@ Release Engineering Checklist
7. For extra points, actually try downloading, compiling, and
smoke-testing the results of the tarball on all supported
platforms.

8. Plug the SHA256 checksum into the release announcement.

9. PGP-sign the release announcement text using ``gpg --clearsign``.
Expand Down Expand Up @@ -233,7 +233,7 @@ Code Authors
The main authors of iperf3 are (in alphabetical order): Jon Dugan,
Seth Elliott, Bruce A. Mah, Jeff Poskanzer, Kaustubh Prabhu.
Additional code contributions have come from (also in alphabetical
order): Mark Ashley, Aaron Brown, Aeneas Jaißle, Susant Sahani,
order): Mark Ashley, Aaron Brown, Aeneas Jaißle, Susant Sahani,
Bruce Simpson, Brian Tierney.

iperf3 contains some original code from iperf2. The authors of iperf2
Expand Down
24 changes: 11 additions & 13 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,35 +13,35 @@ What is the history of iperf3, and what is the difference between iperf2 and ipe
threaded, and not worry about backwards compatibility with
iperf2. Many of the feature requests for iperf3 came from the
perfSONAR project (http://www.perfsonar.net).

Then in 2014, Bob (Robert) McMahon from Broadcom restarted
development of iperf2 (See
https://sourceforge.net/projects/iperf2/). He fixed many of the
problems with iperf2, and added a number of new features similar to
iperf3. iperf2.0.8, released in 2015, made iperf2 a useful tool. iperf2's
iperf3. iperf2.0.8, released in 2015, made iperf2 a useful tool. iperf2's
current development is focused is on using UDP for latency testing, as well
as broad platform support.

As of this writing (2017), both iperf2 and iperf3 are being actively
(although independently) developed. We recommend being familiar with
both tools, and use whichever tool’s features best match your needs.

A feature comparison of iperf2, iperf3, and nuttcp is available at:
https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/throughput-tool-comparision/

iperf3 parallel stream performance is much less than iperf2. Why?
iperf3 is single threaded, and iperf2 is multi-threaded. We
recommend using iperf2 for parallel streams.
If you want to use multiple iperf3 streams use the method described `here <https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/multi-stream-iperf3/>`_.

I’m trying to use iperf3 on Windows, but having trouble. What should I do?
iperf3 is not officially supported on Windows, but iperf2 is. We
recommend you use iperf2.

Some people are using Cygwin to run iperf3 in Windows, but not all
options will work. Some community-provided binaries of iperf3 for
Windows exist.

How can I build a statically-linked executable of iperf3?
There are a number of reasons for building an iperf3 executable with
no dependencies on any shared libraries. Unfortunately this isn't
Expand Down Expand Up @@ -123,10 +123,10 @@ I'm seeing quite a bit of unexpected UDP loss. Why?
issue with the default UDP send size that was fixed in
3.1.5. Second, try adding the flag ``-w2M`` to increase the socket
buffer sizes. That seems to make a big difference on some hosts.

iperf3 UDP does not seem to work at bandwidths less than 100Kbps. Why?
You'll need to reduce the default packet length to get UDP rates of less that 100Kbps. Try ``-l100``.

TCP throughput drops to (almost) zero during a test, what's going on?
A drop in throughput to almost zero, except maybe for the first
reported interval(s), may be related to problems in NIC TCP Offload,
Expand Down Expand Up @@ -184,13 +184,13 @@ What congestion control algorithms are supported?
On Linux, run this command to see the available congestion control
algorithms (note that some algorithms are packaged as kernel
modules, which must be loaded before they can be used)::

/sbin/sysctl net.ipv4.tcp_available_congestion_control

On FreeBSD, the equivalent command is::

/sbin/sysctl net.inet.tcp.cc.available

I’m using the ``--logfile`` option. How do I see file output in real time?
Use the ``--forceflush`` flag.

Expand Down Expand Up @@ -252,5 +252,3 @@ I have a question regarding iperf3...what's the best way to get help?
We discourage the use of the iperf3 issue tracker on GitHub for
support questions. Actual bug reports, enhancement requests, or
pull requests are encouraged, however.


1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Loading

0 comments on commit e919e8c

Please sign in to comment.