| Message ID | 20240221-ps3-gelic-kdoc-v1-1-7629216d1340@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 3e596599372e7823d08c658fde85bfc8bae9ba83 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [net-next] ps3/gelic: minor Kernel Doc corrections | expand |
Hi Simon, On 2/22/24 02:46, Simon Horman wrote: > * Update the Kernel Doc for gelic_descr_set_tx_cmdstat() > and gelic_net_setup_netdev() so that documented name > and the actual name of the function match. > > * Move define of GELIC_ALIGN() so that it is no longer > between gelic_alloc_card_net() and it's Kernel Doc. > > * Document netdev parameter of gelic_alloc_card_net() > in a way consistent to the documentation of other netdev parameters > in this file. > > Addresses the following warnings flagged by ./scripts/kernel-doc -none: > > .../ps3_gelic_net.c:711: warning: expecting prototype for gelic_net_set_txdescr_cmdstat(). Prototype was for gelic_descr_set_tx_cmdstat() instead > .../ps3_gelic_net.c:1474: warning: expecting prototype for gelic_ether_setup_netdev(). Prototype was for gelic_net_setup_netdev() instead > .../ps3_gelic_net.c:1528: warning: expecting prototype for gelic_alloc_card_net(). Prototype was for GELIC_ALIGN() instead > .../ps3_gelic_net.c:1531: warning: Function parameter or struct member 'netdev' not described in 'gelic_alloc_card_net' > > Signed-off-by: Simon Horman <horms@kernel.org> > --- > drivers/net/ethernet/toshiba/ps3_gelic_net.c | 8 +++++--- > 1 file changed, 5 insertions(+), 3 deletions(-) > > diff --git a/drivers/net/ethernet/toshiba/ps3_gelic_net.c b/drivers/net/ethernet/toshiba/ps3_gelic_net.c > index d5b75af163d3..12b96ca66877 100644 > --- a/drivers/net/ethernet/toshiba/ps3_gelic_net.c > +++ b/drivers/net/ethernet/toshiba/ps3_gelic_net.c > @@ -698,7 +698,7 @@ gelic_card_get_next_tx_descr(struct gelic_card *card) > } > > /** > - * gelic_net_set_txdescr_cmdstat - sets the tx descriptor command field > + * gelic_descr_set_tx_cmdstat - sets the tx descriptor command field > * @descr: descriptor structure to fill out > * @skb: packet to consider > * > @@ -1461,7 +1461,7 @@ static void gelic_ether_setup_netdev_ops(struct net_device *netdev, > } > > /** > - * gelic_ether_setup_netdev - initialization of net_device > + * gelic_net_setup_netdev - initialization of net_device > * @netdev: net_device structure > * @card: card structure > * > @@ -1518,14 +1518,16 @@ int gelic_net_setup_netdev(struct net_device *netdev, struct gelic_card *card) > return 0; > } > > +#define GELIC_ALIGN (32) > + > /** > * gelic_alloc_card_net - allocates net_device and card structure > + * @netdev: interface device structure > * > * returns the card structure or NULL in case of errors > * > * the card and net_device structures are linked to each other > */ > -#define GELIC_ALIGN (32) > static struct gelic_card *gelic_alloc_card_net(struct net_device **netdev) > { > struct gelic_card *card; > Looks good. Thanks for taking care of it. Acked-by: Geoff Levand <geoff@infradead.org>
Hello: This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <kuba@kernel.org>: On Wed, 21 Feb 2024 17:46:21 +0000 you wrote: > * Update the Kernel Doc for gelic_descr_set_tx_cmdstat() > and gelic_net_setup_netdev() so that documented name > and the actual name of the function match. > > * Move define of GELIC_ALIGN() so that it is no longer > between gelic_alloc_card_net() and it's Kernel Doc. > > [...] Here is the summary with links: - [net-next] ps3/gelic: minor Kernel Doc corrections https://git.kernel.org/netdev/net-next/c/3e596599372e You are awesome, thank you!
diff --git a/drivers/net/ethernet/toshiba/ps3_gelic_net.c b/drivers/net/ethernet/toshiba/ps3_gelic_net.c index d5b75af163d3..12b96ca66877 100644 --- a/drivers/net/ethernet/toshiba/ps3_gelic_net.c +++ b/drivers/net/ethernet/toshiba/ps3_gelic_net.c @@ -698,7 +698,7 @@ gelic_card_get_next_tx_descr(struct gelic_card *card) } /** - * gelic_net_set_txdescr_cmdstat - sets the tx descriptor command field + * gelic_descr_set_tx_cmdstat - sets the tx descriptor command field * @descr: descriptor structure to fill out * @skb: packet to consider * @@ -1461,7 +1461,7 @@ static void gelic_ether_setup_netdev_ops(struct net_device *netdev, } /** - * gelic_ether_setup_netdev - initialization of net_device + * gelic_net_setup_netdev - initialization of net_device * @netdev: net_device structure * @card: card structure * @@ -1518,14 +1518,16 @@ int gelic_net_setup_netdev(struct net_device *netdev, struct gelic_card *card) return 0; } +#define GELIC_ALIGN (32) + /** * gelic_alloc_card_net - allocates net_device and card structure + * @netdev: interface device structure * * returns the card structure or NULL in case of errors * * the card and net_device structures are linked to each other */ -#define GELIC_ALIGN (32) static struct gelic_card *gelic_alloc_card_net(struct net_device **netdev) { struct gelic_card *card;
* Update the Kernel Doc for gelic_descr_set_tx_cmdstat() and gelic_net_setup_netdev() so that documented name and the actual name of the function match. * Move define of GELIC_ALIGN() so that it is no longer between gelic_alloc_card_net() and it's Kernel Doc. * Document netdev parameter of gelic_alloc_card_net() in a way consistent to the documentation of other netdev parameters in this file. Addresses the following warnings flagged by ./scripts/kernel-doc -none: .../ps3_gelic_net.c:711: warning: expecting prototype for gelic_net_set_txdescr_cmdstat(). Prototype was for gelic_descr_set_tx_cmdstat() instead .../ps3_gelic_net.c:1474: warning: expecting prototype for gelic_ether_setup_netdev(). Prototype was for gelic_net_setup_netdev() instead .../ps3_gelic_net.c:1528: warning: expecting prototype for gelic_alloc_card_net(). Prototype was for GELIC_ALIGN() instead .../ps3_gelic_net.c:1531: warning: Function parameter or struct member 'netdev' not described in 'gelic_alloc_card_net' Signed-off-by: Simon Horman <horms@kernel.org> --- drivers/net/ethernet/toshiba/ps3_gelic_net.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)