diff options
author | Bruce A. Mah <bmah@es.net> | 2017-11-17 10:42:14 -0800 |
---|---|---|
committer | Bruce A. Mah <bmah@es.net> | 2017-11-17 10:42:14 -0800 |
commit | b3015d583bffe0f6524f54f378df5b1f126dd4ce (patch) | |
tree | 492d375fac1c0530804923e2bedbac33a7ae4349 | |
parent | c0225583af5495da91cc31859cb4e58d08ab6218 (diff) | |
download | iperf3-b3015d583bffe0f6524f54f378df5b1f126dd4ce.tar.gz |
Rewrite some text on the home page, and add a mention of iperf2.
That mention points to the iperf3 FAQ, which contains information
about the history of iperf2 and iperf3, and a pointer to continued
iperf2 development. Suggested by a comment from @beau-williamson
in #27.
-rw-r--r-- | docs/faq.rst | 2 | ||||
-rw-r--r-- | docs/index.rst | 15 |
2 files changed, 13 insertions, 4 deletions
diff --git a/docs/faq.rst b/docs/faq.rst index 334a894..991a6dd 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,3 +1,5 @@ +.. _faq: + iperf3 FAQ ========== diff --git a/docs/index.rst b/docs/index.rst index 6747ced..98c284c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,10 +6,11 @@ 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 measured throughput, loss, and other parameters. +The iperf series of tools perform active measurements to determine 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 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 @@ -30,6 +31,12 @@ iperf3 is principally developed by `ESnet <http://www.es.net/>`_ / `Lawrence Berkeley National Laboratory <http://www.lbl.gov/>`_. It is released under a three-clause BSD license. +iperf2 is no longer being developed by its original maintainers. +However, beginning in 2014, another developer began fixing bugs and +enhancing functionality, and generating releases of iperf2. Both +projects (as of late 2017) are currently being developed actively, but +independently. More information can be found in the :ref:`faq`. + Links for the Impatient ----------------------- |