From 013543981f315b463a30a23c030ceaf38a736882 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Fri, 26 Mar 2021 13:29:06 -0500
Subject: [PATCH] Extra explanation on how installer relays CMake args
---
hpvm/docs/install.rst | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/hpvm/docs/install.rst b/hpvm/docs/install.rst
index 16bfc7f5cc..47b400d2be 100644
--- a/hpvm/docs/install.rst
+++ b/hpvm/docs/install.rst
@@ -71,11 +71,22 @@ Use HPVM installer script to download, configure and build HPVM along with LLVM
./install.sh
-
* Without arguments, this script will interactively prompt you for some parameters.
Alternatively, use ``./install.sh -h`` for a list of available arguments
and pass arguments as required.
+* ``./install.sh`` can relay additional arguments to CMake, but the dash must be dropped
+ regardless of using prompt or CLI arguments.
+ For example,
+
+ .. code-block:: shell
+
+ ./install.sh -j32 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.
+
After configuring HPVM,
the installer will also compile HPVM by default, which you can opt out of.
If you do so, follow the next section "Manually Build HPVM" to manually compile HPVM,
--
GitLab