netdev - Re: [PATCH net-next 2/4] ice: Implement 'flow-type ether' rules

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: <f0ed2d9e-99f2-4739-a2a7-62de488db35e@intel.com>
Date: Fri, 12 Apr 2024 11:41:39 +0200
From: "Plachno, Lukasz" <lukasz.plachno@...el.com>
To: Tony Nguyen <anthony.l.nguyen@...el.com>
CC: <davem@...emloft.net>, <pabeni@...hat.com>, <edumazet@...gle.com>,
	<netdev@...r.kernel.org>, Jakub Buchocki <jakubx.buchocki@...el.com>, Mateusz
 Pacuszka <mateuszx.pacuszka@...el.com>, Przemek Kitszel
	<przemyslaw.kitszel@...el.com>, Jacob Keller <jacob.e.keller@...el.com>,
	Simon Horman <horms@...nel.org>, Pucha Himasekhar Reddy
	<himasekharx.reddy.pucha@...el.com>, Jakub Kicinski <kuba@...nel.org>
Subject: Re: [PATCH net-next 2/4] ice: Implement 'flow-type ether' rules

On 4/12/2024 5:06 AM, Jakub Kicinski wrote:
> On Thu, 11 Apr 2024 10:38:42 -0700 Tony Nguyen wrote:
>> +/**
>> + * ice_set_fdir_vlan_seg
>> + * @seg: flow segment for programming
>> + * @ext_masks: masks for additional RX flow fields
>> + */
> 
> kerne-doc is not on board (note that we started using the -Wall flag
> when running the script):
> 
> drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c:1285: warning: missing initial short description on line:
>   * ice_set_fdir_vlan_seg
> drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c:1292: warning: No description found for return value of 'ice_set_fdir_vlan_seg'

Tony,

Change below fixes the kernel-doc warnings in case it is okay to amend 
the commit in your tree.
If you prefer I will send V9 with fixed comments to list.

Thanks,
Łukasz

---
diff --git a/drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c 
b/drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c
index ab3121aee412..e3cab8e98f52 100644
--- a/drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c
+++ b/drivers/net/ethernet/intel/ice/ice_ethtool_fdir.c
@@ -1228,7 +1228,7 @@ static bool ice_fdir_vlan_valid(struct device *dev,
  }

  /**
- * ice_set_ether_flow_seg
+ * ice_set_ether_flow_seg - set address and protocol segments for ether 
flow
   * @dev: network interface device structure
   * @seg: flow segment for programming
   * @eth_spec: mask data from ethtool
@@ -1282,9 +1282,11 @@ static int ice_set_ether_flow_seg(struct device *dev,
  }

  /**
- * ice_set_fdir_vlan_seg
+ * ice_set_fdir_vlan_seg - set vlan segments for ether flow
   * @seg: flow segment for programming
   * @ext_masks: masks for additional RX flow fields
+ *
+ * Return: 0 on success and errno in case of error.
   */
  static int
  ice_set_fdir_vlan_seg(struct ice_flow_seg_info *seg,
--
2.34.1