linux-kernel - Re: [PATCH] trivial: fix kerneldoc comments

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: <alpine.DEB.2.22.394.2006230954560.2367@hadrien>
Date:   Tue, 23 Jun 2020 09:59:57 +0200 (CEST)
From:   Julia Lawall <julia.lawall@...ia.fr>
To:     Joe Perches <joe@...ches.com>
cc:     trivial@...nel.org, 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, 22 Jun 2020, Joe Perches wrote:

> 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?

Found by script but done by hand.  Unfortuntely, I can't figure even a
hackish way to get Coccinelle to modify comments.  I guess I could have
used Coccinelle to print out a patch and then run that, but since the
result has to be checked anyway, I just made the changes by hand.

>
> []
> > 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

Hmm, maybe I interpreted the words slightly differently.  t looks like it
would be fine without the comma.

>
> > 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

Sorry to have missed these.

> etc...

Are there a lot of other such problems?  I did look through the whole
patch several times by hand, but perhaps it is just too big to see
everything.

julia