d/iperf3-tls
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor updates, wording fixes, etc.

Browse Source
This commit is contained in:
Bruce A. Mah 2014-04-07 11:02:32 -07:00
parent 95d7c7d5fd
commit 8c369d40f4
No known key found for this signature in database
GPG Key ID: 4984910A8CAAEE8A
4 changed files with 50 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/dev.rst
View File

@ -11,7 +11,7 @@ wiki.
Mailing Lists
-------------
The developer list for iperf3 is: iperf3-dev@googlegroups.com.
The developer list for iperf3 is: iperf-dev@googlegroups.com.
Information on joining the mailing list can be found at:
http://groups.google.com/group/iperf-dev
@ -30,8 +30,9 @@ iperf3 issue tracker on GitHub:
https://github.com/esnet/iperf/issues
**Note:** Issues submitted to the old iperf3 issue tracker on Google
Code will be ignored.
**Note:** Issues submitted to the old iperf3 issue tracker on Google
Code (or comments to existing issues on the Google Code issue tracker)
will be ignored.
Changes from iperf 2.x
----------------------
@ -78,19 +79,18 @@ tracker. These issues are either open (indicating no solution
currently exists) or closed with the notation that no further attempts
to solve the problem are currently being made:
* UDP performance: iperf2/iperf3 both only are only about 50% as fast
as nuttcp in UDP mode. We are looking into this, but in the
meantime, if you want to get UDP above 5Gbps, we recommend using
nuttcp instead (http://www.nuttcp.net/). (Issue #55)
* UDP performance: iperf2/iperf3 are both only about 50% as fast
as nuttcp in UDP mode. This is being investigated, but in the
meantime, if UDP tests above 5Gbps are needed, using
`nuttcp <http://www.nuttcp.net/>`_ is recommended. (Issue #55)
* Interval reports on high-loss networks: The way iperf3 is currently
implemented, the sender write command will block until the entire
block has been written. This means that it might take several
seconds to send a full block if the network has high loss, and the
interval reports will have widely varying interval times. We are
trying to determine the best solution to this, but in the meantime,
try using a smaller block size if you get strange interval reports.
For example, try ``-l 4K``. (Issue #125)
interval reports will have widely varying interval times. A
solution is being discussed, but in the meantime a work around is to
try using a small block size, for example ``-l 4K``. (Issue #125)
* The ``-Z`` flag sometimes hangs on OSX. (Issue #129)
@ -98,10 +98,12 @@ to solve the problem are currently being made:
that it can only be used with IPv4. (Issue #108)
* When specifying the TCP buffer size using the ``-w`` flag on Linux,
Linux doubles the value you pass in. (You can see this using
iperf3's debug flag.) But then the CWND does not actually ramp up
the Linux kernel automatically doubles the value passed in to
compensate for overheads. (This can be observed by using
iperf3's ``--debug`` flag.) However, CWND does not actually ramp up
to the doubled value, but only to about 75% of the doubled
value. This appears to be by design. (Issue #145)
value. Some part of this behavior is documented in the tcp(7)
manual page. (Issue #145)
There are, of course, many other open and closed issues in the issue
tracker.
@ -109,7 +111,9 @@ tracker.
Versioning
----------
iperf version numbers use three-part release numbers: *MAJOR.MINOR.PATCH*
iperf3 version numbers use (roughly) a `Semantic Versioning
<http://semver.org/>`_ scheme, in which version numbers consist of
three parts: *MAJOR.MINOR.PATCH*
The developers increment the:
@ -119,8 +123,6 @@ The developers increment the:
* *PATCH* version when making backwards-compatible bug fixes.
This is roughly along the line of `Semantic Versioning <http://semver.org/>`_.
Release Engineering Checklist
-----------------------------
@ -149,7 +151,7 @@ Release Engineering Checklist
Doing the above steps on CentOS 6 (with its somewhat older
autotools / libtools suite) is preferred; newer systems generate
``configure`` and ``Makefile`` scripts that tend to rebuild
themselves rather frequently. We might be able to address this
themselves rather frequently. It might be possible to address this
problem (and graduate to newer autotools) by using
``AC_MAINTAINER_MODE`` but there's a fair amount of religion
associated with this.
@ -180,3 +182,8 @@ Release Engineering Checklist
* perfsonar-dev@internet2.edu
10. Update the iperf3 Project News section of the documentation site
to announce the new release (see ``docs/news.rst`` in the source
tree) and deploy a new build of the documentation to GitHub
Pages.

15
docs/index.rst
View File

@ -12,7 +12,7 @@ related to timing, protocols, and buffers. For each test it reports
the bandwidth, 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
original version developed at NLANR / DAST. iperf3 is a new
implementation from scratch, with the goal of a smaller, simpler code
base, and a library version of the functionality that can be used in
other programs. iperf3 also incorporates a number of features found in
@ -21,13 +21,14 @@ original iperf. These include, for example, a zero-copy mode and
optional JSON output. Note that iperf3 is *not* backwards compatible
with the original iperf.
Primary development for iperf3 takes place on CentOS Linux, FreeBSD,
and MacOS X. At this time, these are the only officially supported
platforms, however there have been some reports of success with
OpenBSD, Android, and other Linux distributions.
Primary development for iperf3 takes place on CentOS 6 Linux, FreeBSD
10, and MacOS 10.8. At this time, these are the only officially
supported platforms, however there have been some reports of success
with OpenBSD, Android, and other Linux distributions.
iperf3 is principally developed by ESnet / Lawrence Berkleley National
Laboratory. It is released under a three-clause BSD license.
iperf3 is principally developed by `ESnet <http://www.es.net/>`_ /
`Lawrence Berkleley National Laboratory <http://www.lbl.gov/>`_. It
is released under a three-clause BSD license.
The iperf3 project is hosted on GitHub at:

16
docs/news.rst
View File

@ -4,8 +4,8 @@ iperf3 Project News
2014-03-26: iperf-3.0.3 released
---------------------------------
| http://stats.es.net/software/iperf-3.0.3.tar.gz
| ``79daf3e5e5c933b2fc4843d6d21c98d741fe39b33ac05bd7a11c50d321a2f59d iperf-3.0.3.tar.gz``
| URL: http://stats.es.net/software/iperf-3.0.3.tar.gz
| SHA256: ``79daf3e5e5c933b2fc4843d6d21c98d741fe39b33ac05bd7a11c50d321a2f59d iperf-3.0.3.tar.gz``
This is the second maintenance release of iperf 3.0, containing a few bug fixes and enhancements, notably:
@ -17,14 +17,14 @@ This is the second maintenance release of iperf 3.0, containing a few bug fixes
* A possible buffer overflow related to error output has been fixed.
(This is not believed to be exploitable.)
More information on changes can be found in the RELEASE_NOTES
More information on changes can be found in the ``RELEASE_NOTES``
file in the source distribution.
2014-03-10: iperf-3.0.2 released
---------------------------------
| http://stats.es.net/software/iperf-3.0.2.tar.gz
| ``3c379360bf40e6ac91dfc508cb43fefafb4739c651d9a8d905a30ec99095b282 iperf-3.0.2.tar.gz``
| URL: http://stats.es.net/software/iperf-3.0.2.tar.gz
| SHA256: ``3c379360bf40e6ac91dfc508cb43fefafb4739c651d9a8d905a30ec99095b282 iperf-3.0.2.tar.gz``
**Note:** Due to a mistake in the release process, the distribution tarball referred to above is actually not compressed, despite its ``.tar.gz`` extension. Instead it is an uncompressed tar archive. The file checksum is correct, as are the file contents.
@ -40,7 +40,7 @@ GitHub. Of particular interest:
* libiperf is now built as both a shared and static library; by
default, the iperf3 binary links to the shared library.
More information on changes can be found in the RELEASE_NOTES
More information on changes can be found in the ``RELEASE_NOTES``
file in the source distribution.
2014-02-28: iperf migrated to GitHub
@ -53,8 +53,8 @@ https://github.com/esnet/iperf
2014-01-10: iperf-3.0.1 released
---------------------------------
| http://stats.es.net/software/iperf-3.0.1.tar.gz
| ``32b419ef634dd7670328c3cecc158babf7d706bd4b3d248cf95965528a20e614 iperf-3.0.1.tar.gz``
| URL: http://stats.es.net/software/iperf-3.0.1.tar.gz
| SHA256: ``32b419ef634dd7670328c3cecc158babf7d706bd4b3d248cf95965528a20e614 iperf-3.0.1.tar.gz``
During development, there were various distributions of the source
code unofficially released carrying a 3.0.0 version number. Because

13
docs/obtaining.rst
View File

@ -8,8 +8,13 @@ Binary Distributions
Binary packages are available for several supported operating systems:
* FreeBSD: `Ports Collection <http://freshports.org/benchmarks/iperf3>`_
* Fedora / CentOS:
* FreeBSD: `benchmarks/iperf3
<http://freshports.org/benchmarks/iperf3>`_ in the FreeBSD Ports Collection
* Fedora / CentOS: `iperf3
<https://apps.fedoraproject.org/packages/iperf3/>`_ and
`iperf3-devel
<https://apps.fedoraproject.org/packages/iperf3-devel>`_ in Fedora
19 and 20 and in Fedora EPEL 5, 6, and 7.
Source Distributions
--------------------
@ -35,7 +40,7 @@ GitHub using:
``git clone https://github.com/esnet/iperf.git``
Primary development for iperf3 takes place on CentOS 6 Linux, FreeBSD,
and MacOS X. At this time, these are the only officially supported
Primary development for iperf3 takes place on CentOS 6 Linux, FreeBSD 10,
and MacOS X 10.8. At this time, these are the only officially supported
platforms, however there have been some reports of success with
OpenBSD, Android, and other Linux distributions.