[PATCH] docs: mtd: Avoid htmldocs warnings

[PATCH] docs: mtd: Avoid htmldocs warnings

[Miquel Raynal]

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>
---
 Documentation/driver-api/mtd/nand_ecc.rst | 2 +-
 Documentation/driver-api/mtdnand.rst      | 3 ---
 2 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/Documentation/driver-api/mtd/nand_ecc.rst b/Documentation/driver-api/mtd/nand_ecc.rst
index e8d3c53a5056..74347c14a70b 100644
--- a/Documentation/driver-api/mtd/nand_ecc.rst
+++ b/Documentation/driver-api/mtd/nand_ecc.rst
@@ -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%.
diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
index 0bf8d6ec3f54..ce77e024c4f1 100644
--- a/Documentation/driver-api/mtdnand.rst
+++ b/Documentation/driver-api/mtdnand.rst
@@ -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
 ===========================
 
-- 
2.20.1

Re: [PATCH] docs: mtd: Avoid htmldocs warnings

[Miquel Raynal]

On Fri, 2020-11-13 at 12:38:31 UTC, Miquel Raynal wrote:
> 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>

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next.

Miquel