From 0e7f9444e8c8bf6a47e8c98dee4a37aa98a36dfe Mon Sep 17 00:00:00 2001 From: Gopesh Bhardwaj Date: Wed, 11 Sep 2024 15:09:21 +0530 Subject: [PATCH] Update git clone URL + few documentation fixes (#1066) --- README.md | 7 +++++-- source/docs/install/installation.md | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ea4331..a83678f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # ROCprofiler-SDK: Application Profiling, Tracing, and Performance Analysis > [!NOTE] -Note: rocprofiler-sdk is currently considered a beta version and is subject to change in future releases +rocprofiler-sdk is currently considered a beta version and is subject to change in future releases ## Overview -ROCProfiler-SDK is AMD’s new and improved tooling infrastructure, providing a hardware-specific low-level performance analysis interface for profiling and tracing GPU compute applications. To see what's changed [Click Here](source/docs/what-is-rocprof-sdk.rst) +ROCProfiler-SDK is AMD’s new and improved tooling infrastructure, providing a hardware-specific low-level performance analysis interface for profiling and tracing GPU compute applications. To see what's changed [Click Here](source/docs/conceptual/comparing-with-legacy-tools.rst) + +> [!NOTE] +> The published documentation is available at [ROCprofiler-SDK documentation](https://rocm.docs.amd.com/projects/rocprofiler-sdk/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the `rocprofiler-sdk/source/docs` folder of this repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html). ## GPU Metrics diff --git a/source/docs/install/installation.md b/source/docs/install/installation.md index 42e8ec2..88007ac 100644 --- a/source/docs/install/installation.md +++ b/source/docs/install/installation.md @@ -45,7 +45,7 @@ export PATH=${HOME}/.local/bin:${PATH} ## Building ROCprofiler-SDK ```bash -git clone https://git@github.com:ROCm/rocprofiler-sdk.git rocprofiler-sdk-source +git clone https://github.com/ROCm/rocprofiler-sdk.git rocprofiler-sdk-source cmake \ -B rocprofiler-sdk-build \ -D ROCPROFILER_BUILD_TESTS=ON \