linux-kernel - Re: linux-next: build warning after merge of the hmm tree

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: <12156012-e009-4dca-afe0-5b0f17afa10c@amd.com>
Date: Tue, 18 Mar 2025 09:38:16 -0700
From: "Nelson, Shannon" <shannon.nelson@....com>
To: Jason Gunthorpe <jgg@...dia.com>, Stephen Rothwell <sfr@...b.auug.org.au>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Next Mailing List <linux-next@...r.kernel.org>
Subject: Re: linux-next: build warning after merge of the hmm tree

On 3/18/2025 4:09 AM, Jason Gunthorpe wrote:
> 
> 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

Funny, I was just doing that last evening.
Thanks, I'll be updating my patchset soon.

sln