From 7231808c58367b490bd76f6c54a52616d50bf3cf Mon Sep 17 00:00:00 2001 From: corey-derochie-amd <161367113+corey-derochie-amd@users.noreply.github.com> Date: Fri, 27 Sep 2024 11:07:16 -0600 Subject: [PATCH] Checkout submodules with shallow depth (#1353) * Make submodules shallow * Updated README for the shallow checkout changes. --- .gitmodules | 2 ++ README.md | 7 +++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitmodules b/.gitmodules index 43f5bd06a7..eae2c515ce 100644 --- a/.gitmodules +++ b/.gitmodules @@ -2,7 +2,9 @@ path = ext-src/mscclpp url = https://github.com/microsoft/mscclpp.git ignore = dirty + shallow = true [submodule "ext-src/json"] path = ext-src/json url = https://github.com/nlohmann/json.git ignore = dirty + shallow = true diff --git a/README.md b/README.md index 2fe91d0a55..b266ab96aa 100644 --- a/README.md +++ b/README.md @@ -68,17 +68,16 @@ By default, RCCL builds for all GPU targets defined in `DEFAULT_GPUS` in `CMakeL ### To build the library using CMake: ```shell -$ git clone https://github.com/ROCm/rccl.git --recurse-submodules +$ git clone --recursive https://github.com/ROCm/rccl.git $ cd rccl $ mkdir build $ cd build $ cmake .. $ make -j 16 # Or some other suitable number of parallel jobs ``` -If you have already cloned, you can checkout the `mscclpp` submodule manually. +If you have already cloned, you can checkout the external submodules manually. ```shell -$ cd ext-src/mscclpp -$ git submodule update --init --recursive +$ 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