linux-kernel - Re: [RFC] docs: Define c_paren_attributes for attributes with 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] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 21 Sep 2022 15:00:36 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Kees Cook <keescook@...omium.org>
Cc:     Kees Cook <keescook@...omium.org>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-hardening@...r.kernel.org
Subject: Re: [RFC] docs: Define c_paren_attributes for attributes with
 arguments

Kees Cook <keescook@...omium.org> writes:

> While Sphinx's "c_id_attributes" is needed for basic attributes, any
> attributes with arguments need to be defined in "c_paren_attributes"
> to avoid errors like:
>
> include/linux/fortify-string.h:116: warning: Function parameter or member '__builtin_strncpy' not described in '__diagnose_as'
> include/linux/fortify-string.h:116: warning: Function parameter or member '1' not described in '__diagnose_as'
> include/linux/fortify-string.h:116: warning: Function parameter or member '2' not described in '__diagnose_as'
> include/linux/fortify-string.h:116: warning: Function parameter or member '3' not described in '__diagnose_as'
>
> Move such attributes to "c_paren_attributes" and add __alloc_size
> and __diagnose_as to the list.

So which tree are those warnings coming from?  I can't reproduce them
with linux-next.

As Akira noted, the kernel-doc script is the source of those warnings,
so changing the Sphinx configuration is unlikely to help.  I think we
just need to teach kernel-doc to ignore those attributes.

Thanks,

jon