[PATCH net-next] ovpn: Fix the return value in ovpn_bind_from_sockaddr() kernel-doc

Karl Mehltretter posted 1 patch 1 week, 6 days ago
drivers/net/ovpn/bind.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH net-next] ovpn: Fix the return value in ovpn_bind_from_sockaddr() kernel-doc
Posted by Karl Mehltretter 1 week, 6 days ago
ovpn_bind_from_sockaddr() returns an ERR_PTR() on failure, never NULL,
but its kernel-doc says "NULL otherwise". Say ERR_PTR().

The wrong text came in with commit 80747caef33d ("ovpn: introduce the
ovpn_peer object").

Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 drivers/net/ovpn/bind.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/net/ovpn/bind.c b/drivers/net/ovpn/bind.c
index e42b60cd04a9852c80a0cc478d499821836ab909..62a5ccfd3502a2680b45b0732804eafd47d79a2c 100644
--- a/drivers/net/ovpn/bind.c
+++ b/drivers/net/ovpn/bind.c
@@ -18,7 +18,7 @@
  * ovpn_bind_from_sockaddr - retrieve binding matching sockaddr
  * @ss: the sockaddr to match
  *
- * Return: the bind matching the passed sockaddr if found, NULL otherwise
+ * Return: the new bind for the passed sockaddr, an ERR_PTR() on failure
  */
 struct ovpn_bind *ovpn_bind_from_sockaddr(const struct sockaddr_storage *ss)
 {
-- 
2.39.5 (Apple Git-154)
Re: [PATCH net-next] ovpn: Fix the return value in ovpn_bind_from_sockaddr() kernel-doc
Posted by Antonio Quartulli 1 week, 4 days ago
On Sat, 12 Sep 2026 01:13:52 +0200, Karl Mehltretter wrote:
> ovpn_bind_from_sockaddr() returns an ERR_PTR() on failure, never NULL,
> but its kernel-doc says "NULL otherwise". Say ERR_PTR().
> 
> The wrong text came in with commit 80747caef33d ("ovpn: introduce the
> ovpn_peer object").
> 
> 
> [...]

Applied, thanks!

[1/1] ovpn: Fix the return value in ovpn_bind_from_sockaddr() kernel-doc
      commit: 1087c84dd9554a427f6ca6e350c22688eebd3075

Best regards,
-- 
Antonio Quartulli <antonio@openvpn.net>