linux-kernel - Re: [PATCH v2] doc-guide: kernel-doc: tell about object-like macros

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <875xzabm17.fsf@meer.lwn.net>
Date: Tue, 30 Jan 2024 13:31:48 -0700
From: Jonathan Corbet <corbet@....net>
To: Daniel Vetter <daniel.vetter@...ll.ch>, Randy Dunlap
 <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH v2] doc-guide: kernel-doc: tell about object-like macros

Daniel Vetter <daniel.vetter@...ll.ch> writes:

> On Sun, 7 Jan 2024 at 02:24, Randy Dunlap <rdunlap@...radead.org> wrote:
>>
>> Since 2014 kernel-doc has supported describing object-like macros
>> but it is not documented anywhere. I should have required some
>> documentation for it when I merged the patch. :(
>>
>> There are currently only 3 uses of this (all in DRM headers, in
>> include/drm/*.h).
>>
>> Add object-like macro kernel-doc documentation now so that more may
>> know about it and use it.
>>
>> Fixes: cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> Cc: Jonathan Corbet <corbet@....net>
>> Cc: linux-doc@...r.kernel.org
>> ---
>> v2: Previous attempts to use kernel-doc were for data definitions,
>>     not macros, so remove that comment.
>>     Remove a duplicate word in the patch description.
>>     Add examples.
>
> Randy pointed to this in another thread and also mentioned that
> function-like macros are already documented, so this also has my
>
> Acked-by: Daniel Vetter <daniel.vetter@...ll.ch>

OK, I'm slowly catching up with the world...I've applied this in favor
of Daniel's version.

Thanks,

jon