From 0a1bd872a251c6d47d33df3d553c26e9d396f20c Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Tue, 6 Jun 2023 00:15:34 +0200 Subject: [PATCH] Document `-j auto` in Building the manual --- contributing/documentation/building_the_manual.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/contributing/documentation/building_the_manual.rst b/contributing/documentation/building_the_manual.rst index 732d17f2d5b..4ac1d5059b4 100644 --- a/contributing/documentation/building_the_manual.rst +++ b/contributing/documentation/building_the_manual.rst @@ -154,6 +154,11 @@ If you have at least 16 GB of RAM, you can speed up compilation by running: make html SPHINXOPTS=-j2 +You can use ``-j auto`` to use all available CPU threads, but this can use a lot +of RAM if you have a lot of CPU threads. For instance, on a system with 32 CPU +threads, ``-j auto`` (which corresponds to ``-j 32`` here) can require 20+ GB of +RAM for Sphinx alone. + Specifying a list of files ^^^^^^^^^^^^^^^^^^^^^^^^^^