Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Link to Debugger reference docs #5892

Merged
merged 1 commit into from Feb 14, 2023
Merged

Link to Debugger reference docs #5892

merged 1 commit into from Feb 14, 2023

Conversation

cds-amal
Copy link
Member

@cds-amal cds-amal commented Feb 14, 2023

PR description

This PR adds a link to the debugger docs to help users quickly navigate to extended help.

Help with link

MetaCoin.sol:

 9: // coin/token contracts.
10:
11: contract MetaCoin {
    ^^^^^^^^^^^^^^^^^^^

debug(development:0xad5d9050...)> h

Commands:
(enter) last command entered (step next)
(o) step over, (i) step line / step into, (u) step out, (n) step next
(c) continue until breakpoint, (Y) reset & continue to previous error
(y) (if at end) reset & continue to final error
(;) step instruction (include number to step multiple)
(g) turn on generated sources, (G) turn off generated sources except via `;`
(p) print instruction & state (`p [mem|cal|sto]*`; see docs for more)
(l) print additional source context (`l [+<lines-ahead>] [-<lines-back>]`)
(s) print stacktrace, (e) Print recent events (`e [<number>|all]`)
(q) quit, (r) reset, (t) load new transaction, (T) unload transaction
(b) add breakpoint (`b [[<source-file>:]<line-number>]`; see docs for more)
(B) remove breakpoint (similar to adding, or `B all` to remove all)
(+) add watch expression (`+:<expr>`), (-) remove watch expression (-:<expr>)
(?) list existing watch expressions and breakpoints
(v) print variables and values (`v [bui|glo|con|loc]*`)
(:) evaluate expression - see `v`, (h) print this help

Docs: https://trufflesuite.com/docs/truffle/how-to/debug-test/use-the-truffle-debugger/

debug(development:0xad5d9050...)>

Testing instructions

Start a debug session and verify h shows the reference link.

Documentation

  • no doc change required.

Breaking changes and new features

  • no breaking change or new feature

Copy link
Contributor

@haltman-at haltman-at left a comment

Choose a reason for hiding this comment

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

I like it!

@cds-amal cds-amal merged commit 838397b into develop Feb 14, 2023
@cds-amal cds-amal deleted the there-there branch February 14, 2023 21:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants