diff mbox series

[Openvpn-devel,v1] ssl_pkt: Fix doxygen warning about read_control_auth

Message ID 20260702100704.24692-1-gert@greenie.muc.de
State New
Headers
Series [Openvpn-devel,v1] ssl_pkt: Fix doxygen warning about read_control_auth |

Commit Message

Gert Doering July 2, 2026, 10:06 a.m. UTC 
  From: Frank Lichtenheld <frank@lichtenheld.com>

Commit 01ee1693f960a696a613e7b83f9960002264a379
("Ensure tls-crypt keys are not setup twice") removed
the argument but did not delete it from the doxygen
documentation, leading to warnings.

Change-Id: I20cc89a546b69aceadcd1630828de407d530d7c7
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1765
---

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/+/1765
This mail reflects revision 1 of this Change.

Acked-by according to Gerrit (reflected above):
Gert Doering <gert@greenie.muc.de>

Comments

Gert Doering July 2, 2026, 10:35 a.m. UTC | #1 
Thanks for the cleanup patch.  This should have been caught in the
pre-release run-up, but our CI infrastructure is not very well suited
for "test 6 embargo CVEs in 4 branches across all builders" - so it
*did* complain, but we did not handle it...

"Obviously correct", and the buildbot that tests doxygen is happy too :-)

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

commit d41472de0144f3c483a8397dea3bb55f00dc57e4 (master)
commit b64b1d01c473e67c86b58b83843a04e10ff665ad (release/2.7)
Author: Frank Lichtenheld
Date:   Thu Jul 2 12:06:59 2026 +0200

     ssl_pkt: Fix doxygen warning about read_control_auth

     Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
     Acked-by: Gert Doering <gert@greenie.muc.de>
     Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1765
     Message-Id: <20260702100704.24692-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg37459.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering
diff mbox series

Patch

diff --git a/src/openvpn/ssl_pkt.h b/src/openvpn/ssl_pkt.h
index 640885e..82cb5b1 100644
--- a/src/openvpn/ssl_pkt.h
+++ b/src/openvpn/ssl_pkt.h
@@ -207,7 +207,6 @@ 
  * @param ctx               control channel security context
  * @param from              incoming link socket address
  * @param opt               tls options struct for the session
- * @param initial_packet    whether this is the initial packet for the connection
  * @return                  if the packet was successfully processed
  */
 bool read_control_auth(struct buffer *buf, struct tls_wrap_ctx *ctx,