qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] meson: Pass -j option to sphinx
@ 2023-04-26 16:03 Fabiano Rosas
  2023-04-27 11:58 ` Daniel P. Berrangé
  2023-04-27 12:24 ` Thomas Huth
  0 siblings, 2 replies; 5+ messages in thread
From: Fabiano Rosas @ 2023-04-26 16:03 UTC (permalink / raw)
  To: qemu-devel
  Cc: Daniel P . Berrangé, Paolo Bonzini, Marc-André Lureau,
	Peter Maydell

Save a bit of build time by passing the number of jobs option to
sphinx.

To avoid warnings from sphinx, alter our plugins to inform whether
they support parallelism. The two plugins touched are quite simple and
I don't see anything that would indicate they do not support being
called in parallel, so return True for both reads and writes.

before:
 $ time make -j16 man html
 ...
 [1/2] Generating docs/QEMU manual with a custom command
 [2/2] Generating docs/QEMU man pages with a custom command

 real    0m49.770s
 user    0m49.425s
 sys     0m0.716s

after:
 $ time make -j16 man html
 ...
 [1/2] Generating docs/QEMU manual with a custom command (wrapped by meson because command contains newlines)
 [2/2] Generating docs/QEMU man pages with a custom command (wrapped by meson because command contains newlines)
 real    0m30.153s
 user    1m5.945s
 sys     0m2.440s

Signed-off-by: Fabiano Rosas <farosas@suse.de>
---
 docs/meson.build           | 12 ++++++++++++
 docs/sphinx/fakedbusdoc.py |  5 +++++
 docs/sphinx/qmp_lexer.py   |  5 +++++
 3 files changed, 22 insertions(+)

diff --git a/docs/meson.build b/docs/meson.build
index f220800e3e..9e4bed6fa0 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -10,6 +10,18 @@ if sphinx_build.found()
     SPHINX_ARGS += [ '-W', '-Dkerneldoc_werror=1' ]
   endif
 
+  sphinx_version = run_command(SPHINX_ARGS + ['--version'],
+                               check: false).stdout().split()[1]
+  if sphinx_version.version_compare('>=5.1.2')
+    SPHINX_ARGS += ['-j', 'auto']
+  else
+    nproc = find_program('nproc')
+    if nproc.found()
+      jobs = run_command(nproc, check:false).stdout()
+      SPHINX_ARGS += ['-j', jobs]
+    endif
+  endif
+
   # This is a bit awkward but works: create a trivial document and
   # try to run it with our configuration file (which enforces a
   # version requirement). This will fail if sphinx-build is too old.
diff --git a/docs/sphinx/fakedbusdoc.py b/docs/sphinx/fakedbusdoc.py
index d2c5079046..2d2e6ef640 100644
--- a/docs/sphinx/fakedbusdoc.py
+++ b/docs/sphinx/fakedbusdoc.py
@@ -23,3 +23,8 @@ def run(self):
 def setup(app: Sphinx) -> Dict[str, Any]:
     """Register a fake dbus-doc directive with Sphinx"""
     app.add_directive("dbus-doc", FakeDBusDocDirective)
+
+    return dict(
+        parallel_read_safe = True,
+        parallel_write_safe = True
+    )
diff --git a/docs/sphinx/qmp_lexer.py b/docs/sphinx/qmp_lexer.py
index f7e4c0e198..a59de8a079 100644
--- a/docs/sphinx/qmp_lexer.py
+++ b/docs/sphinx/qmp_lexer.py
@@ -41,3 +41,8 @@ def setup(sphinx):
         sphinx.add_lexer('QMP', QMPExampleLexer)
     except errors.VersionRequirementError:
         sphinx.add_lexer('QMP', QMPExampleLexer())
+
+    return dict(
+        parallel_read_safe = True,
+        parallel_write_safe = True
+    )
-- 
2.35.3



^ permalink raw reply related	[flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-04-27 13:12 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-04-26 16:03 [PATCH] meson: Pass -j option to sphinx Fabiano Rosas
2023-04-27 11:58 ` Daniel P. Berrangé
2023-04-27 13:12   ` Fabiano Rosas
2023-04-27 12:24 ` Thomas Huth
2023-04-27 12:29   ` Daniel P. Berrangé

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).