[Openvpn-devel] Typographical Error Corrections - Patch Submission

Message ID 4a3a9f1d691704f25f07653bb0de2583@riseup.net
State Accepted
Headers show
Series [Openvpn-devel] Typographical Error Corrections - Patch Submission | expand

Commit Message

aquilamacedo@riseup.net Nov. 1, 2023, 6:23 p.m. UTC
I am writing to inform you that I have identified and rectified several
typographical errors in the manpages. An attached patch contains the
necessary changes I've made.

In addition to the typographical error fixes, I am recommending these
changes in response to the lintian warnings generated during the Debian
packaging process for package updates.

Comments

Frank Lichtenheld Nov. 2, 2023, 4:36 p.m. UTC | #1
On Wed, Nov 01, 2023 at 06:23:57PM +0000, aquilamacedo@riseup.net wrote:
> I am writing to inform you that I have identified and rectified several
> typographical errors in the manpages. An attached patch contains the
> necessary changes I've made.

LGTM.

Acked-by: Frank Lichtenheld <frank@lichtenheld.com>

Regards,
Gert Doering Nov. 11, 2023, 7:31 p.m. UTC | #2
Thanks.

Your patch has been applied to the master and release/2.6 branch.

commit 20c42b89f6d38a4426b5fe67f59acaadcb9ac314 (master)
commit 457f468a76f324a14b1236988cc5f5a95f14abf5 (release/2.6)
Author: Aquila Macedo
Date:   Thu Oct 19 16:40:49 2023 -0300

     doc: Correct typos in multiple documentation files

     Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <4a3a9f1d691704f25f07653bb0de2583@riseup.net>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg27320.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

From 342a0ec1f2a0b0a6987d0dcdf54b2ccf03ac95e2 Mon Sep 17 00:00:00 2001
From: Aquila Macedo <aquilamacedo@riseup.net>
Date: Thu, 19 Oct 2023 16:40:49 -0300
Subject: [PATCH] doc: Correct typos in multiple documentation files

Fixed typographical errors in various documentation files for improved clarity and readability.

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
---
 doc/man-sections/client-options.rst      | 4 ++--
 doc/man-sections/generic-options.rst     | 2 +-
 doc/man-sections/server-options.rst      | 2 +-
 doc/man-sections/vpn-network-options.rst | 2 +-
 src/openvpn/options.c                    | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/man-sections/client-options.rst b/doc/man-sections/client-options.rst
index 3616ed7f3f8..54c4ec63073 100644
--- a/doc/man-sections/client-options.rst
+++ b/doc/man-sections/client-options.rst
@@ -51,9 +51,9 @@  configuration.
   react according to ``--auth-retry``
 
 --auth-token-user base64username
-  Companion option to ``--auth-token``. This options allows to override
+  Companion option to ``--auth-token``. This options allows one to override
   the username used by the client when reauthenticating with the ``auth-token``.
-  It also allows to use ``--auth-token`` in setups that normally do not use
+  It also allows one to use ``--auth-token`` in setups that normally do not use
   username and password.
 
   The username has to be base64 encoded.
diff --git a/doc/man-sections/generic-options.rst b/doc/man-sections/generic-options.rst
index 97e1b5aa610..95e4ca233bd 100644
--- a/doc/man-sections/generic-options.rst
+++ b/doc/man-sections/generic-options.rst
@@ -483,7 +483,7 @@  which mode OpenVPN is configured as.
 
   * :code:`OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY` plug-in hooks returns
     success/failure via :code:`auth_control_file` when using deferred auth
-    method and pending authentification via :code:`pending_auth_file`.
+    method and pending authentication via :code:`pending_auth_file`.
 
 --use-prediction-resistance
   Enable prediction resistance on mbed TLS's RNG.
diff --git a/doc/man-sections/server-options.rst b/doc/man-sections/server-options.rst
index 14a94801bb5..98f5340274f 100644
--- a/doc/man-sections/server-options.rst
+++ b/doc/man-sections/server-options.rst
@@ -739,7 +739,7 @@  fast hardware. SSL/TLS authentication must be used in this mode.
 
 --vlan-pvid v
   Specifies which VLAN identifier a "port" is associated with. Only valid
-  when ``--vlan-tagging`` is speficied.
+  when ``--vlan-tagging`` is specified.
 
   In the client context, the setting specifies which VLAN ID a client is
   associated with. In the global context, the VLAN ID of the server TAP
diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst
index 3fa3ccf1073..41d367bfd0e 100644
--- a/doc/man-sections/vpn-network-options.rst
+++ b/doc/man-sections/vpn-network-options.rst
@@ -548,7 +548,7 @@  routing.
   It's best to use the ``--fragment`` and/or ``--mssfix`` options to deal
   with MTU sizing issues.
 
-  Note: Depending on the platform, the operating system allows to receive
+  Note: Depending on the platform, the operating system allows one to receive
   packets larger than ``tun-mtu`` (e.g. Linux and FreeBSD) but other platforms
   (like macOS) limit received packets to the same size as the MTU.
 
diff --git a/src/openvpn/options.c b/src/openvpn/options.c
index 2b68bac8c67..21fc29ec324 100644
--- a/src/openvpn/options.c
+++ b/src/openvpn/options.c
@@ -591,7 +591,7 @@  static const char usage_message[] =
     "                  Windows Certificate System Store.\n"
 #endif
     "--tls-cipher l  : A list l of allowable TLS ciphers separated by : (optional).\n"
-    "--tls-ciphersuites l: A list of allowed TLS 1.3 cipher suites seperated by : (optional)\n"
+    "--tls-ciphersuites l: A list of allowed TLS 1.3 cipher suites separated by : (optional)\n"
     "                : Use --show-tls to see a list of supported TLS ciphers (suites).\n"
     "--tls-cert-profile p : Set the allowed certificate crypto algorithm profile\n"
     "                  (default=legacy).\n"