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

docs(jtag-debugging): add links to gdbstub for convenience (IDFGH-10898) #12097

Conversation

chipweinberger
Copy link
Contributor

@chipweinberger chipweinberger commented Aug 18, 2023

gdbstubs are kind of a hidden feature.

If you google "esp32 debugging", you'll find nothing about GDB Stubs.

They need to be linked more. They should probably even have their own article.


suggestion: There should be a separate ESP32 debugging article, that links to

  • JTAG debugging
  • GDB Stubs debugging

Copy link
Member

@igrr igrr 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 adding this @chipweinberger! I agree in general, but I think placing this ahead of all the content makes the note look more important than anything else in the document.

Would you be okay with it being placed somewhere lower in the document?

@chipweinberger
Copy link
Contributor Author

chipweinberger commented Aug 18, 2023

I think the top is the only section that makes sense, since gdbstubs are a wholy separate thing.

But maybe like this?


JTAG Debugging

This document provides a guide to installing OpenOCD for ESP32 and debugging using GDB.

Note:
You can also debug your ESP32 without needing to setup JTAG or OpenOCD using idf.py monitor See: IDF Monitor and :ref:CONFIG_ESP_SYSTEM_GDBSTUB_RUNTIME

The document is structured as follows:

@espressif-bot espressif-bot added the Status: Opened Issue is new label Aug 18, 2023
@github-actions github-actions bot changed the title docs(jtag-debugging): add links to gdbstub for convenience docs(jtag-debugging): add links to gdbstub for convenience (IDFGH-10898) Aug 18, 2023
@chipweinberger chipweinberger force-pushed the docs/jtag-debugging/add-links-to-gdbstub branch from 8caf035 to 6eb63c7 Compare August 18, 2023 07:50
@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Sep 22, 2023
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: In Progress Work is in progress labels Oct 4, 2023
movsb pushed a commit to movsb/esp-idf that referenced this pull request Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants