Re: [PATCH v1 1/1] docs: Update documentation to avoid mentioning of kernel.h
From: Andy Shevchenko
Date: Wed Nov 26 2025 - 16:37:40 EST
On Wed, Nov 26, 2025 at 01:33:13PM -0800, Randy Dunlap wrote:
> On 11/26/25 1:24 PM, Andy Shevchenko wrote:
> > On Wed, Nov 26, 2025 at 01:18:29PM -0800, Randy Dunlap wrote:
> >> On 11/26/25 12:59 PM, Andy Shevchenko wrote:
...
> >>> -The header file include/linux/kernel.h contains a number of macros that
> >>> +There many header files in include/linux/ that contain a number of macros that
> >>
> >> There are many
> >>
> >>> you should use, rather than explicitly coding some variant of them yourself.
> >>> For example, if you need to calculate the length of an array, take advantage
> >>> of the macro
> >>
> >> Otherwise LGTM. Thanks.
> >>
> >> Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> >
> > Thanks!
> >
> > Can you also test it? I hope it will be not so broken (as some of the files
> > seems never were before in the generated docs).
>
> It's not completely happy:
A-ha, thanks for trying!
> linux-next-20251126/Documentation/driver-api/basics:130: ../include/linux/util_macros.h:125: ERROR: Unexpected indentation. [docutils]
> linux-next-20251126/Documentation/driver-api/basics:130: ../include/linux/util_macros.h:123: WARNING: Inline emphasis start-string without end-string. [docutils]
> linux-next-20251126/Documentation/driver-api/basics:130: ../include/linux/util_macros.h:126: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> linux-next-20251126/Documentation/driver-api/basics:130: ../include/linux/util_macros.h:130: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
I will look at it tomorrow, but can you remove this (or even fix) and check the
rest meanwhile?
--
With Best Regards,
Andy Shevchenko