linux-kernel - Re: [PATCH] mtd: docg3: fix 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: <874iqtf576.fsf@bootlin.com>
Date: Mon, 17 Nov 2025 09:12:29 +0100
From: Miquel Raynal <miquel.raynal@...tlin.com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org,  Robert Jarzmik <robert.jarzmik@...e.fr>,
  Richard Weinberger <richard@....at>,  Vignesh Raghavendra
 <vigneshr@...com>,  linux-mtd@...ts.infradead.org
Subject: Re: [PATCH] mtd: docg3: fix kernel-doc warnings

Hi Randy,

On 15/11/2025 at 23:09:44 -08, Randy Dunlap <rdunlap@...radead.org> wrote:

> Fix kernel-doc warnings in docg3.h to avoid build warnings and to
> improve and documentation:

"to improve and documentation" is incorrect, can you please fix?

> Warning: ../drivers/mtd/devices/docg3.h:276 bad line:
> Warning: drivers/mtd/devices/docg3.h:299 struct member 'max_block' not
>  described in 'docg3'
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Robert Jarzmik <robert.jarzmik@...e.fr>
> Cc: Miquel Raynal <miquel.raynal@...tlin.com>
> Cc: Richard Weinberger <richard@....at>
> Cc: Vignesh Raghavendra <vigneshr@...com>
> Cc: linux-mtd@...ts.infradead.org
> ---
>  drivers/mtd/devices/docg3.h |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> --- linux-next-20251114.orig/drivers/mtd/devices/docg3.h
> +++ linux-next-20251114/drivers/mtd/devices/docg3.h
> @@ -274,11 +274,12 @@ struct docg3_cascade {
>   * @cascade: the cascade this device belongs to
>   * @device_id: number of the cascaded DoCG3 device (0, 1, 2 or 3)
>   * @if_cfg: if true, reads are on 16bits, else reads are on 8bits
> -
> + *

Wrong fix I believe. What make you think a space is relevant here?

>   * @reliable: if 0, docg3 in normal mode, if 1 docg3 in fast mode, if 2 in
>   *            reliable mode
>   *            Fast mode implies more errors than normal mode.
>   *            Reliable mode implies that page 2*n and 2*n+1 are clones.
> + * @max_block: maximum block number for this device
>   * @bbt: bad block table cache
>   * @oob_write_ofs: offset of the MTD where this OOB should belong (ie. in next
>   *                 page_write)

Thanks,
Miquèl