From a6cc9fe188c0bacc5281b5fe3381720b924f3144 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Sat, 7 May 2022 10:54:10 -0400 Subject: [PATCH] Mention branches vs distro Signed-off-by: Christophe Bedard --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 522d3bb..2c3ef6c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ 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 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. -``` +```shell $ ros2 trace-analysis process /path/to/trace/directory ```