| Message ID | 20230710230312.31197-4-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | net: fix kernel-doc problems in include/net/ | expand |
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
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.
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(-)