From: Kees Cook <keescook@chromium.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org,
linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org,
mchehab@kernel.org
Subject: Re: [RFC] docs: Define c_paren_attributes for attributes with arguments
Date: Wed, 21 Sep 2022 22:30:26 -0700 [thread overview]
Message-ID: <202209212229.1C07A60456@keescook> (raw)
In-Reply-To: <d1af650a-1e0b-a650-4cda-57fb1d54f1af@gmail.com>
On Fri, Sep 09, 2022 at 02:08:30PM +0900, Akira Yokosawa wrote:
> Hi Kees,
>
> I expected some responses from Jon, but looks like he's been busy
> elsewhere. Let me chime in.
>
> On Fri, 2 Sep 2022 15:35:07 -0700, Kees Cook wrote:
> > 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'
>
> These warnings are from ./scripts/kernel-doc.
> So I think you need to teach the script about "__diagnose_as" so that
> the kernel-doc comment of strncpy() can be converted to reST doc
> which Sphinx can understand.
Ah! Thank you, yeah, I couldn't figure out where it was coming from.
> Past changes in ./scripts/kernel-doc might give you some hints.
Yeah, including changes from me for similar things. How quickly I
forgot! :)
Thanks,
-Kees
--
Kees Cook
next prev parent reply other threads:[~2022-09-22 5:30 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 [this message]
2022-09-21 21:00 ` Jonathan Corbet
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=202209212229.1C07A60456@keescook \
--to=keescook@chromium.org \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).