netdev - RE: [PATCH net-next 1/2] net: xilinx: axienet: Fix kernel-doc warning for axienet_free_tx

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID:
 <MN0PR12MB59534339999B93E3C8D25E90B709A@MN0PR12MB5953.namprd12.prod.outlook.com>
Date: Thu, 11 Sep 2025 15:41:06 +0000
From: "Pandey, Radhey Shyam" <radhey.shyam.pandey@....com>
To: "Gupta, Suraj" <Suraj.Gupta2@....com>, "andrew+netdev@...n.ch"
	<andrew+netdev@...n.ch>, "davem@...emloft.net" <davem@...emloft.net>,
	"edumazet@...gle.com" <edumazet@...gle.com>, "kuba@...nel.org"
	<kuba@...nel.org>, "pabeni@...hat.com" <pabeni@...hat.com>, "Simek, Michal"
	<michal.simek@....com>, "sean.anderson@...ux.dev" <sean.anderson@...ux.dev>,
	"horms@...nel.org" <horms@...nel.org>
CC: "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
	"linux-arm-kernel@...ts.infradead.org"
	<linux-arm-kernel@...ts.infradead.org>, "linux-kernel@...r.kernel.org"
	<linux-kernel@...r.kernel.org>, "Katakam, Harini" <harini.katakam@....com>
Subject: RE: [PATCH net-next 1/2] net: xilinx: axienet: Fix kernel-doc warning
 for axienet_free_tx_chain return value

[Public]

> -----Original Message-----
> From: Suraj Gupta <suraj.gupta2@....com>
> Sent: Thursday, September 11, 2025 12:58 PM
> To: andrew+netdev@...n.ch; davem@...emloft.net; edumazet@...gle.com;
> kuba@...nel.org; pabeni@...hat.com; Simek, Michal <michal.simek@....com>;
> sean.anderson@...ux.dev; Pandey, Radhey Shyam
> <radhey.shyam.pandey@....com>; horms@...nel.org
> Cc: netdev@...r.kernel.org; linux-arm-kernel@...ts.infradead.org; linux-
> kernel@...r.kernel.org; Katakam, Harini <harini.katakam@....com>
> Subject: [PATCH net-next 1/2] net: xilinx: axienet: Fix kernel-doc warning for
> axienet_free_tx_chain return value
>
> Add proper "Return:" section in axienet_free_tx_chain() description.
> The return value description was present in the function description but not in the
> standardized format.
> Move the return value description from the main description to a separate "Return:"
> section to follow Linux kernel documentation standards.
>
> Fixes below kernel-doc warning:
> warning: No description found for return value of 'axienet_free_tx_chain'
>
> Signed-off-by: Suraj Gupta <suraj.gupta2@....com>

Reviewed-by: Radhey Shyam Pandey <radhey.shyam.pandey@....com>
Thanks!
> ---
>  drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> index ec6d47dc984a..0cf776153508 100644
> --- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> +++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c
> @@ -773,7 +773,8 @@ static int axienet_device_reset(struct net_device *ndev)
>   *
>   * Would either be called after a successful transmit operation, or after
>   * there was an error when setting up the chain.
> - * Returns the number of packets handled.
> + *
> + * Return: The number of packets handled.
>   */
>  static int axienet_free_tx_chain(struct axienet_local *lp, u32 first_bd,
>                                int nr_bds, bool force, u32 *sizep, int budget)
> --
> 2.25.1