[Openvpn-devel] doc: add "ovpn-dco" to usage and man page

Message ID 20220915120349.239-1-lstipakov@gmail.com
State Changes Requested
Headers show
Series [Openvpn-devel] doc: add "ovpn-dco" to usage and man page | expand

Commit Message

Lev Stipakov Sept. 15, 2022, 2:03 a.m. UTC
From: Lev Stipakov <lev@openvpn.net>

While on it, remove redundant sentence
and quotation from --windows-driver man
description.

Signed-off-by: Lev Stipakov <lev@openvpn.net>
---
 doc/man-sections/windows-options.rst | 8 ++++----
 src/openvpn/options.c                | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

Comments

Frank Lichtenheld Sept. 15, 2022, 2:15 a.m. UTC | #1
Did you not move the "(default)" to ovpn-dco since the other
patch, that makes ovpn-doc the default, is not merged, yet?

Patch is certainly correct relative to current master, so
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>

On Thu, Sep 15, 2022 at 03:03:49PM +0300, Lev Stipakov wrote:
> From: Lev Stipakov <lev@openvpn.net>
> 
> While on it, remove redundant sentence
> and quotation from --windows-driver man
> description.
> 
> Signed-off-by: Lev Stipakov <lev@openvpn.net>
> ---
>  doc/man-sections/windows-options.rst | 8 ++++----
>  src/openvpn/options.c                | 1 +
>  2 files changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/man-sections/windows-options.rst b/doc/man-sections/windows-options.rst
> index c389fbc4..0c7cfc1d 100644
> --- a/doc/man-sections/windows-options.rst
> +++ b/doc/man-sections/windows-options.rst
> @@ -238,7 +238,7 @@ Windows-Specific Options
>    logged when this is found in the configuration file.
>  
>  --windows-driver drv
> -  Specifies which tun driver to use. Values are :code:`tap-windows6`
> -  (default) and :code:`wintun`.  This is a Windows-only option.
> -  :code:`wintun`" requires ``--dev tun`` and the OpenVPN process to run
> -  elevated, or be invoked using the Interactive Service.
> +  Specifies which tun driver to use. Values are :code:`ovpn-dco`,
> +  :code:`tap-windows6` (default) and :code:`wintun`. :code:`wintun` requires
> +  ``--dev tun`` and the OpenVPN process to run elevated, or be invoked using
> +  the Interactive Service.
> diff --git a/src/openvpn/options.c b/src/openvpn/options.c
> index d7954ebc..0eef3b3d 100644
> --- a/src/openvpn/options.c
> +++ b/src/openvpn/options.c
> @@ -749,6 +749,7 @@ static const char usage_message[] =
>      "--show-net-up   : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n"
>      "                  after TAP adapter is up and routes have been added.\n"
>      "--windows-driver   : Which tun driver to use?\n"
> +    "                     ovpn-dco\n"
>      "                     tap-windows6 (default)\n"
>      "                     wintun\n"
>      "--block-outside-dns   : Block DNS on other network adapters to prevent DNS leaks\n"
> -- 
> 2.23.0.windows.1
Gert Doering Sept. 17, 2022, 2:27 a.m. UTC | #2
Hi,

On Thu, Sep 15, 2022 at 03:03:49PM +0300, Lev Stipakov wrote:
> From: Lev Stipakov <lev@openvpn.net>
> 
> While on it, remove redundant sentence
> and quotation from --windows-driver man
> description.

As Frank said, we should have a v2 of this, which moves the (default)
to "ovpn-dco" while at it.

> diff --git a/src/openvpn/options.c b/src/openvpn/options.c
> index d7954ebc..0eef3b3d 100644
> --- a/src/openvpn/options.c
> +++ b/src/openvpn/options.c
> @@ -749,6 +749,7 @@ static const char usage_message[] =
>      "--show-net-up   : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n"
>      "                  after TAP adapter is up and routes have been added.\n"
>      "--windows-driver   : Which tun driver to use?\n"
> +    "                     ovpn-dco\n"
>      "                     tap-windows6 (default)\n"

... in here, that is :-)

gert

Patch

diff --git a/doc/man-sections/windows-options.rst b/doc/man-sections/windows-options.rst
index c389fbc4..0c7cfc1d 100644
--- a/doc/man-sections/windows-options.rst
+++ b/doc/man-sections/windows-options.rst
@@ -238,7 +238,7 @@  Windows-Specific Options
   logged when this is found in the configuration file.
 
 --windows-driver drv
-  Specifies which tun driver to use. Values are :code:`tap-windows6`
-  (default) and :code:`wintun`.  This is a Windows-only option.
-  :code:`wintun`" requires ``--dev tun`` and the OpenVPN process to run
-  elevated, or be invoked using the Interactive Service.
+  Specifies which tun driver to use. Values are :code:`ovpn-dco`,
+  :code:`tap-windows6` (default) and :code:`wintun`. :code:`wintun` requires
+  ``--dev tun`` and the OpenVPN process to run elevated, or be invoked using
+  the Interactive Service.
diff --git a/src/openvpn/options.c b/src/openvpn/options.c
index d7954ebc..0eef3b3d 100644
--- a/src/openvpn/options.c
+++ b/src/openvpn/options.c
@@ -749,6 +749,7 @@  static const char usage_message[] =
     "--show-net-up   : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n"
     "                  after TAP adapter is up and routes have been added.\n"
     "--windows-driver   : Which tun driver to use?\n"
+    "                     ovpn-dco\n"
     "                     tap-windows6 (default)\n"
     "                     wintun\n"
     "--block-outside-dns   : Block DNS on other network adapters to prevent DNS leaks\n"