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

Nelson, Shannon
2025-03-18T16:38:22Z

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