linux-kernel - Re: [PATCH] tpm/st33zp24: Fix typo in st33zp24.c

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: <500c72ecc99c127838dd4bded1e70fa48a1e97a3.camel@kernel.org>
Date:   Tue, 12 Oct 2021 18:20:34 +0300
From:   Jarkko Sakkinen <jarkko@...nel.org>
To:     Sohaib Mohamed <sohaib.amhmd@...il.com>
Cc:     Peter Huewe <peterhuewe@....de>, Jason Gunthorpe <jgg@...pe.ca>,
        linux-integrity@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] tpm/st33zp24: Fix typo in st33zp24.c

On Fri, 2021-10-08 at 07:27 +0200, Sohaib Mohamed wrote:
> Remove repeated world "device"
> "datas" -> "data"
> 
> Signed-off-by: Sohaib Mohamed <sohaib.amhmd@...il.com>
> ---
>  drivers/char/tpm/st33zp24/st33zp24.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/char/tpm/st33zp24/st33zp24.c b/drivers/char/tpm/st33zp24/st33zp24.c
> index 4ec10ab5e576..f888624c1ae7 100644
> --- a/drivers/char/tpm/st33zp24/st33zp24.c
> +++ b/drivers/char/tpm/st33zp24/st33zp24.c
> @@ -62,7 +62,7 @@ enum tis_defaults {
> 
>  /*
>   * clear_interruption clear the pending interrupt.
> - * @param: tpm_dev, the tpm device device.
> + * @param: tpm_dev, the tpm device.
>   * @return: the interrupt status value.
>   */
>  static u8 clear_interruption(struct st33zp24_dev *tpm_dev)
> @@ -434,7 +434,7 @@ static int st33zp24_send(struct tpm_chip *chip, unsigned char *buf,
>  /*
>   * st33zp24_recv received TPM response through TPM phy.
>   * @param: chip, the tpm_chip description as specified in driver/char/tpm/tpm.h.
> - * @param: buf,        the buffer to store datas.
> + * @param: buf,        the buffer to store data.
>   * @param: count, the number of bytes to send.
>   * @return: In case of success the number of bytes received.
>   *         In other case, a < 0 value describing the issue.
> --
> 2.25.1
> 

So, these do not follow kdoc syntax, and they are only local functions,
i.e. it does not make sense to fix something that is already broken.

Having parameter descriptions for these is quite useless thing to
maintain so you could just remove parameter descriptions, and make
just a normal multi-line comment.

E.g.

/*
 * Clear the pending input.
 */
static u8 clear_interruption(struct st33zp24_dev *tpm_dev)

For the 2nd the current description is barely even a proper sentence,
and it does not tell what the function does. Also for that you know
what it does already, since it is just implementing the callback.

So for that, just remove the comment altogether.

Please add to the next patch version:

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


/Jarkko