From 725d289a2b2ea551958cc3dc59d9ff59f7baf9f1 Mon Sep 17 00:00:00 2001 From: Tim Date: Tue, 1 Oct 2024 09:30:27 -0400 Subject: [PATCH] Fix Issue [SWDEV-485618]: README Outdated: Include File Changes to the README.md: -Fixed the dead links in the examples. -Updated the example to point to the ones in roctracer_spec.md instead of tests. Changes to the roctracer_spec.md: -Changed #include from #include <*.h> to #include to reflect the latest code structure. Change-Id: Iab44fc327821c1a01f0b949d3c9a3c20ca587599 --- README.md | 8 ++++---- doc/roctracer_spec.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3dc14cfc34..41afeccd65 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ To use the rocTracer API you need the API header and to link your application wi To use the rocTX API you need the API header and to link your application with `roctx` .so library: -- `/opt/rocm/roctracer/include/roctx.h` +- `/opt/rocm/include/roctracer/roctx.h` API header. @@ -52,7 +52,7 @@ To use the rocTX API you need the API header and to link your application with ` - `roctracer.h` - `rocTacer` library public API header. + `rocTracer` library public API header. - `roctx.h` @@ -87,8 +87,8 @@ To use the rocTX API you need the API header and to link your application with ` - API description: - ['roctracer' / 'rocTX' profiling C API specification](doc/roctracer_spec.md) - Code examples: - - [test/MatrixTranspose_test/MatrixTranspose.cpp](testMatrixTranspose_test/MatrixTranspose.cpp) - - [test/MatrixTranspose/MatrixTranspose.cpp](test/MatrixTranspose/MatrixTranspose.cpp) + - [HIP API ops, GPU Activity Tracing](doc/roctracer_spec.md#41-hip-api-ops-gpu-activity-tracing) + - [MatrixTranspose HIP sample with all APIs/activity tracing enabled](doc/roctracer_spec.md#42-matrixtranspose-hip-sample-with-all-apisactivity-tracing-enabled) ## Build and run tests diff --git a/doc/roctracer_spec.md b/doc/roctracer_spec.md index 4c80b6478e..7b2e1daf1d 100644 --- a/doc/roctracer_spec.md +++ b/doc/roctracer_spec.md @@ -389,7 +389,7 @@ void roctracer_stop(); ## 4. rocTracer Usage Code Examples ### 4.1. HIP API ops, GPU Activity Tracing ``` -#include +#include // HIP API callback function void hip_api_callback( @@ -609,7 +609,7 @@ int main() { ///////////////////////////////////////////////////////////////////////////// // HIP Callbacks/Activity tracing ///////////////////////////////////////////////////////////////////////////// -#include +#include // Macro to check ROC-tracer calls status #define ROCTRACER_CALL(call) \