[Openvpn-devel,v2,1/2] doc: Fix hyperlinks in openvpn(8)

Message ID 20251006144249.23672-2-lists@nerdbynature.de
State New
Headers show
Series Documentation fixes | expand

Commit Message

Christian Kujau Oct. 6, 2025, 2:42 p.m. UTC
From: Christian Kujau <github@nerdbynature.de>

* http://www.cs.ucsd.edu/users/mihir/papers/hmac.html - 404, RFC104 basically
* http://sites.inka.de/sites/bigred/devel/tcp-tcp.html - 404, unfortunately
* http://www.ietf.org/rfc/rfc2246.txt - HTTPS upgrade to the HTML version

Signed-off-by: Christian Kujau <github@nerdbynature.de>
---
 doc/man-sections/link-options.rst     | 2 +-
 doc/man-sections/protocol-options.rst | 2 +-
 doc/openvpn.8.rst                     | 6 +++---
 3 files changed, 5 insertions(+), 5 deletions(-)

Comments

Frank Lichtenheld Oct. 13, 2025, 1:05 p.m. UTC | #1
On Mon, Oct 06, 2025 at 04:42:47PM +0200, Christian Kujau wrote:
> From: Christian Kujau <github@nerdbynature.de>
> 
> * http://www.cs.ucsd.edu/users/mihir/papers/hmac.html - 404, RFC104 basically

Probably a good replacement.

> * http://sites.inka.de/sites/bigred/devel/tcp-tcp.html - 404, unfortunately

Did a quick search, also couldn't come up with an immediate
replacement. For now the replacement is probably better than
nothing, but maybe we just need to write our own article about
the topic?

> * http://www.ietf.org/rfc/rfc2246.txt - HTTPS upgrade to the HTML version
 
Acked-by: Frank Lichtenheld <frank@lichtenheld.com>

Regards,
Gert Doering Oct. 13, 2025, 3:37 p.m. UTC | #2
Your patch has been applied to the master and release/2.6 branch
(documentation updates are always worthy a backport).

commit 3199fcebd3b3dd3f207d8cab7693d5eac3bdc64d (master)
commit a53b49ebb38e232c21b329bf997828ad589eb471 (release/2.6)
Author: Christian Kujau
Date:   Mon Oct 6 16:42:47 2025 +0200

     doc: Fix hyperlinks in openvpn(8)

     Signed-off-by: Christian Kujau <github@nerdbynature.de>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <20251006144249.23672-2-lists@nerdbynature.de>
     URL: https://sourceforge.net/p/openvpn/mailman/message/59242864/
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/link-options.rst b/doc/man-sections/link-options.rst
index 8334d16f..edda1ca2 100644
--- a/doc/man-sections/link-options.rst
+++ b/doc/man-sections/link-options.rst
@@ -338,7 +338,7 @@  the local and the remote host.
   used over unreliable or congested networks.
 
   This article outlines some of problems with tunneling IP over TCP:
-  http://sites.inka.de/sites/bigred/devel/tcp-tcp.html
+  https://web.archive.org/web/20141025181658/http://sites.inka.de/sites/bigred/devel/tcp-tcp.html
 
   There are certain cases, however, where using TCP may be advantageous
   from a security and robustness perspective, such as tunneling non-IP or
diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/protocol-options.rst
index d04ace88..6eac14ce 100644
--- a/doc/man-sections/protocol-options.rst
+++ b/doc/man-sections/protocol-options.rst
@@ -52,7 +52,7 @@  configured in a compatible way between both the local and remote side.
   authentication.
 
   For more information on HMAC see
-  http://www.cs.ucsd.edu/users/mihir/papers/hmac.html
+  https://tools.ietf.org/html/rfc2104
 
 --cipher alg
   This option should not be used any longer in TLS mode and still
diff --git a/doc/openvpn.8.rst b/doc/openvpn.8.rst
index dd9180ab..81cfe278 100644
--- a/doc/openvpn.8.rst
+++ b/doc/openvpn.8.rst
@@ -150,10 +150,10 @@  NOTES
 This product includes software developed by the OpenSSL Project
 (https://www.openssl.org/)
 
-For more information on the TLS protocol, see
-http://www.ietf.org/rfc/rfc2246.txt
+For more information on the TLS protocol see:
+https://tools.ietf.org/html/rfc2246
 
-For more information on the LZO real-time compression library see
+For more information on the LZO real-time compression library see:
 https://www.oberhumer.com/opensource/lzo/