linux-kernel - Re: [PATCH] tpm/tpm_ftpm_tee: fix all kernel-doc warnings

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

Message-Id: <CYJ0HQTT1R88.1MZFUE1URTELJ@seitikki>
Date: Fri, 19 Jan 2024 21:47:42 +0000
From: "Jarkko Sakkinen" <jarkko@...nel.org>
To: "Randy Dunlap" <rdunlap@...radead.org>, <linux-kernel@...r.kernel.org>
Cc: "Thirupathaiah Annapureddy" <thiruan@...rosoft.com>, "Peter Huewe"
 <peterhuewe@....de>, "Jason Gunthorpe" <jgg@...pe.ca>,
 <linux-integrity@...r.kernel.org>
Subject: Re: [PATCH] tpm/tpm_ftpm_tee: fix all kernel-doc warnings

On Mon Jan 15, 2024 at 7:24 PM UTC, Randy Dunlap wrote:
> Change @pdev to @dev in 2 places to match the function parameters.
> Correct one function name in kernel-doc comment to match the function
> implementation.
>
> This prevents these warnings:
>
> tpm_ftpm_tee.c:217: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_probe'
> tpm_ftpm_tee.c:217: warning: Excess function parameter 'pdev' description in 'ftpm_tee_probe'
> tpm_ftpm_tee.c:313: warning: Function parameter or struct member 'dev' not described in 'ftpm_tee_remove'
> tpm_ftpm_tee.c:313: warning: Excess function parameter 'pdev' description in 'ftpm_tee_remove'
> tpm_ftpm_tee.c:348: warning: expecting prototype for ftpm_tee_shutdown(). Prototype was for ftpm_plat_tee_shutdown() instead
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Thirupathaiah Annapureddy <thiruan@...rosoft.com>
> Cc: Peter Huewe <peterhuewe@....de>
> Cc: Jarkko Sakkinen <jarkko@...nel.org>
> Cc: Jason Gunthorpe <jgg@...pe.ca>
> Cc: linux-integrity@...r.kernel.org
> ---
>  drivers/char/tpm/tpm_ftpm_tee.c |    6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff -- a/drivers/char/tpm/tpm_ftpm_tee.c b/drivers/char/tpm/tpm_ftpm_teec
> --- a/drivers/char/tpm/tpm_ftpm_tee.c
> +++ b/drivers/char/tpm/tpm_ftpm_tee.c
> @@ -208,7 +208,7 @@ static int ftpm_tee_match(struct tee_ioc
>  
>  /**
>   * ftpm_tee_probe() - initialize the fTPM
> - * @pdev: the platform_device description.
> + * @dev: the device description.
>   *
>   * Return:
>   *	On success, 0. On failure, -errno.
> @@ -304,7 +304,7 @@ static int ftpm_plat_tee_probe(struct pl
>  
>  /**
>   * ftpm_tee_remove() - remove the TPM device
> - * @pdev: the platform_device description.
> + * @dev: the device description.
>   *
>   * Return:
>   *	0 always.
> @@ -341,7 +341,7 @@ static void ftpm_plat_tee_remove(struct
>  }
>  
>  /**
> - * ftpm_tee_shutdown() - shutdown the TPM device
> + * ftpm_plat_tee_shutdown() - shutdown the TPM device
>   * @pdev: the platform_device description.
>   */
>  static void ftpm_plat_tee_shutdown(struct platform_device *pdev)

Reviewed-by: Jarkko Sakkinen <jarkko@...nel.org>

BR, Jarkko