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

Merge branch 'update-readme' into 'master'

Browse source 
Update readme

See merge request micro-ROS/ros_tracing/tracetools_analysis!44
This commit is contained in:
Christophe Bedard 2020-01-01 02:49:57 +00:00
commit dc27e43d35
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -44,8 +44,8 @@ from tracetools_analysis import loading
from tracetools_analysis import processor
from tracetools_analysis import utils
# Load converted trace file
events = loading.load_file('/path/to/converted/file')
# Load trace directory or converted trace file
events = loading.load_file('/path/to/trace/or/converted/file')
# Process
ros2_handler = processor.Ros2Handler()
@ -67,4 +67,4 @@ time_per_thread = cpu_util.get_time_per_thread()
## Design
See the [`ros2_tracing` design document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md), especially the [*Goals and requirements*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#goals-and-requirements) and [*Analysis architecture*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis-architecture) sections.
See the [`ros2_tracing` design document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md), especially the [*Goals and requirements*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#goals-and-requirements) and [*Analysis*](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/blob/master/doc/design_ros_2.md#analysis) sections.