linux-wpan.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/
@ 2023-07-14  4:51 Randy Dunlap
  2023-07-14  4:51 ` [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
  2023-07-15  3:50 ` [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ patchwork-bot+netdevbpf
  0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2023-07-14  4:51 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,
	Moshe Shemesh, Jacob Keller, Nikolay Aleksandrov, Benjamin Berg,
	Jiri Benc, Leslie Monis, Mohit P. Tahiliani, Gautam Ramakrishnan,
	Prameela Rani Garnepudi, Siva Rebbagondla, Kalle Valo

Fix many (but not all) kernel-doc warnings in include/net/.

 [PATCH v2 net 1/9] net: bonding: remove kernel-doc comment marker
 [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings
 [PATCH v2 net 3/9] codel: fix kernel-doc notation warnings
 [PATCH v2 net 4/9] devlink: fix kernel-doc notation warnings
 [PATCH v2 net 5/9] inet: frags: remove kernel-doc comment marker
 [PATCH v2 net 6/9] net: llc: fix kernel-doc notation warnings
 [PATCH v2 net 7/9] net: NSH: fix kernel-doc notation warning
 [PATCH v2 net 8/9] pie: fix kernel-doc notation warning
 [PATCH v2 net 9/9] rsi: remove kernel-doc comment marker

v2: drop the wifi/80211 patches, waiting for their reviewers or
    maintainers;
    include/linux/inet_frag.h: keep the kernel-doc comment;

 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: 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: 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: Kalle Valo <kvalo@kernel.org>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings
  2023-07-14  4:51 [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ Randy Dunlap
@ 2023-07-14  4:51 ` Randy Dunlap
  2023-07-15  3:50 ` [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2023-07-14  4:51 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>
Acked-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
v2: add Ack by Miquel;

 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 v2 net 0/9] net: fix kernel-doc problems in include/net/
  2023-07-14  4:51 [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ Randy Dunlap
  2023-07-14  4:51 ` [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
@ 2023-07-15  3:50 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2023-07-15  3:50 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: netdev, davem, edumazet, kuba, pabeni, linux-wireless,
	linux-wpan, j.vosburgh, andy, johannes, mchehab, alex.aring,
	stefan, miquel.raynal, marcel, jhs, xiyou.wangcong, jiri,
	dave.taht, moshe, jacob.e.keller, razor, benjamin.berg, jbenc,
	lesliemonis, tahiliani, gautamramk, prameela.j04cs,
	siva.rebbagondla, kvalo

Hello:

This series was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Thu, 13 Jul 2023 21:51:18 -0700 you wrote:
> Fix many (but not all) kernel-doc warnings in include/net/.
> 
>  [PATCH v2 net 1/9] net: bonding: remove kernel-doc comment marker
>  [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings
>  [PATCH v2 net 3/9] codel: fix kernel-doc notation warnings
>  [PATCH v2 net 4/9] devlink: fix kernel-doc notation warnings
>  [PATCH v2 net 5/9] inet: frags: remove kernel-doc comment marker
>  [PATCH v2 net 6/9] net: llc: fix kernel-doc notation warnings
>  [PATCH v2 net 7/9] net: NSH: fix kernel-doc notation warning
>  [PATCH v2 net 8/9] pie: fix kernel-doc notation warning
>  [PATCH v2 net 9/9] rsi: remove kernel-doc comment marker
> 
> [...]

Here is the summary with links:
  - [v2,net,1/9] net: bonding: remove kernel-doc comment marker
    https://git.kernel.org/netdev/net/c/a66557c79020
  - [v2,net,2/9] net: cfg802154: fix kernel-doc notation warnings
    https://git.kernel.org/netdev/net/c/a63e40444e1b
  - [v2,net,3/9] codel: fix kernel-doc notation warnings
    https://git.kernel.org/netdev/net/c/cfe57122bba5
  - [v2,net,4/9] devlink: fix kernel-doc notation warnings
    https://git.kernel.org/netdev/net/c/839f55c5ebdf
  - [v2,net,5/9] inet: frags: eliminate kernel-doc warning
    https://git.kernel.org/netdev/net/c/d20909a0689f
  - [v2,net,6/9] net: llc: fix kernel-doc notation warnings
    https://git.kernel.org/netdev/net/c/201a08830d8c
  - [v2,net,7/9] net: NSH: fix kernel-doc notation warning
    https://git.kernel.org/netdev/net/c/d1533d726aa1
  - [v2,net,8/9] pie: fix kernel-doc notation warning
    https://git.kernel.org/netdev/net/c/d1cca974548d
  - [v2,net,9/9] rsi: remove kernel-doc comment marker
    https://git.kernel.org/netdev/net/c/04be3c95da82

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-07-15  3:50 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-14  4:51 [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ Randy Dunlap
2023-07-14  4:51 ` [PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
2023-07-15  3:50 ` [PATCH v2 net 0/9] net: fix kernel-doc problems in include/net/ patchwork-bot+netdevbpf

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).