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

Fix tools description

Browse source
This commit is contained in:
Christophe Bedard 2019-08-09 10:13:10 +02:00
parent 258be60e62
commit b4a65e0fb0
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/design_ros_2.md
View file

@ -555,27 +555,25 @@ We could look into making analyses work on both ROS 1 and ROS 2, through a commo
* wraps the LTTng Python bindings to setup and start a tracing session * wraps the LTTng Python bindings to setup and start a tracing session
* exposes simplified setup functions with default values * exposes simplified setup functions with default values
* provides an example `trace` entrypoint for tracing * provides an example `trace` entrypoint for tracing
```shell `$ ros2 run tracetools_trace trace`
$ ros2 run tracetools_trace trace
```
* `ros2trace` * `ros2trace`
* provides a `ros2cli` extension * provides a `ros2cli` extension
`$ ros2 trace`
* uses `tracetools_trace` functions * uses `tracetools_trace` functions
* `tracetools_launch` * `tracetools_launch`
* provides a `Trace` action for `launch` * provides a `Trace` action for `launch`
* uses `tracetools_trace` functions * uses `tracetools_trace` functions
* `tracetools_read` * `tracetools_read`
* wraps the `babeltrace` Python bindings to read CTF traces * wraps the babeltrace Python bindings to read CTF traces
* `tracetools_test` * `tracetools_test`
* provides a `TraceTestCase` class extending `unittest.TestCase` * provides a `TraceTestCase` class extending `unittest.TestCase`
* uses the `Trace` action with `launch` to trace the test nodes * uses the `Trace` action with `launch` to trace the test nodes
* provides utility functions (e.g. assertion) * provides trace-specific utility functions (e.g. assert)
* `tracetools_analysis` * `tracetools_analysis`
* uses `tracetools_read` to read traces * uses `tracetools_read` to read traces
* provides utilities to: * provides utilities to:
* convert CTF traces to pickle files * convert CTF traces to pickle files
* wrap trace events in a Python `dict` * wrap trace events in Python `dict`
* handle and process trace events to gather data * handle and process trace events to gather data
## Analysis architecture ## Analysis architecture