]> git.karo-electronics.de Git - linux-beck.git/commit
docbook: warn on unused doc entries
authorJohannes Berg <johannes.berg@intel.com>
Sat, 11 Sep 2010 22:55:22 +0000 (15:55 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Sat, 11 Sep 2010 23:49:21 +0000 (16:49 -0700)
commiteda603f6cdba4b14dbf80531fab2fe545232e7a0
tree94e88243e917d55fac8e8ca79f51ea7c8fcc45ed
parent1f3a66889c4c80c821f3eadf899c140e91452f8e
docbook: warn on unused doc entries

When you don't use !E or !I but only !F, then it's very easy to miss
including some functions, structs etc.  in documentation.  To help
finding which ones were missed, allow printing out the unused ones as
warnings.

For example, using this on mac80211 yields a lot of warnings like this:

  Warning: didn't use docs for DOC: mac80211 workqueue
  Warning: didn't use docs for ieee80211_max_queues
  Warning: didn't use docs for ieee80211_bss_change
  Warning: didn't use docs for ieee80211_bss_conf

when generating the documentation for it.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/kernel-doc-nano-HOWTO.txt
scripts/basic/docproc.c
scripts/kernel-doc