linux-kernel - Re: [PATCH v1 1/1] docs: Update documentation to avoid mentioning of kernel.h

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <cf6fa77c-3fe3-4262-96e4-f2cc79d6abb5@infradead.org>
Date: Wed, 26 Nov 2025 13:46:05 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc: "Dr. David Alan Gilbert" <linux@...blig.org>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, workflows@...r.kernel.org,
 linux-remoteproc@...r.kernel.org,
 Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 "Rafael J. Wysocki" <rafael@...nel.org>, Danilo Krummrich <dakr@...nel.org>,
 Jonathan Corbet <corbet@....net>, Dwaipayan Ray <dwaipayanray1@...il.com>,
 Lukas Bulwahn <lukas.bulwahn@...il.com>, Joe Perches <joe@...ches.com>,
 Bjorn Andersson <andersson@...nel.org>,
 Mathieu Poirier <mathieu.poirier@...aro.org>
Subject: Re: [PATCH v1 1/1] docs: Update documentation to avoid mentioning of
 kernel.h



On 11/26/25 1:42 PM, Andy Shevchenko wrote:
> On Wed, Nov 26, 2025 at 01:36:44PM -0800, Randy Dunlap wrote:
>> On 11/26/25 1:33 PM, 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@...radead.org>
>>>>
>>>> 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:
>>>
>>> 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]
>>>
>>
>> This little change fixes it for me. Just include it in your patch, please.
> 
> Thanks, just 15 sec before your message I guessed the same fix.
> 
>> ---
>>  include/linux/util_macros.h |    2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- linux-next-20251126.orig/include/linux/util_macros.h
>> +++ linux-next-20251126/include/linux/util_macros.h
>> @@ -119,7 +119,7 @@
>>   * a fuss about it. This makes the programmer responsible for tagging
>>   * the functions that can be garbage-collected.
>>   *
>> - * With the macro it is possible to write the following:
>> + * With the macro it is possible to write the following::
>>   *
>>   *     static int foo_suspend(struct device *dev)
>>   *     {
> 
> Since it's like this, I just fix both places you pointed out and issue a v2.
> May I have ypour Tested-by ten?

Yes.
Tested-by: Randy Dunlap <rdunlap@...radead.org>

-- 
~Randy