[PATCH] kernel-doc: document object-like preprocessor macros

Jonathan Corbet corbet at lwn.net
Tue Jan 30 20:18:14 UTC 2024


Daniel Vetter <daniel.vetter at ffwll.ch> writes:

> I had no idea this exists, but Randy pointed out it's been added quite
> a long time ago in cbb4d3e6510b ("scripts/kernel-doc: handle
> object-like macros"). Definitely way before I started to write all the
> drm docs sadly, so there's a few things where I skipped writing
> kernel-doc since I didn't know it was possible.
>
> Fix this asap by documenting the two possible kernel-doc flavours for
> preprocessor definitions.
>
> References: https://lore.kernel.org/dri-devel/dd917333-9ae8-4e76-991d-39b6229ba8ce@infradead.org/
> Cc: Randy Dunlap <rdunlap at infradead.org>
> Cc: Thomas Zimmermann <tzimmermann at suse.de>
> Cc: Maxime Ripard <mripard at kernel.org>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Cc: "Steven Rostedt (Google)" <rostedt at goodmis.org>
> Cc: Jonathan Corbet <corbet at lwn.net>
> Cc: linux-doc at vger.kernel.org
> Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> ---
>  Documentation/doc-guide/kernel-doc.rst | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)

Applied, thanks.

jon


More information about the dri-devel mailing list