Re: [PATCH v3] script: add a script for checking doc problems with external functions

[Mauro Carvalho Chehab]

Em Wed,  7 Oct 2020 15:31:10 +0200
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> escreveu:

> 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.



./scripts/check_docs_external_symbols drivers/gpu/drm/ took 102.04 seconds



It took more than an hour to run on a Xeon workstation for
the complete Kernel tree.

So, I'm sending a followup patch that makes it a lot better by using
one perl thread per CPU thread.

Before such patch, running this command:

	$ /usr/bin/time --format='%C took %e seconds'  ./scripts/check_docs_external_symbols drivers/gpu/drm/
	
It takes:

	./scripts/check_docs_external_symbols drivers/gpu/drm/ took 1218.96 seconds


After the patch:

	./scripts/check_docs_external_symbols drivers/gpu/drm/ took 102.04 seconds


measured on a machine with a machine with a Xeon(R) W-2133 CPU @ 3.60GHz
(12 CPU threads), with normal HDD.

> Suggested-by: Matthew Wilcox <willy@xxxxxxxxxxxxx>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Thanks,
Mauro