From: Jonathan Corbet <corbet@lwn.net>
To: Kees Cook <keescook@chromium.org>
Cc: Kees Cook <keescook@chromium.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-hardening@vger.kernel.org
Subject: Re: [RFC] docs: Define c_paren_attributes for attributes with arguments
Date: Wed, 21 Sep 2022 15:00:36 -0600 [thread overview]
Message-ID: <87mtastpcb.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220902223507.2537469-1-keescook@chromium.org>
Kees Cook <keescook@chromium.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
prev parent reply other threads:[~2022-09-21 21:00 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-02 22:35 [RFC] docs: Define c_paren_attributes for attributes with arguments Kees Cook
2022-09-09 5:08 ` Akira Yokosawa
2022-09-22 5:30 ` Kees Cook
2022-09-21 21:00 ` Jonathan Corbet [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mtastpcb.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hardening@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.