[ROCProfiler SDK] Updating README Building & Installing Instructions (#931)

* Updating ROCProfiler SDK README

* Fixing ROCProfiler SDK License

* Fixing ROCProfiler SDK Installation Steps

---------

Co-authored-by: Joseph Macaranas <145489236+jayhawk-commits@users.noreply.github.com>
This commit is contained in:
Ammar ELWazir
2025-09-11 01:38:49 -05:00
gecommit door GitHub
bovenliggende 5b9ba5bda0
commit 069d5ecce2
7 gewijzigde bestanden met toevoegingen van 21 en 16 verwijderingen
@@ -21,7 +21,6 @@ trigger:
- ISSUE_TEMPLATE - ISSUE_TEMPLATE
- '*.md' - '*.md'
- CODEOWNERS - CODEOWNERS
- LICENSE
pr: pr:
autoCancel: true autoCancel: true
@@ -35,7 +34,6 @@ pr:
- ISSUE_TEMPLATE - ISSUE_TEMPLATE
- '*.md' - '*.md'
- CODEOWNERS - CODEOWNERS
- LICENSE
drafts: false drafts: false
jobs: jobs:
+6 -2
Bestand weergeven
@@ -61,12 +61,16 @@ It can be set by the user in different locations if needed.
## Build and Installation ## Build and Installation
```bash ```bash
git clone https://github.com/ROCm/rocprofiler-sdk.git rocprofiler-sdk-source git clone --no-checkout --filter=blob:none https://github.com/ROCm/rocm-systems.git
cd rocm-systems
git sparse-checkout init --cone
git sparse-checkout set projects/rocprofiler-sdk
git checkout develop
cmake \ cmake \
-B rocprofiler-sdk-build \ -B rocprofiler-sdk-build \
-DCMAKE_INSTALL_PREFIX=/opt/rocm \ -DCMAKE_INSTALL_PREFIX=/opt/rocm \
-DCMAKE_PREFIX_PATH=/opt/rocm \ -DCMAKE_PREFIX_PATH=/opt/rocm \
rocprofiler-sdk-source projects/rocprofiler-sdk
cmake --build rocprofiler-sdk-build --target all --parallel $(nproc) cmake --build rocprofiler-sdk-build --target all --parallel $(nproc)
``` ```
@@ -6,19 +6,19 @@ include(CMakePackageConfigHelpers)
set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME development) set(CMAKE_INSTALL_DEFAULT_COMPONENT_NAME development)
install( install(
FILES ${PROJECT_SOURCE_DIR}/LICENSE FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME} DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}
COMPONENT core) COMPONENT core)
if(ROCPROFILER_BUILD_DOCS) if(ROCPROFILER_BUILD_DOCS)
install( install(
FILES ${PROJECT_SOURCE_DIR}/LICENSE FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}-docs DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}-docs
COMPONENT docs) COMPONENT docs)
endif() endif()
install( install(
FILES ${PROJECT_SOURCE_DIR}/LICENSE FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}-tests DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}-tests
COMPONENT tests) COMPONENT tests)
@@ -101,6 +101,6 @@ set(${PACKAGE_NAME}_DIR
CACHE PATH "${PACKAGE_NAME} build tree install" FORCE) CACHE PATH "${PACKAGE_NAME} build tree install" FORCE)
install( install(
FILES ${PROJECT_SOURCE_DIR}/LICENSE FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME} DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}
COMPONENT rocpd) COMPONENT rocpd)
@@ -101,6 +101,6 @@ set(${PACKAGE_NAME}_DIR
CACHE PATH "${PACKAGE_NAME} build tree install" FORCE) CACHE PATH "${PACKAGE_NAME} build tree install" FORCE)
install( install(
FILES ${PROJECT_SOURCE_DIR}/LICENSE FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME} DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/${PACKAGE_NAME}
COMPONENT roctx) COMPONENT roctx)
@@ -68,15 +68,18 @@ Building ROCprofiler-SDK from source
.. code-block:: bash .. code-block:: bash
git clone https://github.com/ROCm/rocprofiler-sdk.git rocprofiler-sdk-source git clone --no-checkout --filter=blob:none https://github.com/ROCm/rocm-systems.git
cd rocm-systems
git sparse-checkout init --cone
git sparse-checkout set projects/rocprofiler-sdk
git checkout develop
cmake \ cmake \
-B rocprofiler-sdk-build \ -B rocprofiler-sdk-build \
-D ROCPROFILER_BUILD_TESTS=ON \ -DCMAKE_INSTALL_PREFIX=/opt/rocm \
-D ROCPROFILER_BUILD_SAMPLES=ON \ -DCMAKE_PREFIX_PATH=/opt/rocm \
-D CMAKE_INSTALL_PREFIX=/opt/rocm \ projects/rocprofiler-sdk
rocprofiler-sdk-source
cmake --build rocprofiler-sdk-build --target all --parallel 8 cmake --build rocprofiler-sdk-build --target all --parallel $(nproc)
Installing ROCprofiler-SDK Installing ROCprofiler-SDK
--------------------------- ---------------------------
@@ -2,4 +2,4 @@
License License
======= =======
.. include:: ../../LICENSE .. include:: ../../LICENSE.md