Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ported the gdb backtrace from NAV2 #4190

Merged
merged 62 commits into from
Apr 21, 2024
Merged

Conversation

GauravKumar9920
Copy link
Contributor

@GauravKumar9920 GauravKumar9920 commented Feb 27, 2024

I have ported the gdb backtrace documentation form the NAV2 to ROS2 documentation. more changes need to be done to this.

this pull request is linked to ISSUE #4178

Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides what I've left inline, we recently introduced a much shorter version of this in #4175 . We should probably move that advice from there into this document, so it is all in one place.

source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
@GauravKumar9920
Copy link
Contributor Author

GauravKumar9920 commented Feb 27, 2024

Besides what I've left inline, we recently introduced a much shorter version of this in #4175 . We should probably move that advice from there into this document, so it is all in one place.

Thanks @clalancette for the giving this a review :)
I will look onto all the inlines and resolve them. This was an initial commit, in the commits following this one I would resolve most of the issues and implement the improvements suggested by the community.

@GauravKumar9920
Copy link
Contributor Author

hii @clalancette @fujitatomoya I have made some changes based on you previous review.
Kindly let me know of any Improvement or changes that needs to be done.

Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for your contribution. a few more comments.

source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
source/Tutorials/Intermediate/Get-Backtrace-in-ROS2.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is getting closer, i am good to go if @clalancette 's comments are resolved. especially for replacing this into How-To-Guide section.

@GauravKumar9920
Copy link
Contributor Author

hi @fujitatomoya @clalancette @Ryanf55 are there any updates regarding the documentation.

Copy link
Contributor

@Ryanf55 Ryanf55 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking very good, just a few touchups from my end.

That said, you moved the content I wrote on debugging tests, but didn't delete the old stuff. It's now duplicated in two places.

Instead, can you delete the old debugging tests contents, keep the header, and then just add in a link to this page with a brief explanation saying to review the GDB guide if you need to debug tests.

source/How-To-Guides/Get-Backtrace-in-ROS-2.rst Outdated Show resolved Hide resolved
source/How-To-Guides/Get-Backtrace-in-ROS-2.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GauravKumar9920 thanks for the contribution and effort! lgtm.

@clalancette can you take a look at the changes?

@GauravKumar9920
Copy link
Contributor Author

Apologies for the delay, I had my university exams, I have deleted the old stuff and added the link to new tutorial.

@GauravKumar9920
Copy link
Contributor Author

GauravKumar9920 commented Mar 31, 2024

@clalancette @audrow @fujitatomoya Is it good to be merged can you also give it review.

GauravKumar9920 and others added 20 commits April 21, 2024 09:12
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Signed-off-by: Chris Lalancette <clalancette@gmail.com>
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great now. Thanks for all the work here @GauravKumar9920

@clalancette clalancette merged commit cc7701d into ros2:rolling Apr 21, 2024
4 checks passed
mergify bot pushed a commit that referenced this pull request Apr 21, 2024
* Ported the gdb backtrace in the

* Added a new section- Reading the Stack Trace

* Added new sections explaining what is backtrace and how it can be useful. I have also included a simple examples of pancakes stacking.

Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
(cherry picked from commit cc7701d)
mergify bot pushed a commit that referenced this pull request Apr 21, 2024
* Ported the gdb backtrace in the

* Added a new section- Reading the Stack Trace

* Added new sections explaining what is backtrace and how it can be useful. I have also included a simple examples of pancakes stacking.

Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
(cherry picked from commit cc7701d)
clalancette pushed a commit that referenced this pull request Apr 21, 2024
* Ported the gdb backtrace in the

* Added a new section- Reading the Stack Trace

* Added new sections explaining what is backtrace and how it can be useful. I have also included a simple examples of pancakes stacking.

Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
(cherry picked from commit cc7701d)

Co-authored-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
clalancette pushed a commit that referenced this pull request Apr 21, 2024
* Ported the gdb backtrace in the

* Added a new section- Reading the Stack Trace

* Added new sections explaining what is backtrace and how it can be useful. I have also included a simple examples of pancakes stacking.

Signed-off-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Signed-off-by: GauravKumar9920 <gaurav.og.9920@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
Co-authored-by: Ryan <ryanfriedman5410+github@gmail.com>
(cherry picked from commit cc7701d)

Co-authored-by: Gaurav Kumar <84905312+GauravKumar9920@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants