From: "Jarkko Sakkinen" <jarkko@kernel.org>
To: "Randy Dunlap" <rdunlap@infradead.org>, <linux-kernel@vger.kernel.org>
Cc: "Thirupathaiah Annapureddy" <thiruan@microsoft.com>,
"Peter Huewe" <peterhuewe@gmx.de>,
"Jason Gunthorpe" <jgg@ziepe.ca>,
<linux-integrity@vger.kernel.org>
Subject: Re: [PATCH] tpm/tpm_ftpm_tee: fix all kernel-doc warnings
Date: Fri, 19 Jan 2024 21:47:42 +0000 [thread overview]
Message-ID: <CYJ0HQTT1R88.1MZFUE1URTELJ@seitikki> (raw)
In-Reply-To: <20240115192447.26481-1-rdunlap@infradead.org>
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@infradead.org>
> Cc: Thirupathaiah Annapureddy <thiruan@microsoft.com>
> Cc: Peter Huewe <peterhuewe@gmx.de>
> Cc: Jarkko Sakkinen <jarkko@kernel.org>
> Cc: Jason Gunthorpe <jgg@ziepe.ca>
> Cc: linux-integrity@vger.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_tee.c
> --- 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@kernel.org>
BR, Jarkko
prev parent reply other threads:[~2024-01-19 21:47 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-15 19:24 [PATCH] tpm/tpm_ftpm_tee: fix all kernel-doc warnings Randy Dunlap
2024-01-19 21:47 ` Jarkko Sakkinen [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CYJ0HQTT1R88.1MZFUE1URTELJ@seitikki \
--to=jarkko@kernel.org \
--cc=jgg@ziepe.ca \
--cc=linux-integrity@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peterhuewe@gmx.de \
--cc=rdunlap@infradead.org \
--cc=thiruan@microsoft.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).