Opened 8 years ago
Closed 3 years ago
#820 closed Bug / Defect (fixed)
Compress manual doesn't list lz4-v2
Reported by: | jiquera | Owned by: | David Sommerseth |
---|---|---|---|
Priority: | minor | Milestone: | release 2.5.4 |
Component: | Documentation | Version: | OpenVPN 2.4.0 (Community Ed) |
Severity: | Not set (select this one, unless your'e a OpenVPN developer) | Keywords: | |
Cc: | plaisthos |
Description
Please fix the entry in the manual and explain the difference and the preferred setting. Right know the sample scrips are using lz4-v2 and the manual only mentions lz4.
Related to that... why do you support both? the difference is pretty much negligible. (one byte at most per packet)
Change History (13)
comment:1 Changed 8 years ago by
Cc: | plaisthos added |
---|
comment:2 Changed 8 years ago by
Milestone: | → release 2.4.1 |
---|
comment:3 Changed 8 years ago by
yeah you explained it the other day over IRC ;) which finally made me understand the code. This is basically the follow up: document it :)
comment:5 Changed 5 years ago by
Milestone: | release 2.4.1 → release 2.4.9 |
---|---|
Owner: | set to David Sommerseth |
Status: | new → assigned |
@dazo: while you're at moving the manpage over to rst, can you include lz4-v2?
comment:8 Changed 4 years ago by
Milestone: | release 2.4.9 → release 2.5.2 |
---|
comment:9 Changed 4 years ago by
It is already in the manpage:
The algorithm
parameter may be :code:
lzo
, :code:lz4
,
:code:
lz4-v2
, :code:stub
, :code:stub-v2
or empty.
LZO and LZ4 are different compression algorithms, with LZ4 generally
offering the best performance with least CPU usage.
comment:11 Changed 3 years ago by
Milestone: | release 2.5.2 → release 2.5.4 |
---|
bumping to 2.5.4, waiting for the patch promised 19 months ago
comment:12 Changed 3 years ago by
The man
page now has a good description of compression, including:
The lz4-v2 and stub-v2 variants implement a better framing that does not add overhead when packets cannot be compressed. All other variants always add one extra framing byte compared to no compression framing.
Details: https://github.com/OpenVPN/openvpn/blob/master/doc/man-sections/protocol-options.rst
Scroll down to --compress algorithm
comment:13 Changed 3 years ago by
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
the difference is packet data alignment, which is better with the -v2 compression algorithms - which reflects into "less CPU usage, less power drain on mobile devices, possibly higher throughput".
And you're right, we need to document this.