linux-kernel - [PATCH 0/2] docs: A couple of automarkup improvements

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-next>] [day] [month] [year] [list]

Date:   Thu, 30 Jun 2022 10:36:28 -0600
From:   Jonathan Corbet <corbet@....net>
To:     linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org,
        Nícolas F . R . A . Prado 
        <n@...aprado.net>, Jonathan Corbet <corbet@....net>
Subject: [PATCH 0/2] docs: A couple of automarkup improvements

Building the docs takes far too long.  Much of the blame for that lies with
Sphinx, but some of it is under our own control.  These two patches
eliminate a bunch of useless work in the automarkup extension.

Benchmarking Sphinx runs is hard, as the run time can be rather variable.
I have consistently found about a 15% speedup from these patches, though,
with no output changes.

Testing was done with Sphinx 4.4.0 and 5.0.2.  My systems all have Python
3.10 installed, and there does not appear, alas, to be a straightforward
way to get Sphinx 3.x to run on that version.  Versions of Sphinx prior to
3.0 will not be affected by these changes.

Jonathan Corbet (2):
  docs: automarkup: track failed cross-reference attempts
  docs: automarkup: do not look up symbols twice

 Documentation/sphinx/automarkup.py | 56 +++++++++++++++++-------------
 1 file changed, 32 insertions(+), 24 deletions(-)

-- 
2.36.1