linux-kernel - Re: [PATCH] docs: net: 80211: reduce docs build time

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <81ebd41b4f39c78867949e6453b2fb58e69ed48d.camel@sipsolutions.net>
Date:   Thu, 08 Oct 2020 10:42:29 +0200
From:   Johannes Berg <johannes@...solutions.net>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     linux-kernel@...r.kernel.org, linux-wireless@...r.kernel.org
Subject: Re: [PATCH] docs: net: 80211: reduce docs build time

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