Merge branch '94-document-rebuild-to-trace' into 'master'

Mention needing to install LTTng and re-build if using Debians

See merge request micro-ROS/ros_tracing/ros2_tracing!177
This commit is contained in:
Christophe Bedard 2020-05-19 08:39:18 +00:00
commit 626214e883

View file

@ -6,6 +6,8 @@ Tracing tools for ROS 2.
## Building ## Building
As of Foxy, these instructions also apply to an installation from the Debian packages; it will not work out-of-the-box. Also, note that tracing using `ros2_tracing` is not supported on non-Linux systems.
If LTTng is not found during build, or if the [`TRACETOOLS_DISABLED` option is enabled](#disabling-tracing), then this package will not do anything. If LTTng is not found during build, or if the [`TRACETOOLS_DISABLED` option is enabled](#disabling-tracing), then this package will not do anything.
To enable tracing: To enable tracing:
@ -16,7 +18,7 @@ To enable tracing:
$ sudo apt-get install lttng-tools lttng-modules-dkms liblttng-ust-dev $ sudo apt-get install lttng-tools lttng-modules-dkms liblttng-ust-dev
$ sudo apt-get install python3-babeltrace python3-lttng $ sudo apt-get install python3-babeltrace python3-lttng
``` ```
2. Build 2. Build (at least up to `rcl` & `rclcpp`):
``` ```
$ colcon build $ colcon build
``` ```