Messages in this thread | | | Date | Thu, 26 Aug 2010 11:48:30 -0700 | From | Randy Dunlap <> | Subject | Re: [PATCH] Docbook: allow warning on unused documentation |
| |
On Thu, 26 Aug 2010 19:43:14 +0200 Johannes Berg wrote:
> From: Johannes Berg <johannes.berg@intel.com> > > 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> > --- > v2: - fix comment > - use !C instead of !A > > Documentation/kernel-doc-nano-HOWTO.txt | 5 + > scripts/basic/docproc.c | 129 +++++++++++++++++++++++++++++++- > scripts/kernel-doc | 52 ++++++++++++ > 3 files changed, 183 insertions(+), 3 deletions(-)
Applied, thanks.
--- ~Randy *** Remember to use Documentation/SubmitChecklist when testing your code ***
| |