mtd: nand: Fix a docs build warning

Message ID 20170730161803.1593200e@lwn.net
State Accepted
Commit cb25fae18207330caac848d850e11f9cdb500dbf
Headers show

Commit Message

Jonathan Corbet July 30, 2017, 10:18 p.m.
Commit 0b4773fd1649 (mtd: nand: Drop unused cached programming support)
removed the "cached" parameter from nand_write_page(), but did not update
the kerneldoc comments, creating this docs build warning:

  ./drivers/mtd/nand/nand_base.c:2751: warning: Excess function parameter 'cached' description in 'nand_write_page'

Remove the offending line so we can have a little peace and quiet.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
 drivers/mtd/nand/nand_base.c | 1 -
 1 file changed, 1 deletion(-)

-- 
2.13.3


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Comments

Boris Brezillon July 31, 2017, 4:27 p.m. | #1
On Sun, 30 Jul 2017 16:18:03 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> Commit 0b4773fd1649 (mtd: nand: Drop unused cached programming support)

> removed the "cached" parameter from nand_write_page(), but did not update

> the kerneldoc comments, creating this docs build warning:

> 

>   ./drivers/mtd/nand/nand_base.c:2751: warning: Excess function parameter 'cached' description in 'nand_write_page'

> 

> Remove the offending line so we can have a little peace and quiet.


Applied to nand/fixes.

Thanks,

Boris

> 

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>

> ---

>  drivers/mtd/nand/nand_base.c | 1 -

>  1 file changed, 1 deletion(-)

> 

> diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c

> index 5fa5ddc94834..ba57d8970f27 100644

> --- a/drivers/mtd/nand/nand_base.c

> +++ b/drivers/mtd/nand/nand_base.c

> @@ -2741,7 +2741,6 @@ static int nand_write_page_syndrome(struct mtd_info *mtd,

>   * @buf: the data to write

>   * @oob_required: must write chip->oob_poi to OOB

>   * @page: page number to write

> - * @cached: cached programming

>   * @raw: use _raw version of write_page

>   */

>  static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,



______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

Patch

diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c
index 5fa5ddc94834..ba57d8970f27 100644
--- a/drivers/mtd/nand/nand_base.c
+++ b/drivers/mtd/nand/nand_base.c
@@ -2741,7 +2741,6 @@  static int nand_write_page_syndrome(struct mtd_info *mtd,
  * @buf: the data to write
  * @oob_required: must write chip->oob_poi to OOB
  * @page: page number to write
- * @cached: cached programming
  * @raw: use _raw version of write_page
  */
 static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,