linux-kernel - Re: [PATCH] kernel-doc: fix declaration type determination

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: <20181018122155.4fe8dc01@lwn.net>
Date:   Thu, 18 Oct 2018 12:21:55 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Kees Cook <keescook@...omium.org>,
        Jani Nikula <jani.nikula@...ux.intel.com>
Subject: Re: [PATCH] kernel-doc: fix declaration type determination

On Wed, 17 Oct 2018 21:07:27 -0700
Randy Dunlap <rdunlap@...radead.org> wrote:

> From: Randy Dunlap <rdunlap@...radead.org>
> 
> Make declaration type determination more robust.
> 
> When scripts/kernel-doc is deciding if some kernel-doc notation
> contains an enum, a struct, a union, a typedef, or a function,
> it does a pattern match on the beginning of the string, looking
> for a match with one of "struct", "union", "enum", or "typedef",
> and otherwise defaults to a function declaration type.
> However, if a function or a function-like macro has a name that
> begins with "struct" (e.g., struct_size()), then kernel-doc
> incorrectly decides that this is a struct declaration.
> 
> Fix this by looking for the declaration type keywords having an
> ending word boundary (\b), so that "struct_size" will not match
> a struct declaration.
> 
> I compared lots of html before/after output from core-api, driver-api,
> and networking.  There were no differences in any of the files that
> I checked.
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>

Applied, thanks.

jon