Re: [PATCH] docs: net: 80211: reduce docs build time
From: Johannes Berg
Date: Thu Oct 08 2020 - 04:42:39 EST
On Mon, 2020-10-05 at 11:38 +0200, Mauro Carvalho Chehab wrote:
> the files under /80211 calls kernel-doc script 207 times, one for each
> single function and doc chapter. Due to that, it takes a lot of time
> handling it:
>
> $ touch Documentation/driver-api/80211/*rst && time make SPHINXDIRS=driver-api/80211 htmldocs
> ...
> real 0m22,928s
> user 0m21,644s
> sys 0m1,334s
>
> Reduce the build time by doing only one kernel-doc call
> per functions that belong to the same group. With that, there's now
> 50 calls to kernel-doc, which makes the build time for those docs
> 62% faster:
>
> $ touch Documentation/driver-api/80211/*rst && time make SPHINXDIRS=driver-api/80211 htmldocs
> ...
> real 0m8,666s
> user 0m8,084s
> sys 0m0,642s
>
> As a side effect, it should now be easier to add newer
> functions, as there's no need to repeat the kernel-doc
> pattern.
Thanks, I'll apply this.
I wasn't even aware of that syntax ...
johannes