Browse code

Document comp-lzo no and compress being incompatible

Most of the new compress but not v2 version do use swap operation. For
'compress lzo' the swap option is not used for backwards compatibility.
For lz4 the swap option is also not a problem since there is no version
without swap. Unfortunately, compress introduced a second stub format
with swap, contrary to the one in 'comp-lzo no' that does not use swap.

Document this weirdness to let not others fall into this trap.

v2: redo patch for rst man pages

Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20200811110248.3396-1-arne@rfc2549.org>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg20708.html

Signed-off-by: Gert Doering <gert@greenie.muc.de>

Arne Schwabe authored on 2020/08/11 20:02:48
Showing 1 changed files
... ...
@@ -103,6 +103,9 @@ configured in a compatible way between both the local and remote side.
103 103
   ``lzo`` and ``lz4`` compression support via *IV_* variables to the
104 104
   server.
105 105
 
106
+  Note: the :code:`stub` (or empty) option is NOT compatible with the older
107
+  option ``--comp-lzo no``.
108
+
106 109
   ***Security Considerations***
107 110
 
108 111
   Compression and encryption is a tricky combination. If an attacker knows