From 28594b26b3e62670a159f714b61f651cc5e02434 Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Tue, 3 Dec 2024 11:26:02 -0500 Subject: [PATCH] Modify cmake instruction in build from source (#1445) --- README.md | 2 +- docs/install/building-installing.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8783dd2f76..475c1957ed 100644 --- 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 index 4ab6fea507..da33e10761 100644 --- 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: