[PATCH] net: xilinx: Fix kernel-doc for axi_mrmac function parameters
Michal Simek
michal.simek at amd.com
Fri Jul 18 10:03:33 CEST 2025
On 7/17/25 06:48, Venkatesh Yadav Abbarapu wrote:
> The kernel-doc comment for the axi_mrmac_recv function was missing
> the colon (':') after the '@packetp' parameter tag.
>
> The kernel-doc comment for the axi_mrmac_free_pkt function was missing
> the colon (':') after the 'length' parameter tag.
>
> This caused a Sparse warnings regarding the 'packetp' and 'length'
> parameters not being described. Fix the formatting to align
> with kernel-doc standards and resolve the warning.
>
> drivers/net/xilinx_axi_mrmac.c:357:
> warning: Function parameter or member 'packetp' not described
> in 'axi_mrmac_recv'
> drivers/net/xilinx_axi_mrmac.c:411:
> warning: Function parameter or member 'length' not described
> in 'axi_mrmac_free_pkt'
>
> Signed-off-by: Venkatesh Yadav Abbarapu <venkatesh.abbarapu at amd.com>
> ---
> drivers/net/xilinx_axi_mrmac.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/net/xilinx_axi_mrmac.c b/drivers/net/xilinx_axi_mrmac.c
> index 555651937f8..56f877c20a6 100644
> --- a/drivers/net/xilinx_axi_mrmac.c
> +++ b/drivers/net/xilinx_axi_mrmac.c
> @@ -346,7 +346,7 @@ static bool isrxready(struct axi_mrmac_priv *priv)
> * axi_mrmac_recv - MRMAC Rx function
> * @dev: udevice structure
> * @flags: flags from network stack
> - * @packetp pointer to received data
> + * @packetp: pointer to received data
> *
> * Return: received data length on success, negative value on errors
> *
> @@ -399,7 +399,7 @@ static int axi_mrmac_recv(struct udevice *dev, int flags, uchar **packetp)
> * axi_mrmac_free_pkt - MRMAC free packet function
> * @dev: udevice structure
> * @packet: receive buffer pointer
> - * @length received data length
> + * @length: received data length
> *
> * Return: 0 on success, negative value on errors
> *
Applied.
M
More information about the U-Boot
mailing list