Re: [l2-mtd:next 457/463] DockBook: drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found

Re: [l2-mtd:next 457/463] DockBook: drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found

[Brian Norris]

On Sun, Jan 24, 2016 at 07:10:38AM +0800, kbuild test robot wrote:
> tree:   git://git.infradead.org/users/dedekind/l2-mtd.git next
> head:   b8b0e465ddb0c9cb16089ddfed68a8569e006465
> commit: 54ca3cd594db58d65b3670f2af452c1104b09ac6 [457/463] mtd: nand: remove EXPORT_SYMBOL of nand_scan_bbt()
> reproduce: make htmldocs
> 
> All warnings (new ones prefixed by >>):
> 
> >> drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found
> 
> vim +1 drivers/mtd/nand/nand_bbt.c
> 
> ^1da177e Linus Torvalds 2005-04-16 @1  /*
> ^1da177e Linus Torvalds 2005-04-16  2   *  Overview:
> ^1da177e Linus Torvalds 2005-04-16  3   *   Bad block table support for the NAND driver
> ^1da177e Linus Torvalds 2005-04-16  4   *
> d159c4e5 Fabio Estevam  2012-07-28  5   *  Copyright © 2004 Thomas Gleixner (tglx@linutronix.de)
> ^1da177e Linus Torvalds 2005-04-16  6   *
> ^1da177e Linus Torvalds 2005-04-16  7   * This program is free software; you can redistribute it and/or modify
> ^1da177e Linus Torvalds 2005-04-16  8   * it under the terms of the GNU General Public License version 2 as
> ^1da177e Linus Torvalds 2005-04-16  9   * published by the Free Software Foundation.
> 
> :::::: The code at line 1 was first introduced by commit
> :::::: 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 Linux-2.6.12-rc2
> 
> :::::: TO: Linus Torvalds <torvalds@ppc970.osdl.org>
> :::::: CC: Linus Torvalds <torvalds@ppc970.osdl.org>

I'm not sure why we're getting this report right now... It's definitely
not a "new" warning. I also can't reproduce it when I run 'make
htmldocs'. The comment block in question doesn't use the kerneldoc
format (i.e., beginning with '/**'), so I don't know why this warning
would occur at all.

Brian