Modify cmake instruction in build from source (ROCm#1445)

(cherry picked from commit 28594b2)
amd-jnovotny · Dec 6, 2024 · 6dd78bd · 6dd78bd
1 parent 6729d9e
commit 6dd78bd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ $ git submodule update --init --recursive --depth=1
 ```
 You may substitute an installation path of your own choosing by passing `CMAKE_INSTALL_PREFIX`. For example:
 ```shell
-$ cmake -DCMAKE_INSTALL_PREFIX=$PWD/rccl-install ..
+$ cmake -DCMAKE_INSTALL_PREFIX=$PWD/rccl-install -DCMAKE_BUILD_TYPE=Release ..
 ```
 Note: ensure rocm-cmake is installed, `apt install rocm-cmake`.
 

diff --git a/docs/install/building-installing.rst b/docs/install/building-installing.rst
@@ -45,11 +45,12 @@ to ``CMAKE_INSTALL_PREFIX``, for example:
 
 .. code-block:: shell
 
-    cmake -DCMAKE_INSTALL_PREFIX=$PWD/rccl-install ..
+    cmake -DCMAKE_INSTALL_PREFIX=$PWD/rccl-install -DCMAKE_BUILD_TYPE=Release ..
 
 .. note::
 
-    Ensure ROCm CMake is installed using the command ``apt install rocm-cmake``.
+    Ensure ROCm CMake is installed using the command ``apt install rocm-cmake``. By default,
+    CMake builds the component in debug mode unless ``DCMAKE_BUILD_TYPE`` is specified.
 
 
 Building the RCCL package and install package: