Skip to content

Commit

Permalink
docs: mtd: Avoid htmldocs warnings
Browse files Browse the repository at this point in the history
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 <[email protected]>
Link: https://lore.kernel.org/linux-mtd/[email protected]
  • Loading branch information
miquelraynal committed Dec 10, 2020
1 parent 0f6b791 commit 131ce3e
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 4 deletions.
2 changes: 1 addition & 1 deletion Documentation/driver-api/mtd/nand_ecc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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%.
Expand Down
3 changes: 0 additions & 3 deletions Documentation/driver-api/mtdnand.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===========================

Expand Down

0 comments on commit 131ce3e

Please sign in to comment.