diff --git a/README.md b/README.md index 458c653..861e277 100644 --- a/README.md +++ b/README.md @@ -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,9 +26,17 @@ 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. +The steps above will not lead to trace data being generated, and thus they will have no impact on execution. LTTng has to be configured for tracing. The packages in this repo provide two options. ### Trace command