[Openvpn-devel,v1] Remove "experimental" denotation for --fast-io

Message ID 20240618120156.4836-1-gert@greenie.muc.de
State Accepted
Headers show
Series [Openvpn-devel,v1] Remove "experimental" denotation for --fast-io | expand

Commit Message

Gert Doering June 18, 2024, 12:01 p.m. UTC
From: Frank Lichtenheld <frank@lichtenheld.com>

This option is very old (from SVN days) and has been
used by Access Server for many years. I don't think it
makes sense to claim that it is "experimental" at this

Change-Id: I913bb70c5e527e78e7cdb43110e23a8944f35a22
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/664
This mail reflects revision 1 of this Change.

Acked-by according to Gerrit (reflected above):
Arne Schwabe <arne-openvpn@rfc2549.org>


Gert Doering June 18, 2024, 4:36 p.m. UTC | #1
Documentation is good :-) - not tested besides a local build ("are all
the double quotes still in the right spot").

Your patch has been applied to the master and release/2.6 branch (docs).

commit f6ee77d1f6149cf8f8982998aee6d433f58be507 (master)
commit d5c4c643f36637987d830494b407f2855c5e3fea (release/2.6)
Author: Frank Lichtenheld
Date:   Tue Jun 18 14:01:56 2024 +0200

     Remove experimental denotation for --fast-io

     Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
     Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>
     Message-Id: <20240618120156.4836-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28772.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>

kind regards,

Gert Doering


diff --git a/doc/man-sections/generic-options.rst b/doc/man-sections/generic-options.rst
index f8a0f48..eb9cf28 100644
--- a/doc/man-sections/generic-options.rst
+++ b/doc/man-sections/generic-options.rst
@@ -215,7 +215,7 @@ 
   are supported by OpenSSL.
-  (Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to
+  Optimize TUN/TAP/UDP I/O writes by avoiding a call to
   poll/epoll/select prior to the write operation. The purpose of such a
   call would normally be to block until the device or socket is ready to
   accept the write. Such blocking is unnecessary on some platforms which
diff --git a/src/openvpn/options.c b/src/openvpn/options.c
index abcde89..f2c7536 100644
--- a/src/openvpn/options.c
+++ b/src/openvpn/options.c
@@ -268,7 +268,7 @@ 
     "--multihome     : Configure a multi-homed UDP server.\n"
-    "--fast-io       : (experimental) Optimize TUN/TAP/UDP writes.\n"
+    "--fast-io       : Optimize TUN/TAP/UDP writes.\n"
     "--remap-usr1 s  : On SIGUSR1 signals, remap signal (s='SIGHUP' or 'SIGTERM').\n"
     "--persist-tun   : Keep tun/tap device open across SIGUSR1 or --ping-restart.\n"
     "--persist-remote-ip : Keep remote IP address across SIGUSR1 or --ping-restart.\n"