Document stub-v2 being basically an alias for no compression at all

Signed-off-by: Arne Schwabe <arne@rfc2549.org>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20210512131511.1309914-9-arne@rfc2549.org>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22346.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>

diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
index 4b6928c68fb380198ea456e76c98bba5998e7ec2..34d4255eefec6cd33e9756582593fb0790e83da8 100644 (file)
--- a/doc/man-sections/protocol-options.rst
+++ b/doc/man-sections/protocol-options.rst
@@ -96,6 +96,11 @@ configured in a compatible way between both the local and remote side.
   other variants always add one extra framing byte compared to no
   compression framing.
 
+  Especially :code:`stub-v2` is essentially identical to no compression and
+  no compression framing as its header indicates IP version 5 in a tun setup
+  and can (ab)used to complete disable compression to clients. (See the
+  :code:`migrate option below)
+
   If the ``algorithm`` parameter is :code:`stub`, :code:`stub-v2` or empty,
   compression will be turned off, but the packet framing for compression
   will still be enabled, allowing a different setting to be pushed later.