[Openvpn-devel] man page: Remove cruft from --topology documentation

Message ID 20230503135922.54871-1-frank@lichtenheld.com
State Accepted
Headers show
Series [Openvpn-devel] man page: Remove cruft from --topology documentation | expand

Commit Message

Frank Lichtenheld May 3, 2023, 1:59 p.m. UTC
None of this is likely relevant for a current reader.

Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
---
 doc/man-sections/vpn-network-options.rst | 9 ++-------
 1 file changed, 2 insertions(+), 7 deletions(-)

Comments

Gert Doering May 8, 2023, 11:57 a.m. UTC | #1
Acked-by: Gert Doering <gert@greenie.muc.de>

"Because it makes sense".

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

commit 03174bea4805bc018190d56a96f750f72fd960c1 (master)
commit 3779cefe5d3636f722a4df51db6162fcc44e2dcd (release/2.6)
Author: Frank Lichtenheld
Date:   Wed May 3 15:59:21 2023 +0200

     man page: Remove cruft from --topology documentation

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


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst
index c25bbf31..3a281495 100644
--- a/doc/man-sections/vpn-network-options.rst
+++ b/doc/man-sections/vpn-network-options.rst
@@ -513,7 +513,7 @@  routing.
     Use a point-to-point topology, by allocating one /30 subnet
     per client. This is designed to allow point-to-point semantics when some
     or all of the connecting clients might be Windows systems. This is the
-    default on OpenVPN 2.0.
+    default.
 
   :code:`p2p`
     Use a point-to-point topology where the remote endpoint of
@@ -527,12 +527,7 @@  routing.
     configuring the tun interface with a local IP address and subnet mask,
     similar to the topology used in ``--dev tap`` and ethernet bridging
     mode. This mode allocates a single IP address per connecting client and
-    works on Windows as well. Only available when server and clients are
-    OpenVPN 2.1 or higher, or OpenVPN 2.0.x which has been manually patched
-    with the ``--topology`` directive code. When used on Windows, requires
-    version 8.2 or higher of the TAP-Win32 driver. When used on \*nix,
-    requires that the tun driver supports an ``ifconfig``\(8) command which
-    sets a subnet instead of a remote endpoint IP address.
+    works on Windows as well.
 
   *Note:* Using ``--topology subnet`` changes the interpretation of the
   arguments of ``--ifconfig`` to mean "address netmask", no longer "local