Skip to content
Snippets Groups Projects
Commit e34137f7 authored by Aaron Councilman's avatar Aaron Councilman
Browse files

Remove hard-coded thread numbers for building, document RAM requirements

parent 583c7ffa
No related branches found
No related tags found
No related merge requests found
......@@ -155,11 +155,13 @@ The HPVM installer script can be used to automatically download extra components
.. code-block:: shell
./install.sh -j32 DCMAKE_BUILD_TYPE=Release
./install.sh -j<n> DCMAKE_BUILD_TYPE=Release
will compile HPVM with 32 threads in Release mode; similarly, inputting
``DCMAKE_BUILD_TYPE=Release`` to the prompt will also send ``-DCMAKE_BUILD_TYPE=Release``
to CMake which gives a build in Release mode.
will compile HPVM in Release mode. In this, ```<n>``` should be replaced by
the number of threads to build with. Note that HPVM requires nearly 16 GB of
RAM to build single-threaded and the usage increases (though not linearly) as
the number of threads is increased. If you encounter Out of Memory or similar
errors during compilation, try decreasing the number of threads.
After configuring HPVM,
the installer will also compile HPVM by default, which you can opt out of.
......
......@@ -18,9 +18,14 @@ Next, build hpvm using the provided installer as follows:
.. code-block:: shell
./install.sh -j32 DCMAKE_BUILD_TYPE=Release
./install.sh -j<n> DCMAKE_BUILD_TYPE=Release
This script will download the required LLVM release and build HPVM.
In this, ```<n>``` should be replaced with the number of threads to build with.
Note that HPVM requires nearly 16 GB of RAM to build single-threaded and this
increases (though not linearly) as the number of threads is increased. If you
encounter Out of Memory or similar errors during compilation, try decreasing
the number of threads.
For more details on building HPVM, check out the :doc:`detailed build instructions <../build-hpvm>`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment