From: Bagas Sanjaya <bagasdotme@gmail.com>
To: menglong8.dong@gmail.com
Cc: kuba@kernel.org, sfr@canb.auug.org.au, corbet@lwn.net,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Menglong Dong <imagedong@tencent.com>
Subject: Re: [PATCH net-next] docs/conf.py: add function attribute '__fix_address' to conf.py
Date: Fri, 26 Aug 2022 16:39:44 +0700 [thread overview]
Message-ID: <YwiU4DPEPryi1cMZ@debian.me> (raw)
In-Reply-To: <20220826061914.816239-1-imagedong@tencent.com>
[-- Attachment #1: Type: text/plain, Size: 1693 bytes --]
On Fri, Aug 26, 2022 at 02:19:14PM +0800, menglong8.dong@gmail.com wrote:
> From: Menglong Dong <imagedong@tencent.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@canb.auug.org.au>
> Signed-off-by: Menglong Dong <imagedong@tencent.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@gmail.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2022-08-26 9:40 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-26 6:19 [PATCH net-next] docs/conf.py: add function attribute '__fix_address' to conf.py menglong8.dong
2022-08-26 9:39 ` Bagas Sanjaya [this message]
2022-08-26 12:47 ` Bagas Sanjaya
2022-08-26 15:46 ` Menglong Dong
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=YwiU4DPEPryi1cMZ@debian.me \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=imagedong@tencent.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=menglong8.dong@gmail.com \
--cc=sfr@canb.auug.org.au \
/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).