Messages in this thread | | | Date | Wed, 7 Oct 2020 15:38:54 +0200 | From | Mauro Carvalho Chehab <> | Subject | Re: [PATCH RFC] script: add a script for checking doc problems with external functions |
| |
Em Wed, 07 Oct 2020 01:32:31 -0700 Joe Perches <joe@perches.com> escreveu:
> On Wed, 2020-10-07 at 11:23 +0300, Jani Nikula wrote: > > On Tue, 06 Oct 2020, Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > > While not all EXPORT_SYMBOL*() symbols should be documented, > > > it seems useful to have a tool which would help to check what > > > symbols aren't documented. > > > > > > This is a first step on this direction. The tool has some > > > limitations. Yet, it could be useful for maintainers to check > > > about missing documents on their subsystems. > > > > Seems like this should be part of checkpatch.pl somehow. > > I don't see how.
Just sent a third version of the script. It should now be able to check if the RST files have the exported symbols as well:
<snip> $ scripts/check_docs_external_symbols lib/debugobjects.c lib/debugobjects.c: export symbol debug_object_active_state not documented at: Documentation/core-api/debug-objects.rst </snip>
It also checks if an exported symbol has duplicated entries at kernel-doc as well.
The check logic for it is somewhat complex. so, I won't doubt that there are some other hidden bugs.
Also, as right now, the script is slow, if one wants to run it for the entire Kernel.
Thanks, Mauro
| |