diff --git a/hpvm/docs/build-hpvm.rst b/hpvm/docs/build-hpvm.rst index 5f9a5b9588c8f1587a7dadfdc9ac524910b29577..c2fe79754cb964e62b5deec02fdebe42adac9b4b 100644 --- a/hpvm/docs/build-hpvm.rst +++ b/hpvm/docs/build-hpvm.rst @@ -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. diff --git a/hpvm/docs/tutorials/index.rst b/hpvm/docs/tutorials/index.rst index bf9097dd861c70eaf216eac7fc399e06e8d315e4..de1cde3ccf06f0519d800edf72ecc509503c89c7 100644 --- a/hpvm/docs/tutorials/index.rst +++ b/hpvm/docs/tutorials/index.rst @@ -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>`.