public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jason Gunthorpe <jgg@nvidia.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>,
	Shannon Nelson <shannon.nelson@amd.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the hmm tree
Date: Tue, 18 Mar 2025 08:09:00 -0300	[thread overview]
Message-ID: <20250318110900.GB9311@nvidia.com> (raw)
In-Reply-To: <20250318213906.6e81f517@canb.auug.org.au>

On Tue, Mar 18, 2025 at 09:39:06PM +1100, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the hmm tree, today's linux-next build (htmldocs) produced
> this warning:
> 
> include/uapi/fwctl/pds.h:1: warning: no structured comments found
> 
> Introduced by commit
> 
>   16384467ec8f ("pds_fwctl: add Documentation entries")

Thanks Stephen,

Shannon, this is the same issue CXL had, do not include C header files
from the RST side if they do not have any kdoc comments.

Documentation/userspace-api/fwctl/fwctl.rst:.. kernel-doc:: include/uapi/fwctl/pds.h
Documentation/userspace-api/fwctl/pds_fwctl.rst:.. kernel-doc:: include/uapi/fwctl/pds.h

It looks like in this case you should probably add kdoc comments to
pds.h

Jason

  reply	other threads:[~2025-03-18 11:09 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-18 10:39 linux-next: build warning after merge of the hmm tree Stephen Rothwell
2025-03-18 11:09 ` Jason Gunthorpe [this message]
2025-03-18 16:38   ` Nelson, Shannon
  -- strict thread matches above, loose matches on Subject: below --
2025-03-07  9:31 Stephen Rothwell
2025-03-07  9:13 Stephen Rothwell
2025-03-07  8:57 Stephen Rothwell
2025-03-07  9:28 ` Stephen Rothwell
2025-03-07 15:04 ` Jason Gunthorpe
2025-03-07 20:47   ` Dave Jiang
2025-03-07 23:25     ` Jason Gunthorpe

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=20250318110900.GB9311@nvidia.com \
    --to=jgg@nvidia.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    --cc=shannon.nelson@amd.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox