From 608ae8517d957e115b50892e12abfcd22726ec25 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Wed, 4 Mar 2020 08:53:19 -0800 Subject: [PATCH] Mention command for disabling tracing when building Signed-off-by: Christophe Bedard --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 458c653..61c7311 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,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.