Messages in this thread | | | Date | Wed, 21 Sep 2022 22:30:26 -0700 | From | Kees Cook <> | Subject | Re: [RFC] docs: Define c_paren_attributes for attributes with arguments |
| |
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
| |