From 587bd81d292ea34f401dc2cc1a9ab2fe706c23e6 Mon Sep 17 00:00:00 2001 From: Fei Zheng <44449748+feizheng10@users.noreply.github.com> Date: Wed, 27 Sep 2023 13:43:06 -0600 Subject: [PATCH] A few fixes for the document (#302) a few doc fixes [ROCm/rocprofiler-systems commit: f88614dbcda868982bf3bab505e6c3332770dc92] --- projects/rocprofiler-systems/source/docs/causal_profiling.md | 4 +++- projects/rocprofiler-systems/source/docs/critical_trace.md | 2 +- projects/rocprofiler-systems/source/docs/output.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/projects/rocprofiler-systems/source/docs/causal_profiling.md b/projects/rocprofiler-systems/source/docs/causal_profiling.md index b44e531fa4..7268d1f56d 100644 --- a/projects/rocprofiler-systems/source/docs/causal_profiling.md +++ b/projects/rocprofiler-systems/source/docs/causal_profiling.md @@ -22,6 +22,8 @@ Consider the following C++ code executing `foo` and `bar` concurrently in two di where `foo` is 30% faster than `bar` (ideally): ```cpp +#include +#include constexpr size_t FOO_N = 7 * 1000000000UL; constexpr size_t BAR_N = 10 * 1000000000UL; @@ -37,7 +39,7 @@ void bar() int main() { - auto _threads = { std::thread{ foo }, + std::thread _threads[] = { std::thread{ foo }, std::thread{ bar } }; for(auto& itr : _threads) diff --git a/projects/rocprofiler-systems/source/docs/critical_trace.md b/projects/rocprofiler-systems/source/docs/critical_trace.md index 17466a3c08..f6777a8144 100644 --- a/projects/rocprofiler-systems/source/docs/critical_trace.md +++ b/projects/rocprofiler-systems/source/docs/critical_trace.md @@ -13,7 +13,7 @@ The steps for generating a critical trace are: 1. Enable the `OMNITRACE_CRITICAL_TRACE` setting 2. Configure any other relevant critical-trace settings, as needed - - `omnitrace-avail --categories settings::critical-trace` + - `omnitrace-avail --categories settings::critical_trace` 3. Execute application 4. Locate the JSON files with `call-chain` in their name 5. Provide these files to the `omnitrace-critical-trace` executable diff --git a/projects/rocprofiler-systems/source/docs/output.md b/projects/rocprofiler-systems/source/docs/output.md index efd5d8a2cc..df8bd88d4d 100644 --- a/projects/rocprofiler-systems/source/docs/output.md +++ b/projects/rocprofiler-systems/source/docs/output.md @@ -314,7 +314,7 @@ settings will be ignored. Visit [ui.perfetto.dev](https://ui.perfetto.dev) and o Use `omnitrace-avail --components --filename` to view the base filename for each component. E.g. ```shell -$ ./omnitrace-avail wall_clock -C -f +$ omnitrace-avail wall_clock -C -f |---------------------------------|---------------|------------------------| | COMPONENT | AVAILABLE | FILENAME | |---------------------------------|---------------|------------------------|