* [PATCH net 00/12] net: fix kernel-doc problems in include/net/
@ 2023-07-10 23:03 Randy Dunlap
2023-07-10 23:03 ` [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2023-07-10 23:03 UTC (permalink / raw)
To: netdev
Cc: Randy Dunlap, David S. Miller, Eric Dumazet, Jakub Kicinski,
Paolo Abeni, linux-wireless, linux-wpan, Jay Vosburgh,
Andy Gospodarek, Johannes Berg, Mauro Carvalho Chehab,
Alexander Aring, Stefan Schmidt, Miquel Raynal, Marcel Holtmann,
Jamal Hadi Salim, Cong Wang, Jiri Pirko, Dave Taht,
Arkadi Sharshevsky, Moshe Shemesh, Jacob Keller,
Nikolay Aleksandrov, Benjamin Berg, Yi Yang, Jiri Benc,
Leslie Monis, Mohit P. Tahiliani, Gautam Ramakrishnan,
Prameela Rani Garnepudi, Siva Rebbagondla, Amitkumar Karwar,
Kalle Valo
Fix many (but not all) kernel-doc warnings in include/net/.
[PATCH net 01/12] net: bonding: remove kernel-doc comment marker
[PATCH net 02/12] wifi: cfg80211: remove dead/unused enum value
[PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings
[PATCH net 04/12] codel: fix kernel-doc notation warnings
[PATCH net 05/12] devlink: fix kernel-doc notation warnings
[PATCH net 06/12] wifi: radiotap: fix kernel-doc notation warnings
[PATCH net 07/12] inet: frags: remove kernel-doc comment marker
[PATCH net 08/12] net: llc: fix kernel-doc notation warnings
[PATCH net 09/12] wifi: mac80211: fix kernel-doc notation warning
[PATCH net 10/12] net: NSH: fix kernel-doc notation warning
[PATCH net 11/12] pie: fix kernel-doc notation warning
[PATCH net 12/12] rsi: remove kernel-doc comment marker
include/net/bonding.h | 2 +-
include/net/cfg80211.h | 1 -
include/net/cfg802154.h | 3 ++-
include/net/codel.h | 4 ++--
include/net/devlink.h | 28 ++++++++++++++++------------
include/net/ieee80211_radiotap.h | 3 ++-
include/net/inet_frag.h | 2 +-
include/net/llc_pdu.h | 6 ++++--
include/net/mac80211.h | 1 +
include/net/nsh.h | 2 +-
include/net/pie.h | 2 +-
include/net/rsi_91x.h | 2 +-
12 files changed, 32 insertions(+), 24 deletions(-)
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: linux-wireless@vger.kernel.org
Cc: linux-wpan@vger.kernel.org
Cc: Jay Vosburgh <j.vosburgh@gmail.com>
Cc: Andy Gospodarek <andy@greyhouse.net>
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Alexander Aring <alex.aring@gmail.com>
Cc: Stefan Schmidt <stefan@datenfreihafen.org>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Marcel Holtmann <marcel@holtmann.org>
Cc: Jamal Hadi Salim <jhs@mojatatu.com>
Cc: Cong Wang <xiyou.wangcong@gmail.com>
Cc: Jiri Pirko <jiri@resnulli.us>
Cc: Dave Taht <dave.taht@bufferbloat.net>
Cc: Arkadi Sharshevsky <arkadis@mellanox.com>
Cc: Moshe Shemesh <moshe@mellanox.com>
Cc: Jacob Keller <jacob.e.keller@intel.com>
Cc: Nikolay Aleksandrov <razor@blackwall.org>
Cc: Benjamin Berg <benjamin.berg@intel.com>
Cc: Yi Yang <yi.y.yang@intel.com>
Cc: Jiri Benc <jbenc@redhat.com>
Cc: Leslie Monis <lesliemonis@gmail.com>
Cc: "Mohit P. Tahiliani" <tahiliani@nitk.edu.in>
Cc: Gautam Ramakrishnan <gautamramk@gmail.com>
Cc: Prameela Rani Garnepudi <prameela.j04cs@gmail.com>
Cc: Siva Rebbagondla <siva.rebbagondla@redpinesignals.com>
Cc: Amitkumar Karwar <amit.karwar@redpinesignals.com>
Cc: Kalle Valo <kvalo@kernel.org>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings
2023-07-10 23:03 [PATCH net 00/12] net: fix kernel-doc problems in include/net/ Randy Dunlap
@ 2023-07-10 23:03 ` Randy Dunlap
2023-07-11 8:36 ` Miquel Raynal
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2023-07-10 23:03 UTC (permalink / raw)
To: netdev
Cc: Randy Dunlap, David S. Miller, Eric Dumazet, Jakub Kicinski,
Paolo Abeni, Alexander Aring, Stefan Schmidt, Miquel Raynal,
linux-wpan, Marcel Holtmann
Add an enum heading to the kernel-doc comments to prevent
kernel-doc warnings.
cfg802154.h:174: warning: Cannot understand * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
on line 174 - I thought it was a doc line
cfg802154.h:192: warning: Enum value 'WPAN_PHY_FLAG_TXPOWER' not described in enum 'wpan_phy_flags'
cfg802154.h:192: warning: Excess enum value 'WPAN_PHY_FLAG_TRANSMIT_POWER' description in 'wpan_phy_flags'
Fixes: edea8f7c75ec ("cfg802154: introduce wpan phy flags")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: Alexander Aring <alex.aring@gmail.com>
Cc: Stefan Schmidt <stefan@datenfreihafen.org>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: linux-wpan@vger.kernel.org
Cc: Marcel Holtmann <marcel@holtmann.org>
---
include/net/cfg802154.h | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff -- a/include/net/cfg802154.h b/include/net/cfg802154.h
--- a/include/net/cfg802154.h
+++ b/include/net/cfg802154.h
@@ -170,7 +170,8 @@ wpan_phy_cca_cmp(const struct wpan_phy_c
}
/**
- * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
+ * enum wpan_phy_flags - WPAN PHY state flags
+ * @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support
* transmit power setting.
* @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
* level setting.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings
2023-07-10 23:03 ` [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
@ 2023-07-11 8:36 ` Miquel Raynal
0 siblings, 0 replies; 3+ messages in thread
From: Miquel Raynal @ 2023-07-11 8:36 UTC (permalink / raw)
To: Randy Dunlap
Cc: netdev, David S. Miller, Eric Dumazet, Jakub Kicinski,
Paolo Abeni, Alexander Aring, Stefan Schmidt, linux-wpan,
Marcel Holtmann
Hello,
rdunlap@infradead.org wrote on Mon, 10 Jul 2023 16:03:03 -0700:
> Add an enum heading to the kernel-doc comments to prevent
> kernel-doc warnings.
>
> cfg802154.h:174: warning: Cannot understand * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
> on line 174 - I thought it was a doc line
>
> cfg802154.h:192: warning: Enum value 'WPAN_PHY_FLAG_TXPOWER' not described in enum 'wpan_phy_flags'
> cfg802154.h:192: warning: Excess enum value 'WPAN_PHY_FLAG_TRANSMIT_POWER' description in 'wpan_phy_flags'
>
> Fixes: edea8f7c75ec ("cfg802154: introduce wpan phy flags")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Eric Dumazet <edumazet@google.com>
> Cc: Jakub Kicinski <kuba@kernel.org>
> Cc: Paolo Abeni <pabeni@redhat.com>
> Cc: Alexander Aring <alex.aring@gmail.com>
> Cc: Stefan Schmidt <stefan@datenfreihafen.org>
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: linux-wpan@vger.kernel.org
> Cc: Marcel Holtmann <marcel@holtmann.org>
I believe the whole series is subject to be taken directly by the net
maintainers, so:
Acked-by: Miquel Raynal <miquel.raynal@bootlin.com>
Please let me know if I should instead consider this patch for the wpan
tree.
Thanks,
Miquèl
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-07-11 8:36 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-10 23:03 [PATCH net 00/12] net: fix kernel-doc problems in include/net/ Randy Dunlap
2023-07-10 23:03 ` [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
2023-07-11 8:36 ` Miquel Raynal
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).