niklas/tracetools_analysis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'update-readme' into 'master'

Browse source 
Mention branches vs distro

See merge request ros-tracing/tracetools_analysis!118
This commit is contained in:
Christophe Bedard 2022-05-07 14:54:48 +00:00
commit 9c853b27fc
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -5,6 +5,8 @@
Analysis tools for [ROS 2 tracing](https://gitlab.com/ros-tracing/ros2_tracing). Analysis tools for [ROS 2 tracing](https://gitlab.com/ros-tracing/ros2_tracing).
**Note**: make sure to use the right branch, depending on the ROS 2 distro: [use `master` for Rolling, `galactic` for Galactic, etc.](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#branches)
## Trace analysis ## Trace analysis
After generating a trace (see [`ros2_tracing`](https://gitlab.com/ros-tracing/ros2_tracing#tracing)), we can analyze it to extract useful execution data. After generating a trace (see [`ros2_tracing`](https://gitlab.com/ros-tracing/ros2_tracing#tracing)), we can analyze it to extract useful execution data.
@ -13,7 +15,7 @@ After generating a trace (see [`ros2_tracing`](https://gitlab.com/ros-tracing/ro
Then we can process a trace to create a data model which could be queried for analysis. Then we can process a trace to create a data model which could be queried for analysis.
``` ```shell
$ ros2 trace-analysis process /path/to/trace/directory $ ros2 trace-analysis process /path/to/trace/directory
``` ```