From 3eb01da28d6a91e8b09062e322f98cd99a5e8ad9 Mon Sep 17 00:00:00 2001 From: Ammar ELWazir Date: Fri, 17 Oct 2025 15:48:48 -0500 Subject: [PATCH] [ROCProfiler-SDK] [ROCProfiler-Register] Adding Correct Installation steps (#1150) * Adding Correct Installation steps * Update projects/rocprofiler-sdk/source/docs/install/installation.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update projects/rocprofiler-sdk/source/docs/install/installation.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- projects/rocprofiler-register/README.md | 24 +++++++------- .../source/docs/install/installation.rst | 33 +++++++++++++++++++ 2 files changed, 44 insertions(+), 13 deletions(-) diff --git a/projects/rocprofiler-register/README.md b/projects/rocprofiler-register/README.md index 227b3e4475..8bcfef23d5 100644 --- a/projects/rocprofiler-register/README.md +++ b/projects/rocprofiler-register/README.md @@ -26,9 +26,9 @@ etc. ## Contributing -The default branch is `amd-mainline` but the only branch that should target that branch in a pull requests is the `amd-staging` branch. +The default branch is `develop`. -> _**All pull-requests should target the `amd-staging` branch**_ +> _**All pull-requests should target the `develop` branch**_ ### Creating a feature branch @@ -36,26 +36,24 @@ The default branch is `amd-mainline` but the only branch that should target that # fetch any updates git fetch origin -# switch to staging branch -git checkout amd-staging +# switch to development branch +git checkout develop -# update your copy of the staging branch +# update your copy of the development branch git pull --rebase -# create your feature branch off of amd-staging +# create your feature branch off of develop branch git checkout -b ``` -In the event, your local clone of the repo has a `amd-staging` branch that diverges from the upstream branch, -do a hard reset of your local branch to match the upstream branch: `git reset --hard origin/amd-staging`. -Theoretically, you should never need to do this for `amd-mainline` but this can be applied to that -branch as well. +In the event, your local clone of the repo has a `develop` branch that diverges from the upstream branch, +do a hard reset of your local branch to match the upstream branch: `git reset --hard origin/develop`. -### Pulling in updates to `amd-staging` to your feature branch +### Pulling in updates to `develop` to your feature branch -Linear histories are preferred so if another PR is merged into `amd-staging` while your PR is still open, please +Linear histories are preferred so if another PR is merged into `develop` while your PR is still open, please select the "Update with rebase" option (i.e. try to avoid a merge commit). From the command line, the git command -would be `git pull --rebase origin amd-staging`. +would be `git pull --rebase origin develop`. ## Build and Installation diff --git a/projects/rocprofiler-sdk/source/docs/install/installation.rst b/projects/rocprofiler-sdk/source/docs/install/installation.rst index 38615ae8c4..0bc2c49a56 100644 --- a/projects/rocprofiler-sdk/source/docs/install/installation.rst +++ b/projects/rocprofiler-sdk/source/docs/install/installation.rst @@ -34,6 +34,38 @@ The relevant fields are ``ID`` and the ``VERSION_ID``. Build requirements ------------------ +Install the following dependencies: + +- Debian/Ubuntu +.. code-block:: bash + + sudo apt install -y libdw-dev libsqlite3-dev + +- Red Hat Enterprise Linux/Alma Linux/Rocky Linux/Fedora + +.. code-block:: bash + + sudo dnf install elfutils elfutils-devel sqlite-devel clang-tools-extra gcc gcc-c++ cmake make openssl-devel + python3 -m pip install --upgrade pip + python3 -m pip install scikit-build + +- SUSE Linux Enterprise Server + +.. code-block:: bash + + sudo zypper install gcc12 gcc12-c++ cmake make python3-devel elfutils sqlite3-devel libelf-devel libdw-devel + export CXX=/usr/bin/g++-12 + export CC=/usr/bin/gcc-12 + +.. note:: + The above ``export`` statements set the compiler environment variables only for the current terminal session. If you open a new terminal or log out, these variables will be unset. To make these settings permanent, add the following lines to your ``~/.bashrc`` file: + + .. code-block:: bash + + export CXX=/usr/bin/g++-12 + export CC=/usr/bin/gcc-12 + + Alternatively, ensure these variables are set before building ROCprofiler-SDK. To build ROCprofiler-SDK, install ``CMake`` as explained in the following section. Install CMake @@ -59,6 +91,7 @@ Building ROCprofiler-SDK from source git sparse-checkout init --cone git sparse-checkout set projects/rocprofiler-sdk git checkout develop + python3 -m pip install -r projects/rocprofiler-sdk/requirements.txt cmake \ -B rocprofiler-sdk-build \ -DCMAKE_INSTALL_PREFIX=/opt/rocm \