diff options
| author | Bruce A. Mah <bmah@kitchenlab.org> | 2017-05-24 10:50:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-24 10:50:44 -0700 |
| commit | 0f081b7b2e7a014df5a6b895b519881ebe15772c (patch) | |
| tree | 93f5928773a9635c38e19978805361a9e16dffb3 /docs/index.rst | |
| parent | 7a15a7ae85d0aaf420e8bdefd957b2c4f1322983 (diff) | |
| download | iperf3-0f081b7b2e7a014df5a6b895b519881ebe15772c.tar.gz | |
Issue 583 (#586)
* s/bandwidth/bitrate/ in user-facing places. Towards #583.
iperf3 has long misused terminology; bandwidth is a measure of
capacity. iperf3 measures bitrate or throughput. We standardize
on "bitrate" because it begins with the same letter as "bandwidth"
(to match the -b command-line option).
User-facing output mentioning "bandwidth" now uses "bitrate".
The long command-line option for -b (--bandwidth) is now --bitrate
(--bandwidth is transparently accepted for backward compatibility).
A few places in documentation that talk about bandwidth as a
measured value have been reworded to use bitrate or throughput.
There are a number of places in code where variables are still
called "bandwidth". We leave these alone for now.
A mention of "bandwidth" in the test parameters JSON also needs
to remain unchanged to avoid breaking compatibility. However,
the test results JSON never used the term "bandwidth" in
the first place.
* s/bandwidth/throughput in one place in RPM description. Towards #583.
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 3311933..6747ced 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,7 @@ iperf3 iperf is a tool for active measurements of the maximum achievable bandwidth on IP networks. It supports tuning of various parameters related to timing, protocols, and buffers. For each test it reports -the bandwidth, loss, and other parameters. +the measured throughput, loss, and other parameters. This version, sometimes referred to as iperf3, is a redesign of an original version developed at NLANR / DAST. iperf3 is a new |