Skip to content

Commit

Permalink
Documentation cleanups and updates. Update to a sane version number.
Browse files Browse the repository at this point in the history
  • Loading branch information
bmah888 committed Nov 8, 2023
1 parent a393df1 commit b3686c6
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 45 deletions.
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,26 +115,6 @@ The projects (as of mid-2021) are in active, but separate, development.
The continuing iperf2 development
project can be found at https://sourceforge.net/projects/iperf2/.

iperf3 contains a number of options and functions not present in
iperf2. In addition, some flags are changed from their iperf2
counterparts:

-C, --linux-congestion set congestion control algorithm (Linux only)
(-Z in iperf2)
--bidir bidirectional testing mode
(-d in iperf2)

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)
S(settings) V(server) reports
-y, --reportstyle C report as a Comma-Separated Values

Also removed is the ability to set the options via environment
variables.

Known Issues
------------

Expand Down
37 changes: 15 additions & 22 deletions RELNOTES.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,30 @@
iperf3 Release Notes
====================

iperf-3.15-mt-beta1 2023-09-29
------------------------------
Accumulated release notes from iperf-3.14 and earlier multithreaded
beta releases:
iperf-3.16-beta1 2023-XX-XX
---------------------------

* Notable user-visible changes

* Multiple test streams started with -P/--parallel will now be
serviced by different threads. This allows iperf3 to take
advantage of multiple CPU cores on modern processors.
advantage of multiple CPU cores on modern processors, and will
generally result in significant throughput increases (PR #1591).

* Remove some busy-waiting left over from the original
single-threaded implementation, which caused the multi-threaded
iperf3 to consume CPU resources for no particular reason, and
possible subsequent packet loss.

* CentOS 7's default compiler is a version of GCC that is too old to
compile code using C11 atomic variables. A workaround has been
devised for 64-bit CentOS 7 systems, it is not clear whether this
approach will work on 32-bit CentOS 7 hosts, or other
similarly-vintage build environment.

* Fix a bug related to idle timeouts, so that the --rcv-timeout
option works correctly.

* Make shutdown of threads more tolerant in the face of various
orders of operations at the end of tests.
* OpenSSL 3 is now detected at build time. If OpenSSL 3 is found,
various older, deprecated, APIs will not be used. iperf3 will
continue to work with OpenSSL 1.1.1. OpenSSL is used for as a part
of the iperf3 authentication functionality (Issue #1300, PR #1589).

* The authorized users file used by the authentication functionality
is now checked for accessibility much earlier during the program
startup, as opposed to being checked near the start of a
test (Issue #1583, PR # 1585).

* Developer-visible changes

* iperf3 requires pthreads and C atomic variables to compile and run.
* BREAKING CHANGE: iperf3 now requires pthreads and C atomic variables
to compile and run.

iperf-3.15 2023-09-14
---------------------
Expand Down
4 changes: 2 additions & 2 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# iperf, Copyright (c) 2014-2022, The Regents of the University of
# iperf, Copyright (c) 2014-2023, The Regents of the University of
# California, through Lawrence Berkeley National Laboratory (subject
# to receipt of any required approvals from the U.S. Dept. of
# Energy). All rights reserved.
Expand All @@ -25,7 +25,7 @@

# Initialize the autoconf system for the specified tool, version and mailing list
AC_PREREQ([2.71])
AC_INIT([iperf],[3.15-mt],[https://github.com/esnet/iperf],[iperf],[https://software.es.net/iperf/])
AC_INIT([iperf],[3.16-beta],[https://github.com/esnet/iperf],[iperf],[https://software.es.net/iperf/])
m4_include([config/ax_check_openssl.m4])
m4_include([config/ax_pthread.m4])
m4_include([config/iperf_config_static_bin.m4])
Expand Down
2 changes: 1 addition & 1 deletion src/iperf3.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH IPERF3 1 "April 2023" ESnet "User Manuals"
.TH IPERF3 1 "November 2023" ESnet "User Manuals"
.SH NAME
iperf3 \- perform network throughput tests
.SH SYNOPSIS
Expand Down

0 comments on commit b3686c6

Please sign in to comment.