diff --git a/doc/tracing-perfetto.md b/doc/tracing-perfetto.md index e4e1c8b96..8882bce25 100644 --- a/doc/tracing-perfetto.md +++ b/doc/tracing-perfetto.md @@ -1,20 +1,23 @@ # Tracing with Perfetto {#tracing-perfetto} ## Requirements -Monado uses the [Perfetto][]/[Percetto][] framework for tracining support, you +Monado uses the [Perfetto][]/[Percetto][] framework for tracing support. You need to first build and install [Percetto][] in a place where CMake can find it. -Build [Perfetto][] (you will have gotten the source at least as part of build +Build [Perfetto][] (you will have gotten the source at least as part of build [Percetto][]). It is a good idea to familiarise yourself with Perfetto before -proceeding. You then need to build Monado with CMake and give make sure +proceeding. You then need to build Monado with CMake and make sure `XRT_FEATURE_TRACING` is enabled. -* Build and install [Percetto][]. +* Build and install [Percetto][] - **note** Depending on the version of Percetto + you are using you might need to have a release version of Perfetto available + or use the one that is included in percetto. A release version of Perfetto is + needed due to the `sdk/` directory and amalgamated files is only made there. * Build and get [Perfetto][] running. * Build Monado with CMake and with `XRT_FEATURE_TRACING` being `ON`. @@ -24,7 +27,7 @@ Save the following file to `data_events.cfg`, next to your perfetto folder. Please refer to [Perfetto][] documentation about the format and options of this config file, but the most important bits is the `tracker_event` section. -```c +```none flush_period_ms: 30000 incremental_state_config { diff --git a/doc/tracing-tracy.md b/doc/tracing-tracy.md index eb5099e39..d2c228aa5 100644 --- a/doc/tracing-tracy.md +++ b/doc/tracing-tracy.md @@ -1,7 +1,7 @@ # Tracing with Tracy {#tracing-tracy} @@ -21,7 +21,7 @@ is also required, but the order doesn't matter. Start the [Tracy][] profiler, either try to connect directly to the host you want to run Monado on, or wait for it to show up in the first initial UI. Then -run Monado like you normally would, for example like below. +run Monado like you normally would, for example as follows. ```bash monado-serivce @@ -30,8 +30,8 @@ monado-serivce ## Notes Unlike @ref tracing-perfetto Tracy supports Windows, it also supports live -viewing of the data stream. But Tracy can only trace on application at a time -where as Perfetto can do multiple processes at the same time and whole system -tracing giving a higher level overview of the whole system. +viewing of the data stream. But Tracy can only trace one application at a time, +whereas Perfetto can do multiple processes at the same time and whole system +tracing, giving a higher level overview of the whole system. [Tracy]: https://github.com/wolfpld/tracy