[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <6b0649c53e853fd2a35e9996f13e702daa0d7e2f.camel@perches.com>
Date: Mon, 22 Jun 2020 13:30:33 -0700
From: Joe Perches <joe@...ches.com>
To: Julia Lawall <Julia.Lawall@...ia.fr>, trivial@...nel.org
Cc: kernel-janitors@...r.kernel.org, corbet@....net,
linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] trivial: fix kerneldoc comments
On Mon, 2020-06-22 at 21:37 +0200, Julia Lawall wrote:
> Fix the parameter names in the comment to correspond to those in the
> function header.
>
> Drop comments about return values when there is no return value.
Done by hand or script?
[]
> diff --git a/arch/mips/cavium-octeon/executive/cvmx-spi.c b/arch/mips/cavium-octeon/executive/cvmx-spi.c
[]
> @@ -69,9 +69,7 @@ static cvmx_spi_callbacks_t cvmx_spi_callbacks = {
> /**
> * Get current SPI4 initialization callbacks
> *
> - * @callbacks: Pointer to the callbacks structure.to fill
> - *
> - * Returns Pointer to cvmx_spi_callbacks_t structure.
> + * @callbacks: Pointer to the callbacks structure, to fill.
If scripted, odd comma after structure
> diff --git a/drivers/crypto/bcm/spu.c b/drivers/crypto/bcm/spu.c
[]
> @@ -519,7 +519,7 @@ u32 spum_assoc_resp_len(enum spu_cipher_mode cipher_mode,
> * spu_aead_ivlen() - Calculate the length of the AEAD IV to be included
> * in a SPU request after the AAD and before the payload.
> * @cipher_mode: cipher mode
> - * @iv_ctr_len: initialization vector length in bytes
> + * @iv_len: initialization vector length in bytes
> *
> * In Linux ~4.2 and later, the assoc_data sg includes the IV. So no need
> * to include the IV as a separate field in the SPU request msg.
> @@ -917,7 +917,7 @@ u16 spum_cipher_req_init(u8 *spu_hdr, struct spu_cipher_parms *cipher_parms)
> * setkey() time in spu_cipher_req_init().
> * @spu_hdr: Start of the request message header (MH field)
> * @spu_req_hdr_len: Length in bytes of the SPU request header
> - * @isInbound: 0 encrypt, 1 decrypt
> + * @is_inbound: 0 encrypt, 1 decrypt
odd alignments
etc...
Powered by blists - more mailing lists