From b2425ef68aaa1820669a9364ab5c560579340e6c Mon Sep 17 00:00:00 2001 From: Julia Jiang <56359287+jujiang-del@users.noreply.github.com> Date: Thu, 26 Aug 2021 12:19:54 -0400 Subject: [PATCH] SWDEV-291894 - update branch info in hip install/readme (#2324) Change-Id: Ie737bfbe3333973d6b42c496b23edcdc0966b9a1 --- INSTALL.md | 12 ++++++------ README.md | 5 +++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 7327a7611f..c939c34c50 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -35,7 +35,7 @@ HIP-Clang is the compiler for compiling HIP programs on AMD platform. HIP-Clang can be built manually: ``` -git clone -b rocm-4.3.x https://github.com/RadeonOpenCompute/llvm-project.git +git clone -b amd-stg-open https://github.com/RadeonOpenCompute/llvm-project.git cd llvm-project mkdir -p build && cd build cmake -DCMAKE_INSTALL_PREFIX=/opt/rocm/llvm -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=1 -DLLVM_TARGETS_TO_BUILD="AMDGPU;X86" -DLLVM_ENABLE_PROJECTS="clang;lld;compiler-rt" ../llvm @@ -45,7 +45,7 @@ sudo make install Rocm device library can be manually built as following, ``` export PATH=/opt/rocm/llvm/bin:$PATH -git clone -b rocm-4.3.x https://github.com/RadeonOpenCompute/ROCm-Device-Libs.git +git clone -b amd-stg-open https://github.com/RadeonOpenCompute/ROCm-Device-Libs.git cd ROCm-Device-Libs mkdir -p build && cd build CC=clang CXX=clang++ cmake -DLLVM_DIR=/opt/rocm/llvm -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_WERROR=1 -DLLVM_ENABLE_ASSERTIONS=1 -DCMAKE_INSTALL_PREFIX=/opt/rocm .. @@ -72,10 +72,10 @@ apt-get install hip-runtime-nvidia hip-devel ## Get HIP source code ``` -git clone -b rocm-4.4.x https://github.com/ROCm-Developer-Tools/hipamd.git -git clone -b rocm-4.4.x https://github.com/ROCm-Developer-Tools/hip.git -git clone -b rocm-4.4.x https://github.com/ROCm-Developer-Tools/ROCclr.git -git clone -b rocm-4.4.x https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime.git +git clone -b develop https://github.com/ROCm-Developer-Tools/hipamd.git +git clone -b develop https://github.com/ROCm-Developer-Tools/hip.git +git clone -b develop https://github.com/ROCm-Developer-Tools/ROCclr.git +git clone -b develop https://github.com/RadeonOpenCompute/ROCm-OpenCL-Runtime.git ``` ## Set the environment variables diff --git a/README.md b/README.md index ff292dee17..d4e16e70c7 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ The information contained herein is for informational purposes only, and is subj The HIP repository maintains several branches. The branches that are of importance are: -* Main branch: This is the stable branch. It is up to date with the latest release branch, for example, if the latest HIP release is rocm-3.9, main branch will be the repository based on this release. -* Release branches. These are branches corresponding to each ROCM release, listed with release tags, such as rocm-3.8, rocm-3.9, etc. +* develop branch: This is the default branch, on which the new features are still under development and visible. While this maybe of interest to many, it should be noted that this branch and the features under development might not be stable. +* Main branch: This is the stable branch. It is up to date with the latest release branch, for example, if the latest HIP release is rocm-4.3, main branch will be the repository based on this release. +* Release branches. These are branches corresponding to each ROCM release, listed with release tags, such as rocm-4.2, rocm-4.3, etc. ## Release tagging: