[PATCH net-next 0/3] Fix some kernel-doc warnings for i40e

[PATCH net-next 0/3] Fix some kernel-doc warnings for i40e

[Wang Hai]

Wang Hai (3):
  i40e: Fix some kernel-doc warnings in i40e_client.c
  i40e: Fix some kernel-doc warnings in i40e_common.c
  i40e: Fix a kernel-doc warning in i40e_ptp.c

 drivers/net/ethernet/intel/i40e/i40e_client.c | 2 --
 drivers/net/ethernet/intel/i40e/i40e_common.c | 2 --
 drivers/net/ethernet/intel/i40e/i40e_ptp.c    | 1 -
 3 files changed, 5 deletions(-)

-- 
2.17.1

[PATCH net-next 1/3] i40e: Fix some kernel-doc warnings in i40e_client.c

[Wang Hai]

Fixes the following W=1 kernel build warning(s):

drivers/net/ethernet/intel/i40e/i40e_client.c:286: warning: Excess function parameter 'client' description in 'i40e_client_add_instance'
drivers/net/ethernet/intel/i40e/i40e_client.c:286: warning: Excess function parameter 'existing' description in 'i40e_client_add_instance'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/i40e/i40e_client.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/net/ethernet/intel/i40e/i40e_client.c b/drivers/net/ethernet/intel/i40e/i40e_client.c
index befd3018183f..a2dba32383f6 100644
--- a/drivers/net/ethernet/intel/i40e/i40e_client.c
+++ b/drivers/net/ethernet/intel/i40e/i40e_client.c
@@ -278,8 +278,6 @@ void i40e_client_update_msix_info(struct i40e_pf *pf)
 /**
  * i40e_client_add_instance - add a client instance struct to the instance list
  * @pf: pointer to the board struct
- * @client: pointer to a client struct in the client list.
- * @existing: if there was already an existing instance
  *
  **/
 static void i40e_client_add_instance(struct i40e_pf *pf)
-- 
2.17.1

[PATCH net-next 2/3] i40e: Fix some kernel-doc warnings in i40e_common.c

[Wang Hai]

Fixes the following W=1 kernel build warning(s):

drivers/net/ethernet/intel/i40e/i40e_common.c:3778: warning: Excess function parameter 'buff' description in 'i40e_aq_start_lldp'
drivers/net/ethernet/intel/i40e/i40e_common.c:3778: warning: Excess function parameter 'buff_size' description in 'i40e_aq_start_lldp'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/i40e/i40e_common.c | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/net/ethernet/intel/i40e/i40e_common.c b/drivers/net/ethernet/intel/i40e/i40e_common.c
index 6ab52cbd697a..361329874d98 100644
--- a/drivers/net/ethernet/intel/i40e/i40e_common.c
+++ b/drivers/net/ethernet/intel/i40e/i40e_common.c
@@ -3766,9 +3766,7 @@ i40e_status i40e_aq_stop_lldp(struct i40e_hw *hw, bool shutdown_agent,
 /**
  * i40e_aq_start_lldp
  * @hw: pointer to the hw struct
- * @buff: buffer for result
  * @persist: True if start of LLDP should be persistent across power cycles
- * @buff_size: buffer size
  * @cmd_details: pointer to command details structure or NULL
  *
  * Start the embedded LLDP Agent on all ports.
-- 
2.17.1

[PATCH net-next 3/3] i40e: Fix a kernel-doc warning in i40e_ptp.c

[Wang Hai]

Fixes the following W=1 kernel build warning(s):

drivers/net/ethernet/intel/i40e/i40e_ptp.c:270: warning: Excess function parameter 'vsi' description in 'i40e_ptp_rx_hang'

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Wang Hai <wanghai38@huawei.com>
---
 drivers/net/ethernet/intel/i40e/i40e_ptp.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/net/ethernet/intel/i40e/i40e_ptp.c b/drivers/net/ethernet/intel/i40e/i40e_ptp.c
index ff7b19c6bc73..7a879614ca55 100644
--- a/drivers/net/ethernet/intel/i40e/i40e_ptp.c
+++ b/drivers/net/ethernet/intel/i40e/i40e_ptp.c
@@ -259,7 +259,6 @@ static u32 i40e_ptp_get_rx_events(struct i40e_pf *pf)
 /**
  * i40e_ptp_rx_hang - Detect error case when Rx timestamp registers are hung
  * @pf: The PF private data structure
- * @vsi: The VSI with the rings relevant to 1588
  *
  * This watchdog task is scheduled to detect error case where hardware has
  * dropped an Rx packet that was timestamped when the ring is full. The
-- 
2.17.1

Re: [PATCH net-next 0/3] Fix some kernel-doc warnings for i40e

[Jesse Brandeburg]

Wang Hai wrote:

> Wang Hai (3):
>   i40e: Fix some kernel-doc warnings in i40e_client.c
>   i40e: Fix some kernel-doc warnings in i40e_common.c
>   i40e: Fix a kernel-doc warning in i40e_ptp.c
> 
>  drivers/net/ethernet/intel/i40e/i40e_client.c | 2 --
>  drivers/net/ethernet/intel/i40e/i40e_common.c | 2 --
>  drivers/net/ethernet/intel/i40e/i40e_ptp.c    | 1 -
>  3 files changed, 5 deletions(-)
> 


Please see my patchset [1]: I've already fixed all of these and many
others.

In fact, before you continue, I have a whole set done making the entire
drivers/net/ethernet directory compile cleanly with W=1, that I'm about
to send, but they depend on [1]

[1]
https://patchwork.ozlabs.org/project/intel-wired-lan/list/?series=&submitter=189&state=&q=&archive=&delegate=