Patchwork MTD: missing comment in nand.h

login
register
mail settings
Submitter John Crispin
Date Aug. 28, 2012, 6:57 a.m.
Message ID <1346137063-20903-1-git-send-email-blogic@openwrt.org>
Download mbox | patch
Permalink /patch/180344/
State New
Headers show

Comments

John Crispin - Aug. 28, 2012, 6:57 a.m.
Robert reported the following error when generating kernel doc.
> Warning(/home/rpjday/k/git//include/linux/mtd/nand.h:659): No  description found for parameter 'read_byte'

Signed-off-by: John Crispin <blogic@openwrt.org>
Cc: Robert P. J. Day <rpjday@crashcourse.ca>
---
 include/linux/mtd/nand.h |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)
Artem Bityutskiy - Aug. 30, 2012, 6:21 a.m.
On Tue, 2012-08-28 at 08:57 +0200, John Crispin wrote:
> Robert reported the following error when generating kernel doc.
> > Warning(/home/rpjday/k/git//include/linux/mtd/nand.h:659): No  description found for parameter 'read_byte'
> 
> Signed-off-by: John Crispin <blogic@openwrt.org>
> Cc: Robert P. J. Day <rpjday@crashcourse.ca>

Already have a fix for this in my l2-mtd.git tree:

commit 94476fdcef8902ad168b8618c3055e181a4740f6
Author: Randy Dunlap <rdunlap@xenotime.net>
Date:   Sat Aug 18 17:41:35 2012 -0700

    mtd: fix kernel-doc warning in include/linux/mtd/nand.h
    
    Fix kernel-doc warning in <linux/mtd/nand.h>:
    
    Warning(include/linux/mtd/nand.h:659): No description found for parameter 'read_byte'
    
    Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
    Acked-by: Brian Norris <computersforpeace@gmail.com>
    Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>

Patch

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 57977c6..5654bbe 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -641,6 +641,7 @@  struct platform_device;
  *			ALE/CLE/nCE. Also used to write command and address
  * @write_buf:		platform specific function for write buffer
  * @read_buf:		platform specific function for read buffer
+ * @read_byte:		platform specific function for reading a byte
  * @priv:		private data to transport driver specific settings
  *
  * All fields are optional and depend on the hardware driver requirements