linux-kernel - Re: [PATCH net-next] docs/conf.py: add function attribute '__fix

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: <CADxym3aYgsEUa-nizq7BRsJHLoHxNcJeqjpiQanaGzpxLw9uwA@mail.gmail.com>
Date:   Fri, 26 Aug 2022 23:46:45 +0800
From:   Menglong Dong <menglong8.dong@...il.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     kuba@...nel.org, sfr@...b.auug.org.au, corbet@....net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Menglong Dong <imagedong@...cent.com>
Subject: Re: [PATCH net-next] docs/conf.py: add function attribute
 '__fix_address' to conf.py

On Fri, Aug 26, 2022 at 8:47 PM Bagas Sanjaya <bagasdotme@...il.com> wrote:
>
> On 8/26/22 16:39, Bagas Sanjaya wrote:
> > On Fri, Aug 26, 2022 at 02:19:14PM +0800, menglong8.dong@...il.com wrote:
> >> From: Menglong Dong <imagedong@...cent.com>
> >>
> >> Stephen Rothwell report that the function attribute '__fix_address'
> >> causes a warning when create html docs with the command:
> >>
> >>   make htmldocs
> >>
> >> Therefor, add this attribute to c_id_attributes in Documentation/conf.py
> >> to clean this warning.
> >>
> >> BTW, I'm not able to reproduce this warning (both ubuntu and centos are
> >> tested). I will appreciate it if anyone can have a test for this
> >> commit.
> >>
> > Hi,
> >
> > The patch description can be improved, like:
> > "Stephen Rothwell reported htmldocs warning when merging net-next:
> >
> > Documentation/networking/kapi:26: net/core/skbuff.c:780: WARNING: Error in declarator or parameters
> > Invalid C declaration: Expecting "(" in parameters. [error at 19]
> >   void __fix_address kfree_skb_reason (struct sk_buff *skb, enum skb_drop_reason reason)
> >   -------------------^
> >
> > Add __fix_address keyword to c_id_attributes array in conf.py to fix the
> > warning."
> >
> > So next time when you spot documentation warnings like above, specify the
> > exact warning in the patch description. This will help reviewers what warning
> > the patch is fixing.
> >
> >> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> >> Signed-off-by: Menglong Dong <imagedong@...cent.com>
> >
> > Also, don't forget to add Link tag, like:
> > Link: https://lore.kernel.org/linux-next/20220825154105.534d78ab@canb.auug.org.au/
> >
> > Otherwise, the warning disappeared on my htmldocs build, thanks.
> >
> > Tested-by: Bagas Sanjaya <bagasdotme@...il.com>
> > Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>
> >
>
> Oops, ignore my Reviewed-by above (not LGTM until my comments above
> are addressed).

Thanks for your advice and the testing. I'll send a V2 with your
comments addressed, and with your Reviewed-by and Tested-by
tags.

Menglong Dong

>
> --
> An old man doll... just what I always wanted! - Clara