From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
Robert Jarzmik <robert.jarzmik@free.fr>,
Richard Weinberger <richard@nod.at>,
Vignesh Raghavendra <vigneshr@ti.com>,
linux-mtd@lists.infradead.org
Subject: Re: [PATCH] mtd: docg3: fix kernel-doc warnings
Date: Mon, 17 Nov 2025 09:12:29 +0100 [thread overview]
Message-ID: <874iqtf576.fsf@bootlin.com> (raw)
In-Reply-To: <20251116070944.84071-1-rdunlap@infradead.org> (Randy Dunlap's message of "Sat, 15 Nov 2025 23:09:44 -0800")
Hi Randy,
On 15/11/2025 at 23:09:44 -08, Randy Dunlap <rdunlap@infradead.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@infradead.org>
> ---
> Cc: Robert Jarzmik <robert.jarzmik@free.fr>
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: Richard Weinberger <richard@nod.at>
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: linux-mtd@lists.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
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
WARNING: multiple messages have this Message-ID (diff)
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
Robert Jarzmik <robert.jarzmik@free.fr>,
Richard Weinberger <richard@nod.at>,
Vignesh Raghavendra <vigneshr@ti.com>,
linux-mtd@lists.infradead.org
Subject: Re: [PATCH] mtd: docg3: fix kernel-doc warnings
Date: Mon, 17 Nov 2025 09:12:29 +0100 [thread overview]
Message-ID: <874iqtf576.fsf@bootlin.com> (raw)
In-Reply-To: <20251116070944.84071-1-rdunlap@infradead.org> (Randy Dunlap's message of "Sat, 15 Nov 2025 23:09:44 -0800")
Hi Randy,
On 15/11/2025 at 23:09:44 -08, Randy Dunlap <rdunlap@infradead.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@infradead.org>
> ---
> Cc: Robert Jarzmik <robert.jarzmik@free.fr>
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: Richard Weinberger <richard@nod.at>
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: linux-mtd@lists.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
next prev parent reply other threads:[~2025-11-17 8:12 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-16 7:09 [PATCH] mtd: docg3: fix kernel-doc warnings Randy Dunlap
2025-11-16 7:09 ` Randy Dunlap
2025-11-17 8:12 ` Miquel Raynal [this message]
2025-11-17 8:12 ` Miquel Raynal
2025-11-17 19:09 ` Randy Dunlap
2025-11-17 19:09 ` Randy Dunlap
2025-11-17 19:25 ` Randy Dunlap
2025-11-17 19:25 ` Randy Dunlap
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=874iqtf576.fsf@bootlin.com \
--to=miquel.raynal@bootlin.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=rdunlap@infradead.org \
--cc=richard@nod.at \
--cc=robert.jarzmik@free.fr \
--cc=vigneshr@ti.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.