linux-kernel - Re: [PATCH] scripts/kernel-doc: Add missing close-paren in c:function directives

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: <CAFEAcA8igL7L8D16shd6KoVH8Yvu0SwyxcShKoGFgLmDhnSrNA@mail.gmail.com>
Date:   Thu, 16 Apr 2020 09:55:49 +0100
From:   Peter Maydell <peter.maydell@...aro.org>
To:     Jonathan Corbet <corbet@....net>
Cc:     "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        lkml - Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Paolo Bonzini <pbonzini@...hat.com>
Subject: Re: [PATCH] scripts/kernel-doc: Add missing close-paren in c:function directives

On Wed, 15 Apr 2020 at 22:11, Jonathan Corbet <corbet@....net> wrote:
>
> On Tue, 14 Apr 2020 15:37:43 +0100
> Peter Maydell <peter.maydell@...aro.org> wrote:
> > When kernel-doc generates a 'c:function' directive for a function
> > one of whose arguments is a function pointer, it fails to print
> > the close-paren after the argument list of the function pointer
> > argument. For instance:
> >
> >  long work_on_cpu(int cpu, long (*fn) (void *, void * arg)

> Interesting.  This appears to have affected well over 100 function
> definitions in the docs, and nobody ever noticed.  Good to know we're all
> reading it closely :)

Heh; I think my conclusion is "function signatures for APIs which
don't provide and use a typedef for function-pointer-arguments are
sufficiently hard to read that people don't notice simple errors
in them", but then I prefer the with-typedef style to start with :-)

thanks
-- PMM