mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Daniel Vetter <daniel.vetter@ffwll.ch>,
	Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH v2] doc-guide: kernel-doc: tell about object-like macros
Date: Tue, 30 Jan 2024 13:31:48 -0700	[thread overview]
Message-ID: <875xzabm17.fsf@meer.lwn.net> (raw)
In-Reply-To: <CAKMK7uGQqH7Y7bnNb=zeKkLyavtoJBpGJxwptBBUSqsYGdFEtA@mail.gmail.com>

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

> On Sun, 7 Jan 2024 at 02:24, Randy Dunlap <rdunlap@infradead.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@infradead.org>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: linux-doc@vger.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@ffwll.ch>

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

Thanks,

jon

      reply	other threads:[~2024-01-30 20:31 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-07  1:24 Randy Dunlap
2024-01-09 15:46 ` Daniel Vetter
2024-01-30 20:31   ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=875xzabm17.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=daniel.vetter@ffwll.ch \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®