From de6c73b9ad79c7fcb68bf214310106210fefebcf Mon Sep 17 00:00:00 2001 From: "fei.zheng" Date: Thu, 17 Aug 2023 14:08:11 -0600 Subject: [PATCH] a few doc fixes --- source/docs/causal_profiling.md | 4 +++- source/docs/critical_trace.md | 2 +- source/docs/output.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/source/docs/causal_profiling.md b/source/docs/causal_profiling.md index b44e531fa..7268d1f56 100644 --- a/source/docs/causal_profiling.md +++ b/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/source/docs/critical_trace.md b/source/docs/critical_trace.md index 17466a3c0..f6777a814 100644 --- a/source/docs/critical_trace.md +++ b/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/source/docs/output.md b/source/docs/output.md index efd5d8a2c..df8bd88d4 100644 --- a/source/docs/output.md +++ b/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 | |---------------------------------|---------------|------------------------|