diff mbox series

[Openvpn-devel,v3] Document tls-exit option mainly as test option

Message ID 20231201111937.15214-1-frank@lichtenheld.com
State Accepted
Headers show
Series [Openvpn-devel,v3] Document tls-exit option mainly as test option | expand

Commit Message

Frank Lichtenheld Dec. 1, 2023, 11:19 a.m. UTC 
From: Arne Schwabe <arne@rfc2549.org>

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

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/+/447
This mail reflects revision 3 of this Change.
Acked-by according to Gerrit (reflected above):
Frank Lichtenheld <frank@lichtenheld.com>

Comments

Gert Doering Dec. 2, 2023, 3:17 p.m. UTC | #1 
Straight and to the point :-)

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

commit ee6417e9d602d7d2db018739f07724b4660bf980 (master)
commit 350bdd85431548a7043085e475d6c8c611e2239f (release/2.6)
Author: Arne Schwabe
Date:   Fri Dec 1 12:19:37 2023 +0100

     Document tls-exit option mainly as test option

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


--
kind regards,

Gert Doering
diff mbox series

Patch

diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
index 908a42a..ad8ca72 100644
--- a/doc/man-sections/tls-options.rst
+++ b/doc/man-sections/tls-options.rst
@@ -553,7 +553,9 @@ 
   code.
 
 --tls-exit
-  Exit on TLS negotiation failure.
+  Exit on TLS negotiation failure. This option can be useful when you only
+  want to make one attempt at connecting, e.g. in a test or monitoring script.
+  (OpenVPN's own test suite uses it this way.)
 
 --tls-export-cert directory
   Store the certificates the clients use upon connection to this