From: Akira Yokosawa <akiyks@gmail.com>
To: Jakub Kicinski <kuba@kernel.org>,
Johannes Berg <johannes@sipsolutions.net>
Cc: linux-doc@vger.kernel.org, linux-wireless@vger.kernel.org,
netdev@vger.kernel.org
Subject: Re: doc warnings in *80211
Date: Wed, 5 Oct 2022 07:23:57 +0900 [thread overview]
Message-ID: <57f68fef-8a45-184d-4536-52b94fcc9c03@gmail.com> (raw)
In-Reply-To: <20221004072646.64ad2c8c@kernel.org>
Hi,
On Date: Tue, 4 Oct 2022 07:26:46 -0700, Jakub Kicinski wrote:
> On Tue, 04 Oct 2022 09:51:07 +0200 Johannes Berg wrote:
>> > doing basic sanity checks before submitting the net-next PR I spotted
>> > that we have these warnings when building documentation on net-next:
>> >
>> > Documentation/driver-api/80211/cfg80211:48: ./include/net/cfg80211.h:6960: WARNING: Duplicate C declaration, also defined at driver-api/80211/cfg80211:6924.
>> > Declaration is '.. c:function:: void cfg80211_rx_assoc_resp (struct net_device *dev, struct cfg80211_rx_assoc_resp *data)'.
>>
>> Hmm. That's interesting. I guess it cannot distinguish between the type
>> of identifier?
>>
>> struct cfg80211_rx_assoc_resp vs. cfg80211_rx_assoc_resp()
>>
>> Not sure what do about it - rename one of them?
>>
>> > Documentation/driver-api/80211/mac80211:109: ./include/net/mac80211.h:5046: WARNING: Duplicate C declaration, also defined at driver-api/80211/mac80211:1065.
>> > Declaration is '.. c:function:: void ieee80211_tx_status (struct ieee80211_hw *hw, struct sk_buff *skb)'.
>>
>> Same here actually!
>>
>> I don't think either of these is new.
>
> Thanks for checking!
>
> Adding linux-doc, but I presume Jon & co are aware if this is not new.
Yes, this is a known issue of Sphinx >=3.0, which prevents us to
bump required version of Sphinx from 2.4.x.
Link to a relevant mail from Mauro in the lore archive:
https://lore.kernel.org/r/20220702122311.358c0219@sal.lan/
Note that the same warnings can be seen when a kernel-doc comment is
included from multiple .rst files under Documentation/ by accident.
Actually, Sphinx < 3.0 can not detect such true duplicates.
As far as I see, this issue still remains in the latest version of
Sphinx (5.2.3).
HTH,
Akira
prev parent reply other threads:[~2022-10-04 22:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20221003191128.68bfc844@kernel.org>
[not found] ` <62b8bf6f739d1e6e0320864ed0660c9c52b767c4.camel@sipsolutions.net>
2022-10-04 14:26 ` doc warnings in *80211 Jakub Kicinski
2022-10-04 22:23 ` Akira Yokosawa [this message]
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=57f68fef-8a45-184d-4536-52b94fcc9c03@gmail.com \
--to=akiyks@gmail.com \
--cc=johannes@sipsolutions.net \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=netdev@vger.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).