linux-kernel - Re: [PATCH 1/3] scsi: pm8001: Fix warning for undescribed param in process_one

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: <2d7788bc-eadd-5061-5241-fa141259bb30@opensource.wdc.com>
Date:   Fri, 28 Jan 2022 08:06:17 +0900
From:   Damien Le Moal <damien.lemoal@...nsource.wdc.com>
To:     John Garry <john.garry@...wei.com>, jinpu.wang@...ud.ionos.com,
        jejb@...ux.ibm.com, martin.petersen@...cle.com,
        Ajish.Koshy@...rochip.com
Cc:     linux-scsi@...r.kernel.org, linux-kernel@...r.kernel.org,
        Viswas.G@...rochip.com, chenxiang66@...ilicon.com
Subject: Re: [PATCH 1/3] scsi: pm8001: Fix warning for undescribed param in
 process_one_iomb()

On 1/27/22 22:12, John Garry wrote:
> make W=1 complains of an undescribed function pararm:
> 
> drivers/scsi/pm8001/pm80xx_hwi.c:3938: warning: Function parameter or member 'circularQ' not described in 'process_one_iomb'
> 
> Fix it.
> 
> Reported-by: Damien Le Moal <damien.lemoal@...nsource.wdc.com>
> Signed-off-by: John Garry <john.garry@...wei.com>
> ---
>  drivers/scsi/pm8001/pm80xx_hwi.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/scsi/pm8001/pm80xx_hwi.c b/drivers/scsi/pm8001/pm80xx_hwi.c
> index bbf538fe15b3..ce38a2298e75 100644
> --- a/drivers/scsi/pm8001/pm80xx_hwi.c
> +++ b/drivers/scsi/pm8001/pm80xx_hwi.c
> @@ -3931,6 +3931,7 @@ static int ssp_coalesced_comp_resp(struct pm8001_hba_info *pm8001_ha,
>  /**
>   * process_one_iomb - process one outbound Queue memory block
>   * @pm8001_ha: our hba card information
> + * @circularQ: outbound circular queue

Nit: you could remove the CaMeL case here while at it :)

>   * @piomb: IO message buffer
>   */
>  static void process_one_iomb(struct pm8001_hba_info *pm8001_ha,

But anyway, looks good.

Reviewed-by: Damien Le Moal <damien.lemoal@...nsource.wdc.com>

-- 
Damien Le Moal
Western Digital Research