From: Jonathan Corbet <corbet@lwn.net>
To: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
Cc: linux-doc@vger.kernel.org,
"Paul E . McKenney" <paulmck@kernel.org>,
Joel Fernandes <joel@joelfernandes.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] scripts/kernel-doc: Add support for named variable macro arguments
Date: Thu, 7 Nov 2019 11:45:09 -0700 [thread overview]
Message-ID: <20191107114509.16ad9f5c@lwn.net> (raw)
In-Reply-To: <20191107134133.14690-1-j.neuschaefer@gmx.net>
On Thu, 7 Nov 2019 14:41:33 +0100
Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> Currently, when kernel-doc encounters a macro with a named variable
> argument[1], such as this:
>
> #define hlist_for_each_entry_rcu(pos, head, member, cond...)
>
> ... it expects the variable argument to be documented as `cond...`,
> rather than `cond`. This is semantically wrong, because the name (as
> used in the macro body) is actually `cond`.
>
> With this patch, kernel-doc will accept the name without dots (`cond`
> in the example above) in doc comments, and warn if the name with dots
> (`cond...`) is used and verbose mode[2] is enabled.
This is a definite improvement, thanks. Applied.
jon
prev parent reply other threads:[~2019-11-07 18:45 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-07 13:41 Jonathan Neuschäfer
2019-11-07 14:27 ` Paul E. McKenney
2019-11-07 18:45 ` 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=20191107114509.16ad9f5c@lwn.net \
--to=corbet@lwn.net \
--cc=j.neuschaefer@gmx.net \
--cc=joel@joelfernandes.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=paulmck@kernel.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®