On 14/02/2022 13:41, Frank Lichtenheld wrote:
David Sommerseth <open...@sf.lists.topphemmelig.net> hat am 11.02.2022 21:39 
geschrieben:

On 10/02/2022 11:21, Frank Lichtenheld wrote:
The family specific options were generally omitted.

Signed-off-by: Frank Lichtenheld <fr...@lichtenheld.com>
---
   doc/man-sections/client-options.rst |  5 +++++
   doc/man-sections/link-options.rst   |  5 ++++-
   src/openvpn/options.c               | 17 +++++++++--------
   3 files changed, 18 insertions(+), 9 deletions(-)

v2: move #define around

diff --git a/doc/man-sections/client-options.rst 
b/doc/man-sections/client-options.rst
index 73f1ea51..4c4a8707 100644
--- a/doc/man-sections/client-options.rst
+++ b/doc/man-sections/client-options.rst
@@ -198,6 +198,11 @@ configuration.
     When iterating through connection profiles, only consider profiles using
     protocol ``p`` (:code:`tcp` \| :code:`udp`).

+  Note that this specifically only affects the protocol, not the inet
+  family (i.e. IPv4 vs. IPv6). While the option actually accepts
+  values like :code:`udp6`, there is no difference to specifying
+  :code:`udp`.
+

[...]
Perhaps something like the suggestion below might be somewhat clearer?

     Note that this specifically only affects the TCP/IP transport layer
     protocol (UDP/TCP), not the TCP/IP network layers (IPv4/IPv6).  In
     practice it means it will only consider connection profiles using
     either TCP or UDP.  This does not affect whether IPv4 or IPv6 is used
     as IP protocols. In this context, :code:`udp`, :code:`udp4` and
     :code:`udp6` are all considered the same. And similar with
     :code:`tcp`, :code:`tcp4` and :code:`tcp6`


Thanks, I hate it ;)

Seriously though, I find this too clunky. Yes, TCP/IP is
technically the correct name, but isn't that even more confusing?

Maybe we can find a compromise:

      Note that this specifically only filters by the transport layer
      protocol, i.e. UDP or TCP.  This does not affect whether IPv4 or
      IPv6 is used as IP protocol.

      For implementation reasons the option accepts the :code:`4` and :code:`6`
      suffixes when specifying the protocol
      (i.e. :code:`udp4` / :code:`udp6` / :code:`tcp4` / :code:`tcp6`).
      However, these behave the same as without the suffix and should be avoided
      to prevent confusion.
Thanks, that's better!  Let's roll with that.


--
kind regards,

David Sommerseth
OpenVPN Inc

Attachment: OpenPGP_signature
Description: OpenPGP digital signature

_______________________________________________
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

Reply via email to