[PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[menglong8.dong]

From: Menglong Dong <imagedong@tencent.com>

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.

Link: https://lore.kernel.org/linux-next/20220825154105.534d78ab@canb.auug.org.au/
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Menglong Dong <imagedong@tencent.com>
Tested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
v2:
- optimize the commit log, as Bagas Sanjaya suggested.
---
 Documentation/conf.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index 934727e23e0e..255384d094bf 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -86,6 +86,7 @@ if major >= 3:
             "__used",
             "__weak",
             "noinline",
+            "__fix_address",
 
             # include/linux/memblock.h:
             "__init_memblock",
-- 
2.37.2

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jakub Kicinski]

On Sat, 27 Aug 2022 00:01:50 +0800 menglong8.dong@gmail.com wrote:
> From: Menglong Dong <imagedong@tencent.com>
> 
> 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.

You'll need to CC netdev@ for the patch to get into the net-next tree.
Since this is a pure Documentation/ patch get_maintainer.pl did not
produce netdev@ in the recommended addresses.

Please wait for a review/ack from Jon before reposting, we need his
permission to apply this patch.

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jonathan Corbet]

Jakub Kicinski <kuba@kernel.org> writes:

> On Sat, 27 Aug 2022 00:01:50 +0800 menglong8.dong@gmail.com wrote:
>> From: Menglong Dong <imagedong@tencent.com>
>> 
>> 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.
>
> You'll need to CC netdev@ for the patch to get into the net-next tree.
> Since this is a pure Documentation/ patch get_maintainer.pl did not
> produce netdev@ in the recommended addresses.
>
> Please wait for a review/ack from Jon before reposting, we need his
> permission to apply this patch.

I could also just carry it through docs; I'm about to send a set of
fixes Linusward in any case.  I wanted to run a couple of tests to be
sure, but I don't expect any problems with it...

Thanks,

jon

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jonathan Corbet]

Jonathan Corbet <corbet@lwn.net> writes:

> Jakub Kicinski <kuba@kernel.org> writes:
>
>> On Sat, 27 Aug 2022 00:01:50 +0800 menglong8.dong@gmail.com wrote:
>>> From: Menglong Dong <imagedong@tencent.com>
>>> 
>>> 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.
>>
>> You'll need to CC netdev@ for the patch to get into the net-next tree.
>> Since this is a pure Documentation/ patch get_maintainer.pl did not
>> produce netdev@ in the recommended addresses.
>>
>> Please wait for a review/ack from Jon before reposting, we need his
>> permission to apply this patch.
>
> I could also just carry it through docs; I'm about to send a set of
> fixes Linusward in any case.  I wanted to run a couple of tests to be
> sure, but I don't expect any problems with it...

The patch is clearly correct, it can go in via whatever path seems most
suitable.  Let me know if you'd like me to push it; otherwise:

Acked-by: Jonathan Corbet <corbet@lwn.net>

Thanks,

jon

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jakub Kicinski]

On Fri, 26 Aug 2022 16:14:45 -0600 Jonathan Corbet wrote:
> Jonathan Corbet <corbet@lwn.net> writes:
> >> You'll need to CC netdev@ for the patch to get into the net-next tree.
> >> Since this is a pure Documentation/ patch get_maintainer.pl did not
> >> produce netdev@ in the recommended addresses.
> >>
> >> Please wait for a review/ack from Jon before reposting, we need his
> >> permission to apply this patch.  
> >
> > I could also just carry it through docs; I'm about to send a set of
> > fixes Linusward in any case.  I wanted to run a couple of tests to be
> > sure, but I don't expect any problems with it...  
> 
> The patch is clearly correct, it can go in via whatever path seems most
> suitable.  Let me know if you'd like me to push it; otherwise:
> 
> Acked-by: Jonathan Corbet <corbet@lwn.net>

Oh, if it can make it to Linus via the doc tree before the 6.1 merge
window that's even better!

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jonathan Corbet]

Jakub Kicinski <kuba@kernel.org> writes:

> On Fri, 26 Aug 2022 16:14:45 -0600 Jonathan Corbet wrote:
>> Jonathan Corbet <corbet@lwn.net> writes:
>> >> You'll need to CC netdev@ for the patch to get into the net-next tree.
>> >> Since this is a pure Documentation/ patch get_maintainer.pl did not
>> >> produce netdev@ in the recommended addresses.
>> >>
>> >> Please wait for a review/ack from Jon before reposting, we need his
>> >> permission to apply this patch.  
>> >
>> > I could also just carry it through docs; I'm about to send a set of
>> > fixes Linusward in any case.  I wanted to run a couple of tests to be
>> > sure, but I don't expect any problems with it...  
>> 
>> The patch is clearly correct, it can go in via whatever path seems most
>> suitable.  Let me know if you'd like me to push it; otherwise:
>> 
>> Acked-by: Jonathan Corbet <corbet@lwn.net>
>
> Oh, if it can make it to Linus via the doc tree before the 6.1 merge
> window that's even better!

OK, I'll apply it and ship it, probably next week.

Thanks,

jon

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Menglong Dong]

On Sat, Aug 27, 2022 at 6:43 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> Jakub Kicinski <kuba@kernel.org> writes:
>
> > On Fri, 26 Aug 2022 16:14:45 -0600 Jonathan Corbet wrote:
> >> Jonathan Corbet <corbet@lwn.net> writes:
> >> >> You'll need to CC netdev@ for the patch to get into the net-next tree.
> >> >> Since this is a pure Documentation/ patch get_maintainer.pl did not
> >> >> produce netdev@ in the recommended addresses.
> >> >>
> >> >> Please wait for a review/ack from Jon before reposting, we need his
> >> >> permission to apply this patch.
> >> >
> >> > I could also just carry it through docs; I'm about to send a set of
> >> > fixes Linusward in any case.  I wanted to run a couple of tests to be
> >> > sure, but I don't expect any problems with it...
> >>
> >> The patch is clearly correct, it can go in via whatever path seems most
> >> suitable.  Let me know if you'd like me to push it; otherwise:
> >>
> >> Acked-by: Jonathan Corbet <corbet@lwn.net>
> >
> > Oh, if it can make it to Linus via the doc tree before the 6.1 merge
> > window that's even better!
>

Thanks to both of you! Seems I don't need to repost this patch
with netdev@ CCed?

Menglong Dong

> OK, I'll apply it and ship it, probably next week.
>
> Thanks,
>
> jon

Re: [PATCH net-next v2] docs/conf.py: add function attribute '__fix_address' to conf.py

[Jonathan Corbet]

Menglong Dong <menglong8.dong@gmail.com> writes:

> Thanks to both of you! Seems I don't need to repost this patch
> with netdev@ CCed?

No need, it's all taken care of.

Thanks,

jon