Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix debugger docs a bit (#27026)

Browse source 
Tried adding a custom debugging tasks to discover two more required
properties missing from the docs.

Release Notes:

- N/A
This commit is contained in:
Kirill Bulatov 2025-03-18 23:46:11 +02:00 • committed by GitHub
parent 1d4afe6daa
commit 89ae4ca9a3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
crates/project/src/debugger/README.md
View file

@ -38,7 +38,7 @@ To create a custom debug configuration you have to create a `.zed/debug.json` fi
[ [
{ {
// The label for the debug configuration and used to identify the debug session inside the debug panel // The label for the debug configuration and used to identify the debug session inside the debug panel
"label": "Example Start debugger config" "label": "Example Start debugger config",
// The debug adapter that Zed should use to debug the program // The debug adapter that Zed should use to debug the program
"adapter": "custom", "adapter": "custom",
// Request: defaults to launch // Request: defaults to launch
@ -55,7 +55,11 @@ To create a custom debug configuration you have to create a `.zed/debug.json` fi
// initialize_args: This field should contain all the adapter specific initialization arguments that are directly send to the debug adapter // initialize_args: This field should contain all the adapter specific initialization arguments that are directly send to the debug adapter
"initialize_args": { "initialize_args": {
// "stopOnEntry": true // e.g. to stop on the first line of the program (These args are DAP specific) // "stopOnEntry": true // e.g. to stop on the first line of the program (These args are DAP specific)
} },
// connection: the connection that a custom debugger should use
"connection": "stdio",
// The cli command used to start the debug adapter e.g. `python3`, `node` or the adapter binary
"command": "path_to_cli"
} }
] ]
``` ```