linux-kernel - Re: [PATCH net-next RESEND] net: axienet: Fix kernel doc warnings

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: <70fdb9ac-f532-49fc-9966-a0dab0ced56b@lunn.ch>
Date: Tue, 26 Mar 2024 14:42:03 +0100
From: Andrew Lunn <andrew@...n.ch>
To: Suraj Gupta <suraj.gupta2@....com>
Cc: radhey.shyam.pandey@....com, davem@...emloft.net, edumazet@...gle.com,
	kuba@...nel.org, pabeni@...hat.com, michal.simek@....com,
	netdev@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
	linux-kernel@...r.kernel.org, git@....com, harini.katakam@....com
Subject: Re: [PATCH net-next RESEND] net: axienet: Fix kernel doc warnings

On Tue, Mar 26, 2024 at 11:23:47AM +0530, Suraj Gupta wrote:
> Add description of mdio enable, mdio disable and mdio wait functions.
> Add description of skb pointer in axidma_bd data structure.
> Remove 'phy_node' description in axienet local data structure since
> it is not a valid struct member.
> Correct description of struct axienet_option.
> 
> Fix below kernel-doc warnings in drivers/net/ethernet/xilinx/:
> 1) xilinx_axienet_mdio.c:1: warning: no structured comments found
> 2) xilinx_axienet.h:379: warning: Function parameter or struct member
> 'skb' not described in 'axidma_bd'
> 3) xilinx_axienet.h:538: warning: Excess struct member 'phy_node'
> description in 'axienet_local'
> 4) xilinx_axienet.h:1002: warning: expecting prototype for struct
> axiethernet_option. Prototype was for struct axienet_option instead
> 
> Signed-off-by: Suraj Gupta <suraj.gupta2@....com>
> Reviewed-by: Radhey Shyam Pandey <radhey.shyam.pandey@....com>
> 
> ---
> Note: Earlier version didn't reached to mainline due to my email
> configuration issues. So again sending out with resend tag.
> 
> 
>  drivers/net/ethernet/xilinx/xilinx_axienet.h  |  4 ++--
>  .../net/ethernet/xilinx/xilinx_axienet_mdio.c | 23 ++++++++++++++++---
>  2 files changed, 22 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet.h b/drivers/net/ethernet/xilinx/xilinx_axienet.h
> index 807ead678551..d0d1ae3b4e2c 100644
> --- a/drivers/net/ethernet/xilinx/xilinx_axienet.h
> +++ b/drivers/net/ethernet/xilinx/xilinx_axienet.h
> @@ -359,6 +359,7 @@
>   * @app2:         MM2S/S2MM User Application Field 2.
>   * @app3:         MM2S/S2MM User Application Field 3.
>   * @app4:         MM2S/S2MM User Application Field 4.
> + * @skb:	  Pointer to SKB transferred using DMA

There looks to be some sort of tab vs spaces issue here?

      Andrew