diff mbox series

[Openvpn-devel,v1] doc: improve Windows-specific options section

Message ID 20260313103707.14534-1-frank@lichtenheld.com
State New
Headers show
Series [Openvpn-devel,v1] doc: improve Windows-specific options section | expand

Commit Message

Frank Lichtenheld March 13, 2026, 10:37 a.m. UTC 
From: Heiko Hund <heiko@ist.eigentlich.net>

Change-Id: I29a33ac23f3c1a7cf16196aecc46ec3597a22175
Signed-off-by: Heiko Hund <heiko@ist.eigentlich.net>
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1574
---

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1574
This mail reflects revision 1 of this Change.

Acked-by according to Gerrit (reflected above):
Frank Lichtenheld <frank@lichtenheld.com>

Comments

Gert Doering March 14, 2026, 4:53 p.m. UTC | #1 
Documentation improvements are always good :-)

Your patch has been applied to the master branch.

commit 3459f09f497addac98f5d3e11d7e13e29d711336 (master)
commit 78314ce757f17e78d1dee3f23dce9ae3ab3c6105 (release/2.7)
Author: Heiko Hund
Date:   Fri Mar 13 11:37:07 2026 +0100

     doc: improve Windows-specific options section

     Signed-off-by: Heiko Hund <heiko@ist.eigentlich.net>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1574
     Message-Id: <20260313103707.14534-1-frank@lichtenheld.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg36084.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering
diff mbox series

Patch

diff --git a/doc/man-sections/windows-options.rst b/doc/man-sections/windows-options.rst
index af2fb45..8d7dcbb 100644
--- a/doc/man-sections/windows-options.rst
+++ b/doc/man-sections/windows-options.rst
@@ -1,6 +1,12 @@ 
 Windows-Specific Options
 -------------------------
 
+These options are considered unknown on non-Windows platforms, resulting
+in fatal error (except ``--route-method``). You may want to use
+``--setenv opt`` or ``--ignore-unknown-option`` to ignore said error.
+Note that pushing unknown options from server does not trigger fatal
+errors.
+
 --allow-nonadmin TAP-adapter
   (Standalone) Set ``TAP-adapter`` to allow access from non-administrative
   accounts. If ``TAP-adapter`` is omitted, all TAP adapters on the system
@@ -16,12 +22,6 @@ 
   one inside the tunnel. It uses Windows Filtering Platform (WFP) and
   works on Windows Vista or later.
 
-  This option is considered unknown on non-Windows platforms and
-  unsupported on Windows XP, resulting in fatal error. You may want to use
-  ``--setenv opt`` or ``--ignore-unknown-option`` (not suitable for
-  Windows XP) to ignore said error. Note that pushing unknown options from
-  server does not trigger fatal errors.
-
 --cryptoapicert select-string
   *(Windows/OpenSSL Only)* Load the certificate and private key from the
   Windows Certificate System Store.