Port the ros2_tracing page from ros-realtime documentation to primary documentation #3621

nightduck · 2023-05-16T23:45:19Z

This PR will be accompanied with a corresponding PR in https://github.com/ros-realtime/ros-realtime.github.io to replace the old page with a redirect link

This applies to Rolling and Iron only, since Humble doesn't include tracing instrumentation by default.

nightduck · 2023-05-16T23:45:53Z

@christophebedard

christophebedard

Thanks for porting the tutorial!

My main comment would be to switch to one sentence per line. As for updating the tutorial now that the tracing instrumentation is included by default/now that we don't need to re-build ROS 2 from source anymore, we could do that in a separate PR, since this tutorial is still valid for Humble and older. I can take care of this update.

source/Tutorials/Advanced/ros2_tracing_trace_and_analyze.rst

christophebedard · 2023-06-23T16:56:10Z

@nightduck are you planning on addressing my comments, or do you want me to do it?

nightduck · 2023-06-23T18:26:32Z

@christophebedard I'll schedule a block of time to do it on Monday. If you want to do it yourself before then, I won't stop you.

source/Tutorials/Advanced/ros2_tracing_trace_and_analyze.rst

Signed-off-by: Jan Staschulat <[email protected]>

source/Tutorials/Advanced/ros2_tracing_trace_and_analyze.rst

source/Tutorials/Advanced/images/rtwg_image.png

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst

christophebedard

Thank you for porting this and for iterating!

christophebedard · 2023-06-29T18:53:46Z

@clalancette do you want to take a look, since I wrote most of this?

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst

nightduck · 2023-07-01T16:21:18Z

I'm going on vacation for a week (literally hopping in the car now), but I'll address these new changes on Monday the 10th, as well as testing the changes @clalamcette mentioned to ensure the tutorial still works

…

On Sat, Jul 1, 2023, 11:16 AM Christophe Bedard ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst <#3621 (comment)> : > +Prerequisites +------------- + +This guide is aimed at real-time systems. +See the :doc:`real-time system setup guide <../Miscellaneous/Building-Realtime-rt_preempt-kernel-for-ROS-2>`. +However, the guide will work if you are using a non-real-time system. + +.. note:: + + This guide was written for ROS 2 Rolling on Ubuntu 22.04. + It should work on other ROS 2 distros or Ubuntu versions, but some things might need to be adjusted. + +Installing and building +----------------------- + +Install ROS 2 by following the :doc:`installation instructions <../../Installation/Ubuntu-Install-Debians>`. 1. We should mention somewhere that this will only work on Linux. 👍 1. Does this work on RHEL as well? If so, we should just point to the generic Installation page. Yes, it should work on RHEL. — Reply to this email directly, view it on GitHub <#3621 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACNQEJ52XZOULNF2IYIVA4TXOBEMFANCNFSM6AAAAAAYEKGBDE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst

christophebedard · 2023-10-25T17:40:26Z

@nightduck friendly ping. I should've talked to you in person last week, but do you plan to address the last few comments, or should I take care of it?

christophebedard · 2023-11-14T17:57:04Z

@clalancette I applied some suggested changes and did other updates. Could you take another look?

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst

Signed-off-by: Oren Bell <[email protected]>

Signed-off-by: Christophe Bedard <[email protected]>

… documentation (#3621) Signed-off-by: Oren Bell <[email protected]> Signed-off-by: Christophe Bedard <[email protected]> Co-authored-by: Christophe Bedard <[email protected]> (cherry picked from commit b63b967)

… documentation (#3621) (#4018) Signed-off-by: Oren Bell <[email protected]> Signed-off-by: Christophe Bedard <[email protected]> Co-authored-by: Christophe Bedard <[email protected]> (cherry picked from commit b63b967) Co-authored-by: Oren Bell <[email protected]>

nightduck requested review from clalancette and audrow as code owners May 16, 2023 23:45

christophebedard requested changes May 17, 2023

View reviewed changes

clalancette assigned christophebedard May 25, 2023

christophebedard mentioned this pull request Jun 23, 2023

Update real-time documentation #3756

Draft

nightduck commented Jun 26, 2023

View reviewed changes

source/Tutorials/Advanced/ros2_tracing_trace_and_analyze.rst Outdated Show resolved Hide resolved

nightduck commented Jun 26, 2023

View reviewed changes

source/Tutorials/Advanced/ros2_tracing_trace_and_analyze.rst Outdated Show resolved Hide resolved

JanStaschulat added a commit to ros-realtime/ros2_documentation that referenced this pull request Jun 27, 2023

removed ros2_tracing tutorial, this is discussed here ros2#3621

037ff1b

Signed-off-by: Jan Staschulat <[email protected]>

christophebedard reviewed Jun 27, 2023

View reviewed changes

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

christophebedard added the backport-all backport at reviewers discretion; from rolling to all versions label Jun 29, 2023

christophebedard approved these changes Jun 29, 2023

View reviewed changes

clalancette requested changes Jul 1, 2023

View reviewed changes

christophebedard added backport-iron backport at reviewers discretion; from rolling to iron and removed backport-all backport at reviewers discretion; from rolling to all versions labels Jul 1, 2023

christophebedard reviewed Jul 17, 2023

View reviewed changes

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

christophebedard reviewed Jul 17, 2023

View reviewed changes

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

christophebedard reviewed Jul 17, 2023

View reviewed changes

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

christophebedard force-pushed the feature/ros2-tracing branch 2 times, most recently from 1b1305c to 3ea0a5e Compare November 14, 2023 17:51

christophebedard changed the title ~~Ported the ROS2 tracing page from ros-realtime documentation to primary documentation~~ Port the ros2_tracing page from ros-realtime documentation to primary documentation Nov 14, 2023

clalancette requested changes Nov 14, 2023

View reviewed changes

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

source/Tutorials/Advanced/ROS2-Tracing-Trace-and-Analyze.rst Outdated Show resolved Hide resolved

Moved ros2 tracing page here

7077484

nightduck and others added 16 commits November 14, 2023 11:07

Ported tracing page from markdown to rst

a40bc86

@christophebedard suggested modifications

5657528

Code review, part 2

c3136a4

Signed-off-by: Oren Bell <[email protected]>

Renamed file and added reference in sidebar

b07dd9e

Signed-off-by: Oren Bell <[email protected]>

Code review, take 3

410a3ef

Signed-off-by: Oren Bell <[email protected]>

Removed unused icon

5e1b31b

Signed-off-by: Oren Bell <[email protected]>

Code review, take 4

3463a55

Apply suggested changes

e062dcc

Signed-off-by: Christophe Bedard <[email protected]>

Replace weird-ish characters

e5059d4

Signed-off-by: Christophe Bedard <[email protected]>

Remove leading $ in code blocks

817cb82

Signed-off-by: Christophe Bedard <[email protected]>

Add note about different Linux distros

802d710

Signed-off-by: Christophe Bedard <[email protected]>

Update tracetools_analysis links and use {DISTRO}

fb8ebea

Signed-off-by: Christophe Bedard <[email protected]>

De-dent

d4de444

Signed-off-by: Christophe Bedard <[email protected]>

Make indentation more uniform (2 spaces I guess)

6b13c37

Signed-off-by: Christophe Bedard <[email protected]>

Apply language suggestion

bb7cc5b

Signed-off-by: Christophe Bedard <[email protected]>

Explicitly mention Linux

e1006fe

Signed-off-by: Christophe Bedard <[email protected]>

christophebedard force-pushed the feature/ros2-tracing branch from d6d2d8d to e1006fe Compare November 14, 2023 19:17

clalancette approved these changes Nov 15, 2023

View reviewed changes

christophebedard merged commit b63b967 into ros2:rolling Nov 15, 2023
3 checks passed

mergify bot mentioned this pull request Nov 15, 2023

Port the ros2_tracing page from ros-realtime documentation to primary documentation (backport #3621) #4018

Merged

christophebedard deleted the feature/ros2-tracing branch November 15, 2023 15:30

christophebedard mentioned this pull request Apr 19, 2024

Adapt ros2_tracing tutorial for Humble #4303

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port the ros2_tracing page from ros-realtime documentation to primary documentation #3621

Port the ros2_tracing page from ros-realtime documentation to primary documentation #3621

nightduck commented May 16, 2023 •

edited by christophebedard

Loading

nightduck commented May 16, 2023

christophebedard left a comment

christophebedard commented Jun 23, 2023

nightduck commented Jun 23, 2023

christophebedard left a comment

christophebedard commented Jun 29, 2023

nightduck commented Jul 1, 2023 via email

christophebedard commented Oct 25, 2023

christophebedard commented Nov 14, 2023

Port the ros2_tracing page from ros-realtime documentation to primary documentation #3621

Port the ros2_tracing page from ros-realtime documentation to primary documentation #3621

Conversation

nightduck commented May 16, 2023 • edited by christophebedard Loading

nightduck commented May 16, 2023

christophebedard left a comment

Choose a reason for hiding this comment

christophebedard commented Jun 23, 2023

nightduck commented Jun 23, 2023

christophebedard left a comment

Choose a reason for hiding this comment

christophebedard commented Jun 29, 2023

nightduck commented Jul 1, 2023 via email

christophebedard commented Oct 25, 2023

christophebedard commented Nov 14, 2023

nightduck commented May 16, 2023 •

edited by christophebedard

Loading