Subject: Re: [PATCH 12/12] net: ethernet: ibm: ibmvnic: Fix some kernel-doc issues

From: drt <[email-masked]>
Date: Wed, 04 Nov 2020 09:59:16 -0800

On 2020-11-04 01:06, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  from drivers/net/ethernet/ibm/ibmvnic.c:35:
>  inlined from ‘handle_vpd_rsp’ at 
> drivers/net/ethernet/ibm/ibmvnic.c:4124:3:
>  drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Function parameter
> or member 'hdr_data' not described in 'build_hdr_data'
>  drivers/net/ethernet/ibm/ibmvnic.c:1362: warning: Excess function
> parameter 'tot_len' description in 'build_hdr_data'
>  drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Function parameter
> or member 'hdr_data' not described in 'create_hdr_descs'
>  drivers/net/ethernet/ibm/ibmvnic.c:1423: warning: Excess function
> parameter 'data' description in 'create_hdr_descs'
>  drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Function parameter
> or member 'txbuff' not described in 'build_hdr_descs_arr'
>  drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Excess function
> parameter 'skb' description in 'build_hdr_descs_arr'
>  drivers/net/ethernet/ibm/ibmvnic.c:1474: warning: Excess function
> parameter 'subcrq' description in 'build_hdr_descs_arr'
> 
> Cc: Michael Ellerman <[email-masked]>
> Cc: Benjamin Herrenschmidt <[email-masked]>
> Cc: Paul Mackerras <[email-masked]>
> Cc: Dany Madden <[email-masked]>
> Cc: Lijun Pan <[email-masked]>
> Cc: Sukadev Bhattiprolu <[email-masked]>
> Cc: "David S. Miller" <[email-masked]>
> Cc: Jakub Kicinski <[email-masked]>
> Cc: Santiago Leon <[email-masked]>
> Cc: Thomas Falcon <[email-masked]>
> Cc: John Allen <[email-masked]>
> Cc: [email-masked]
> Cc: [email-masked]
> Signed-off-by: Lee Jones <[email-masked]>

Reviewed-by: Dany Madden <[email-masked]>

Thanks, Lee.
Dany

> ---
>  drivers/net/ethernet/ibm/ibmvnic.c | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/net/ethernet/ibm/ibmvnic.c
> b/drivers/net/ethernet/ibm/ibmvnic.c
> index b30e1f5784bad..08dab7a94b7ea 100644
> --- a/drivers/net/ethernet/ibm/ibmvnic.c
> +++ b/drivers/net/ethernet/ibm/ibmvnic.c
> @@ -1360,7 +1360,7 @@ static int ibmvnic_close(struct net_device 
> *netdev)
>   * @hdr_field: bitfield determining needed headers
>   * @skb: socket buffer
>   * @hdr_len: array of header lengths
> - * @tot_len: total length of data
> + * @hdr_data: buffer to write the header to
>   *
>   * Reads hdr_field to determine which headers are needed by firmware.
>   * Builds a buffer containing these headers.  Saves individual header
> @@ -1418,7 +1418,7 @@ static int build_hdr_data(u8 hdr_field, struct
> sk_buff *skb,
>  /**
>   * create_hdr_descs - create header and header extension descriptors
>   * @hdr_field: bitfield determining needed headers
> - * @data: buffer containing header data
> + * @hdr_data: buffer containing header data
>   * @len: length of data buffer
>   * @hdr_len: array of individual header lengths
>   * @scrq_arr: descriptor array
> @@ -1469,9 +1469,8 @@ static int create_hdr_descs(u8 hdr_field, u8
> *hdr_data, int len, int *hdr_len,
> 
>  /**
>   * build_hdr_descs_arr - build a header descriptor array
> - * @skb: socket buffer
> + * @txbuff: tx buffer
>   * @num_entries: number of descriptors to be sent
> - * @subcrq: first TX descriptor
>   * @hdr_field: bit field determining which headers will be sent
>   *
>   * This function will build a TX descriptor array with applicable