linux-kernel - Re: [PATCH] scripts/kernel-doc: Add support for named variable macro arguments

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: <20191107114509.16ad9f5c@lwn.net>
Date:   Thu, 7 Nov 2019 11:45:09 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Jonathan Neuschäfer <j.neuschaefer@....net>
Cc:     linux-doc@...r.kernel.org,
        "Paul E . McKenney" <paulmck@...nel.org>,
        Joel Fernandes <joel@...lfernandes.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] scripts/kernel-doc: Add support for named variable
 macro arguments

On Thu,  7 Nov 2019 14:41:33 +0100
Jonathan Neuschäfer <j.neuschaefer@....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