docs: mtd: Avoid htmldocs warnings
authorMiquel Raynal <miquel.raynal@bootlin.com>
Fri, 13 Nov 2020 12:38:31 +0000 (13:38 +0100)
committerMiquel Raynal <miquel.raynal@bootlin.com>
Thu, 10 Dec 2020 21:37:32 +0000 (22:37 +0100)
Moving files around produced the following warnings:

       Error: Cannot open file drivers/mtd/nand/raw/nand_ecc.c
       Error: Cannot open file drivers/mtd/nand/raw/nand_ecc.c

Fix one by just dropping the reference because it is not relevant, the
other by using a better noun instead of a file name.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20201113123831.32429-1-miquel.raynal@bootlin.com
Documentation/driver-api/mtd/nand_ecc.rst
Documentation/driver-api/mtdnand.rst

index e8d3c53a50568690745996d7f7d50580a9265411..74347c14a70bb17603b3e6cc0a695e01a9b5825b 100644 (file)
@@ -5,7 +5,7 @@ NAND Error-correction Code
 Introduction
 ============
 
-Having looked at the linux mtd/nand driver and more specific at nand_ecc.c
+Having looked at the linux mtd/nand Hamming software ECC engine driver
 I felt there was room for optimisation. I bashed the code for a few hours
 performing tricks like table lookup removing superfluous code etc.
 After that the speed was increased by 35-40%.
index 0bf8d6ec3f54d35afbe364b2ce4e6a9e78f675ba..ce77e024c4f1c9c67f976ea7150066cce8c96080 100644 (file)
@@ -972,9 +972,6 @@ hints" for an explanation.
 .. kernel-doc:: drivers/mtd/nand/raw/nand_base.c
    :export:
 
-.. kernel-doc:: drivers/mtd/nand/raw/nand_ecc.c
-   :export:
-
 Internal Functions Provided
 ===========================