Skip to content

doc: expand gdb.md with supported packets and commands#6233

Open
SELESTER11 wants to merge 1 commit into
rizinorg:devfrom
SELESTER11:dev
Open

doc: expand gdb.md with supported packets and commands#6233
SELESTER11 wants to merge 1 commit into
rizinorg:devfrom
SELESTER11:dev

Conversation

@SELESTER11
Copy link
Copy Markdown

@SELESTER11 SELESTER11 commented Apr 14, 2026

Your checklist for this pull request

  • I've read the guidelines for contributing to this repository.
  • I made sure to follow the project's coding style.
  • I've documented every RZ_API function and struct this PR changes. (N/A - documentation only)
  • I've added tests that prove my changes are effective. (N/A - documentation only)
  • I've updated the Rizin book with the relevant information. (N/A - not required for this change)
  • I've used AI tools to generate fully or partially these code changes and I'm sure the changes are not copyrighted by somebody else.

Detailed description

The gdb.md documentation was incomplete. The Supported Commands section was missing stepping, breakpoints, attach/detach, file access, and thread listing. The Supported Packets list only had 6 entries despite many more being implemented in rzgdb.

Changes:

  • Adds missing command descriptions verified against rzgdb source
  • Expands Supported Packets list to reflect actual implementation
  • Fixes formatting: backtick-formats packet names, fixes capitalization
  • Removes outdated TODO items that have since been implemented

Note: AI (Claude, Anthropic) was used to help format this PR description. The documentation content itself was written and verified manually against the rzgdb source code.

Test plan

Documentation-only change, no code modified. Packet names verified against subprojects/rzgdb/include/gdbclient/commands.h and subprojects/rzgdb/src/gdbclient/core.c.

Closing issues

N/A

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 14, 2026
@Rot127
Copy link
Copy Markdown
Member

Rot127 commented Apr 15, 2026

Please fill out the PR template.

@github-actions github-actions Bot added the GDB label Apr 20, 2026
@SELESTER11 SELESTER11 force-pushed the dev branch 2 times, most recently from ce2d1b3 to 02b9c28 Compare April 20, 2026 20:03
@SELESTER11
Copy link
Copy Markdown
Author

@Rot127
The PR body now has the template filled out
let me know if anything is still missing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation GDB

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants