diff mbox series

mtd: nand: omap2: Fix kernel-doc parameter warning

Message ID 20260822230334.214070-1-rosenp@gmail.com
State Accepted
Headers show
Series mtd: nand: omap2: Fix kernel-doc parameter warning | expand

Commit Message

Rosen Penev Aug. 22, 2026, 11:03 p.m. UTC
kernel-doc interprets inline comments in the omap_compare_ecc()
parameter list as part of the prototype, causing it to miss
ecc_data2 and report its documentation as excess.

Remove the inline comments; the parameter descriptions are already
provided by the kernel-doc tags.

Assisted-by: Codex:GPT-5.6-luna
Signed-off-by: Rosen Penev <rosenp@gmail.com>
---
 drivers/mtd/nand/raw/omap2.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Comments

Miquel Raynal Sept. 4, 2026, 6:09 p.m. UTC | #1
On Sat, 22 Aug 2026 16:03:34 -0700, Rosen Penev wrote:
> kernel-doc interprets inline comments in the omap_compare_ecc()
> parameter list as part of the prototype, causing it to miss
> ecc_data2 and report its documentation as excess.
> 
> Remove the inline comments; the parameter descriptions are already
> provided by the kernel-doc tags.
> 
> [...]

Applied to nand/next, thanks!

[1/1] mtd: nand: omap2: Fix kernel-doc parameter warning
      commit: c469391db15839b2d1b1294eb4a5e5c36ab5ac7a

Patche(s) should be available on mtd/linux.git and will be
part of the next PR (provided that no robot complains by then).

Kind regards,
Miquèl
diff mbox series

Patch

diff --git a/drivers/mtd/nand/raw/omap2.c b/drivers/mtd/nand/raw/omap2.c
index 552f36da79fc..4909e62dc11e 100644
--- a/drivers/mtd/nand/raw/omap2.c
+++ b/drivers/mtd/nand/raw/omap2.c
@@ -666,9 +666,7 @@  static void gen_true_ecc(u8 *ecc_buf)
  * If there is no error, %0 is returned. If there is an error but it
  * was corrected, %1 is returned. Otherwise, %-1 is returned.
  */
-static int omap_compare_ecc(u8 *ecc_data1,	/* read from NAND memory */
-			    u8 *ecc_data2,	/* read from register */
-			    u8 *page_data)
+static int omap_compare_ecc(u8 *ecc_data1, u8 *ecc_data2, u8 *page_data)
 {
 	uint	i;
 	u8	tmp0_bit[8], tmp1_bit[8], tmp2_bit[8];