Skip to content

Commit

Permalink
a few doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
feizheng10 authored and jrmadsen committed Sep 27, 2023
1 parent 0d84a35 commit de6c73b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion source/docs/causal_profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cstddef>
#include <thread>
constexpr size_t FOO_N = 7 * 1000000000UL;
constexpr size_t BAR_N = 10 * 1000000000UL;

Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion source/docs/critical_trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|---------------------------------|---------------|------------------------|
Expand Down

0 comments on commit de6c73b

Please sign in to comment.