diff mbox series

[Openvpn-devel,v2] doc: clarify that --float only applies to UDP

Message ID SXGKysQ5xx6qb0pPY8pAk_wO-B0Pl44xmifYB_bBdqIXMtGir8GTPKxhB2kivfBvPO2uU9bBnxbJVTTy2IDBqXlumDVRYOLOE-qEZfea5TQ=@pm.me
State New
Headers
Series [Openvpn-devel,v2] doc: clarify that --float only applies to UDP |

Commit Message

Sami Rusani June 29, 2026, 9:45 p.m. UTC 
  Hello!

The --float option lets OpenVPN accept authenticated packets from a
changed peer address. That only applies to UDP transports.

Document the transport limitation in the man page.

Github: fixes OpenVPN/openvpn#358
---
Changes from v1:
- Shorten the man-page wording per review.
- Leave the usage text unchanged.

 doc/man-sections/link-options.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Gert Doering June 30, 2026, 7:04 a.m. UTC | #1 
Thanks :-) - this one came "inline" and nicely fit my workflow.

Your patch has been applied to the master and release/2.7 branch
("documentation improvement").

commit fb863b6daa4f5a2033b937b60f9e93241546666d (master)
commit addf19c07964dfe5971a50f2b41f2021ec5f6480 (release/2.7)
Author: Sami Rusani via Openvpn-devel
Date:   Mon Jun 29 21:45:17 2026 +0000

     doc: clarify that --float only applies to UDP

     Acked-by: Gert Doering <gert@greenie.muc.de>
     Message-Id: <SXGKysQ5xx6qb0pPY8pAk_wO-B0Pl44xmifYB_bBdqIXMtGir8GTPKxhB2kivfBvPO2uU9bBnxbJVTTy2IDBqXlumDVRYOLOE-qEZfea5TQ=@pm.me>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg37401.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering
Gert Doering June 30, 2026, 7:59 a.m. UTC | #2 
Hi,

On Tue, Jun 30, 2026 at 09:04:58AM +0200, Gert Doering wrote:
> Thanks :-) - this one came "inline" and nicely fit my workflow.
> 
> Your patch has been applied to the master and release/2.7 branch
> ("documentation improvement").
> 
> commit fb863b6daa4f5a2033b937b60f9e93241546666d (master)
> commit addf19c07964dfe5971a50f2b41f2021ec5f6480 (release/2.7)
> Author: Sami Rusani via Openvpn-devel
> Date:   Mon Jun 29 21:45:17 2026 +0000

Well.  That patch came from a different sender, with DMARC active, so
the list messed-up the From: header, and I didn't notice - so I had to
re-merge, with new commit IDs.  Sorry for the confusion.

commit 401f629c6b01a4c8ed6e74c2e3e53fbc91078ec8 (master)
commit c0a545917c0f85ca0456c48eb90b516fd957bb16 (release/2.7)
Author: Sami Rusani <samgithub@pm.me>
Date:   Mon Jun 29 21:45:17 2026 +0000

    doc: clarify that --float only applies to UDP

gert
diff mbox series

Patch

diff --git a/doc/man-sections/link-options.rst b/doc/man-sections/link-options.rst
index edda1ca..df8c917 100644
--- a/doc/man-sections/link-options.rst
+++ b/doc/man-sections/link-options.rst
@@ -12,7 +12,9 @@  the local and the remote host.
 
 --float
   Allow remote peer to change its IP address and/or port number, such as
-  due to DHCP (this is the default if ``--remote`` is not used).
+  due to DHCP or NAT mappings changing. ``--float`` only works when
+  using UDP transport.
+
   ``--float`` when specified with ``--remote`` allows an OpenVPN session
   to initially connect to a peer at a known address, however if packets
   arrive from a new address and pass all authentication tests, the new