Re: [PATCH] kthread: Fix documentation build warning

From	Jonathan Corbet <corbet@lwn.net>
Newsgroups	linux.kernel
Subject	Re: [PATCH] kthread: Fix documentation build warning
Date	2017-07-24 23:40 +0200
Message-ID	<u6Tf5-2bs-35@gated-at.bofh.it> (permalink)
References	<u6RGi-12s-25@gated-at.bofh.it> <u6T5o-25X-11@gated-at.bofh.it>
Organization	LWN.net

Show all headers | View raw

On Mon, 24 Jul 2017 14:24:44 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> > + * @arg...: arguments for @namefmt.
> >   *  
> 
> Hm, Documentation/doc-guide/kernel-doc.rst says:
> If a function parameter is ``...`` (varargs), it should be listed
> in kernel-doc notation as: ``@...:``.
> 
> but the patch here is for a macro, not a function.
> Does that make a difference?

Macros are a little different.  I've tried a couple of times to figure out
and rationalize the "..." handling, should maybe do so again.  Meanwhile,
this makes the warning go away, enough for one day :)

Thanks,

jon

Back to linux.kernel | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

[PATCH] kthread: Fix documentation build warning Jonathan Corbet <corbet@lwn.net> - 2017-07-24 22:00 +0200
  Re: [PATCH] kthread: Fix documentation build warning Randy Dunlap <rdunlap@infradead.org> - 2017-07-24 23:30 +0200
    Re: [PATCH] kthread: Fix documentation build warning Jonathan Corbet <corbet@lwn.net> - 2017-07-24 23:40 +0200

csiph-web