microsoft / microsoft/debug-adapter-protocol

Add a sequence diagram for the attach scenario

Open
#93 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
1.8k
Forks
173
Avg merge
7d 7h
Merged PRs (30d)
2

Description

https://microsoft.github.io/debug-adapter-protocol/overview has a really nice sequence diagram that helps a lot for the launch scenario. It would be great if a similar figure for the attach scenario could be added, right now I'm a bit lost how that is working.

In particular: the launch scenario suggests that we start the debugger in the intialize event. But at that point I don't yet know whether the DA is asked to run in attach or laucnh mode, and I need to start the debugger in a different way, depending on which of those I should do. So I guess I shouldn't really start the debugger in initialize, but somewhere else...

But ideally the debugger would be already running when breakpoint information is sent. So do I need to "lazily" start the debugger in the first breakpoint request? Or something like that?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the launch sequence diagram at https://microsoft.github.io/debug-adapter-protocol/overview and trace the attach scenario described in this issue. Determine when initialization, debugger startup, and breakpoint requests occur for attach mode, then add a matching sequence diagram that makes the ordering clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.