Skip to contentSkip to conversation

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

PATCH Applied Rosen Penev 2 participants 2 messages Aug 22 – Sep 4

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mtd: nand: omap2: Fix kernel-doc parameter warning

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
---
 drivers/mtd/nand/raw/omap2.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
drivers/mtd/nand/raw/omap2.c +1 -3
index 552f36da79fc..4909e62dc11e 100644
@@ -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];
Signature · 1 line
2.55.0
maintainer Applied
#1 lore raw
Quoted 8 lines · Rosen Penev

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