Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1695113

Re: [PATCH] kthread: Fix documentation build warning

Show all headers | View raw

On 07/24/2017 12:59 PM, Jonathan Corbet wrote:
> The kerneldoc comment for kthread_create() had an incorrect argument name,
> leading to a warning in the docs build.  Correct it, and make one more
> small step toward a warning-free build.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  include/linux/kthread.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/kthread.h b/include/linux/kthread.h
> index 4fec8b775895..82e197eeac91 100644
> --- a/include/linux/kthread.h
> +++ b/include/linux/kthread.h
> @@ -15,7 +15,7 @@ struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
>   * @threadfn: the function to run in the thread
>   * @data: data pointer for @threadfn()
>   * @namefmt: printf-style format string for the thread name
> - * @...: arguments for @namefmt.
> + * @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?

>   * This macro will create a kthread on the current node, leaving it in
>   * the stopped state.  This is just a helper for kthread_create_on_node();
> 


-- 
~Randy

Back to linux.kernel | Previous | Next — Previous in thread | Next 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