diff options
| author | Johannes Berg <johannes.berg@intel.com> | 2010-09-12 02:55:22 +0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2010-09-12 03:49:21 +0400 |
| commit | eda603f6cdba4b14dbf80531fab2fe545232e7a0 (patch) | |
| tree | 94e88243e917d55fac8e8ca79f51ea7c8fcc45ed /Documentation/kernel-doc-nano-HOWTO.txt | |
| parent | 1f3a66889c4c80c821f3eadf899c140e91452f8e (diff) | |
| download | linux-eda603f6cdba4b14dbf80531fab2fe545232e7a0.tar.xz | |
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>
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 27a52b35d55b..3d8a97747f77 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -345,5 +345,10 @@ documentation, in <filename>, for the functions listed. section titled <section title> from <filename>. Spaces are allowed in <section title>; do not quote the <section title>. +!C<filename> is replaced by nothing, but makes the tools check that +all DOC: sections and documented functions, symbols, etc. are used. +This makes sense to use when you use !F/!P only and want to verify +that all documentation is included. + Tim. */ <twaugh@redhat.com> |