All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jakub Kicinski <kuba@kernel.org>
To: Matthieu Baerts <matttbe@kernel.org>
Cc: Mat Martineau <martineau@kernel.org>,
	Geliang Tang <geliang@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Paolo Abeni <pabeni@redhat.com>, Simon Horman <horms@kernel.org>,
	Shuah Khan <shuah@kernel.org>,
	netdev@vger.kernel.org, mptcp@lists.linux.dev,
	linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org
Subject: Re: [PATCH net 3/4] mptcp: fix kdoc warnings
Date: Thu, 5 Feb 2026 09:11:38 -0800	[thread overview]
Message-ID: <20260205091138.7b2884b6@kernel.org> (raw)
In-Reply-To: <e630bf98-05df-4809-9f78-d10abfd075d8@kernel.org>

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.

  reply	other threads:[~2026-02-05 17:11 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-04 16:57 [PATCH net 0/4] mptcp: misc fixes for v6.19-rc8 Matthieu Baerts (NGI0)
2026-02-04 16:57 ` [PATCH net 1/4] mptcp: pm: in-kernel: always set ID as avail when rm endp Matthieu Baerts (NGI0)
2026-02-04 16:57 ` [PATCH net 2/4] mptcp: pm: in-kernel: clarify mptcp_pm_remove_anno_addr() Matthieu Baerts (NGI0)
2026-02-04 16:57 ` [PATCH net 3/4] mptcp: fix kdoc warnings Matthieu Baerts (NGI0)
2026-02-04 17:36   ` Randy Dunlap
2026-02-05 10:56   ` Matthieu Baerts
2026-02-05 15:56     ` Jakub Kicinski
2026-02-05 16:42       ` Matthieu Baerts
2026-02-05 17:11         ` Jakub Kicinski [this message]
2026-02-04 16:57 ` [PATCH net 4/4] selftests: mptcp: connect: fix maybe-uninitialize warn Matthieu Baerts (NGI0)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260205091138.7b2884b6@kernel.org \
    --to=kuba@kernel.org \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=geliang@kernel.org \
    --cc=horms@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=martineau@kernel.org \
    --cc=matttbe@kernel.org \
    --cc=mptcp@lists.linux.dev \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=shuah@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.