linux-kernel - Re: [PATCH] kthread: Fix documentation build warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20170724153158.5c5c8bb2@lwn.net>
Date:   Mon, 24 Jul 2017 15:31:58 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Andrew Morton <akpm@...ux-foundation.org>,
        LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] kthread: Fix documentation build warning

On Mon, 24 Jul 2017 14:24:44 -0700
Randy Dunlap <rdunlap@...radead.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