[Openvpn-devel] Update the replay-window backtrack log message

Message ID SVrvuTydxR6Qs_mvwvG7mqT8iLV0inlcCMXoenZTMI8M0LkosV4pZsH9m_XCTwcRWAPN5H8Zdro0ubhJrnSp6v5KC2ZNAL9So0Y2SKiSe7g=@protonmail.com
State Accepted
Headers show
Series [Openvpn-devel] Update the replay-window backtrack log message | expand

Commit Message

Kristof Provost via Openvpn-devel June 10, 2022, 12:04 p.m. UTC
The man pages reference a logging message which has been rephrased
in ac1310528a248c99e039e7afaf48724ad1b7f10e. This commit updates the
man page message to reflect the change for improved grep-ability.

Signed-off-by: Martin Janů <martin.janu@protonmail.com>
---
 doc/man-sections/link-options.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.36.1

Comments

Frank Lichtenheld June 20, 2022, 1:26 p.m. UTC | #1
Acked-By: Frank Lichtenheld <frank@lichtenheld.com>

Looks correct to me according to the code and the referenced commit.

Regards,
  Frank Lichtenheld

> Martin Janů via Openvpn-devel <openvpn-devel@lists.sourceforge.net> hat am 10.06.2022 14:04 CEST geschrieben:
> 
>  
> The man pages reference a logging message which has been rephrased
> in ac1310528a248c99e039e7afaf48724ad1b7f10e. This commit updates the
> man page message to reflect the change for improved grep-ability.
> 
> Signed-off-by: Martin Janů <martin.janu@protonmail.com>
> ---
>  doc/man-sections/link-options.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/man-sections/link-options.rst b/doc/man-sections/link-options.rst
> index 6473ad42..373193aa 100644
> --- a/doc/man-sections/link-options.rst
> +++ b/doc/man-sections/link-options.rst
> @@ -378,7 +378,7 @@ the local and the remote host.
>    value for ``n``. Satellite links in particular often require this.
> 
>    If you run OpenVPN at ``--verb 4``, you will see the message
> -  "Replay-window backtrack occurred [x]" every time the maximum sequence
> +  "PID_ERR replay-window backtrack occurred [x]" every time the maximum sequence
>    number backtrack seen thus far increases. This can be used to calibrate
>    ``n``.

--
Frank Lichtenheld
Gert Doering June 21, 2022, 12:52 p.m. UTC | #2
Your patch has been applied to the master and release/2.5 branch (same
mismatch between doc + code).

commit 98cbd2914cb728bfaa6ce36a968e944555c57d53 (master)
commit 70897fd139e84a64d6344bf6af28fe0b0b8087d3 (release/2.5)
Author: Martin Jan?
Date:   Fri Jun 10 12:04:05 2022 +0000

     Update the replay-window backtrack log message

     Signed-off-by: Martin Jan? <martin.janu@protonmail.com>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <SVrvuTydxR6Qs_mvwvG7mqT8iLV0inlcCMXoenZTMI8M0LkosV4pZsH9m_XCTwcRWAPN5H8Zdro0ubhJrnSp6v5KC2ZNAL9So0Y2SKiSe7g=@protonmail.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg24472.html
     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 6473ad42..373193aa 100644
--- a/doc/man-sections/link-options.rst
+++ b/doc/man-sections/link-options.rst
@@ -378,7 +378,7 @@  the local and the remote host.
   value for ``n``. Satellite links in particular often require this.

   If you run OpenVPN at ``--verb 4``, you will see the message
-  "Replay-window backtrack occurred [x]" every time the maximum sequence
+  "PID_ERR replay-window backtrack occurred [x]" every time the maximum sequence
   number backtrack seen thus far increases. This can be used to calibrate
   ``n``.