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

Mention command for disabling tracing when building

Browse source 
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
This commit is contained in:
Christophe Bedard 2020-03-04 08:53:19 -08:00
parent 0125b73895
commit 608ae8517d
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -6,7 +6,7 @@ Tracing tools for ROS 2.
## Building
If the `TRACETOOLS_DISABLED` option is enabled during build or if LTTng is not found, 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:
@ -26,6 +26,14 @@ To enable tracing:
$ ros2 run tracetools status
```
### Disabling tracing
Alternatively, to build and disable tracing, use `TRACETOOLS_DISABLED`:
```
$ colcon build --cmake-args " -DTRACETOOLS_DISABLED=ON"
```
## Tracing
The steps above will not lead to trace data being generated, and thus they will have no impact on execution. LTTng has to be enabled. The packages in this repo provide two options.