linux-kernel - Re: [PATCH net 3/4] mptcp: fix kdoc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <f2f5c43d-bf6d-4fe9-9062-1f649d5c276b@kernel.org>
Date: Thu, 5 Feb 2026 11:56:39 +0100
From: Matthieu Baerts <matttbe@...nel.org>
To: Mat Martineau <martineau@...nel.org>, Geliang Tang <geliang@...nel.org>,
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>,
 Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
 Simon Horman <horms@...nel.org>, Shuah Khan <shuah@...nel.org>
Cc: netdev@...r.kernel.org, mptcp@...ts.linux.dev,
 linux-kernel@...r.kernel.org, linux-kselftest@...r.kernel.org
Subject: Re: [PATCH net 3/4] mptcp: fix kdoc warnings

Hello,

On 04/02/2026 17:57, Matthieu Baerts (NGI0) wrote:
> The following warnings were visible:
> 
>   $ ./scripts/kernel-doc -Wall -none \
>         net/mptcp/ include/net/mptcp.h include/uapi/linux/mptcp*.h \
>         include/trace/events/mptcp.h
>   Warning: net/mptcp/token.c:108 No description found for return value of 'mptcp_token_new_request'
>   Warning: net/mptcp/token.c:151 No description found for return value of 'mptcp_token_new_connect'
>   Warning: net/mptcp/token.c:246 No description found for return value of 'mptcp_token_get_sock'
>   Warning: net/mptcp/token.c:298 No description found for return value of 'mptcp_token_iter_next'
>   Warning: net/mptcp/protocol.c:4431 No description found for return value of 'mptcp_splice_read'
>   Warning: include/uapi/linux/mptcp_pm.h:13 missing initial short description on line:
>    * enum mptcp_event_type
> 
> Address all of them: either by using the 'Return:' keyword, or by adding
> a missing initial short description.
> 
> The MPTCP CI will soon report issues with kdoc to avoid introducing new
> issues and being flagged by the Netdev CI.
> 
> Reviewed-by: Geliang Tang <geliang@...nel.org>
> Signed-off-by: Matthieu Baerts (NGI0) <matttbe@...nel.org>
> ---
>  include/uapi/linux/mptcp_pm.h |  2 +-
>  net/mptcp/token.c             | 16 +++++++++-------
>  2 files changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/include/uapi/linux/mptcp_pm.h b/include/uapi/linux/mptcp_pm.h
> index c97d060ee90b..fe9863d75350 100644
> --- a/include/uapi/linux/mptcp_pm.h
> +++ b/include/uapi/linux/mptcp_pm.h
> @@ -11,7 +11,7 @@
>  #define MPTCP_PM_VER	1
>  
>  /**
> - * enum mptcp_event_type
> + * enum mptcp_event_type - Netlink MPTCP event types

I forgot that this file was auto-generated from a YAML file.

Sorry for the noise, I will send a v2 also adapting the YAML file.

pw-bot: cr

Cheers,
Matt
-- 
Sponsored by the NGI0 Core fund.