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] [day] [month] [year] [list]

Message-ID: <20260205091138.7b2884b6@kernel.org>
Date: Thu, 5 Feb 2026 09:11:38 -0800
From: Jakub Kicinski <kuba@...nel.org>
To: Matthieu Baerts <matttbe@...nel.org>
Cc: Mat Martineau <martineau@...nel.org>, Geliang Tang <geliang@...nel.org>,
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet
 <edumazet@...gle.com>, Paolo Abeni <pabeni@...hat.com>, Simon Horman
 <horms@...nel.org>, Shuah Khan <shuah@...nel.org>, 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

On Thu, 5 Feb 2026 17:42:24 +0100 Matthieu Baerts wrote:
> >> 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.  
> >
> > Hm, do we need some clever way to teach the codegen about short
> > descriptions?  
> 
> In my case, there was no "doc" for this enum:
> 
>   https://lore.kernel.org/20260205-mptcp-fix-kdoc-yml-v1-1-9858c4b7baf6@kernel.org
> 
> Adding it fixes the kdoc warning.
> 
> Do you mean that the codegen should add a short description even if
> "doc" is not set?

Ah, ignore me. I thought we did:

 /**
  * $type
  * @member: $member-doc
  * @member: $member-doc
  *
  * $type-doc
  */

But looks like we put the type doc upfront and wrap, so perhaps not
pretty but shouldn't run afoul of kdoc rules.