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

From: Jonathan Corbet
Date: Tue Jan 30 2024 - 15:31:59 EST


Daniel Vetter <daniel.vetter@xxxxxxxx> writes:

> On Sun, 7 Jan 2024 at 02:24, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> 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@xxxxxxxxxxxxx>
>> Cc: Jonathan Corbet <corbet@xxxxxxx>
>> Cc: linux-doc@xxxxxxxxxxxxxxx
>> ---
>> 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@xxxxxxxx>

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

Thanks,

jon