netdev - Re: [PATCH net-next 2/6] net/mlx5e: fix kdoc warning on eswitch.h

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <aHSnvakoq5U4QX3T@mev-dev.igk.intel.com>
Date: Mon, 14 Jul 2025 08:46:31 +0200
From: Michal Swiatkowski <michal.swiatkowski@...ux.intel.com>
To: Tariq Toukan <tariqt@...dia.com>
Cc: Eric Dumazet <edumazet@...gle.com>, Jakub Kicinski <kuba@...nel.org>,
	Paolo Abeni <pabeni@...hat.com>,
	Andrew Lunn <andrew+netdev@...n.ch>,
	"David S. Miller" <davem@...emloft.net>,
	Saeed Mahameed <saeed@...nel.org>, Gal Pressman <gal@...dia.com>,
	Leon Romanovsky <leon@...nel.org>,
	Saeed Mahameed <saeedm@...dia.com>, Mark Bloch <mbloch@...dia.com>,
	netdev@...r.kernel.org, linux-rdma@...r.kernel.org,
	linux-kernel@...r.kernel.org, Moshe Shemesh <moshe@...dia.com>
Subject: Re: [PATCH net-next 2/6] net/mlx5e: fix kdoc warning on eswitch.h

On Mon, Jul 14, 2025 at 08:39:41AM +0300, Tariq Toukan wrote:
> From: Moshe Shemesh <moshe@...dia.com>
> 
> Fix the following kdoc warning:
> git ls-files *.[ch] | egrep drivers/net/ethernet/mellanox/mlx5/core/ |\
> xargs scripts/kernel-doc --none
> drivers/net/ethernet/mellanox/mlx5/core/eswitch.h:824: warning: cannot
> understand function prototype: 'struct mlx5_esw_event_info '
> 
> Signed-off-by: Moshe Shemesh <moshe@...dia.com>
> Signed-off-by: Tariq Toukan <tariqt@...dia.com>
> ---
>  drivers/net/ethernet/mellanox/mlx5/core/eswitch.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/ethernet/mellanox/mlx5/core/eswitch.h b/drivers/net/ethernet/mellanox/mlx5/core/eswitch.h
> index d59fdcb29cb8..b0b8ef3ec3c4 100644
> --- a/drivers/net/ethernet/mellanox/mlx5/core/eswitch.h
> +++ b/drivers/net/ethernet/mellanox/mlx5/core/eswitch.h
> @@ -827,7 +827,7 @@ void mlx5_esw_vport_vhca_id_clear(struct mlx5_eswitch *esw, u16 vport_num);
>  int mlx5_eswitch_vhca_id_to_vport(struct mlx5_eswitch *esw, u16 vhca_id, u16 *vport_num);
>  
>  /**
> - * mlx5_esw_event_info - Indicates eswitch mode changed/changing.
> + * struct mlx5_esw_event_info - Indicates eswitch mode changed/changing.
>   *
>   * @new_mode: New mode of eswitch.
>   */

Looks like it is the only one structure in this file described using
kdoc.

Reviewed-by: Michal Swiatkowski <michal.swiatkowski@...ux.intel.com>

> -- 
> 2.40.1