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

docs: Fix headings in debugger docs (#32641)

Browse source 
Reported by calebmeyer on Discord.
Closes #ISSUE

Release Notes:

- N/A
This commit is contained in:
Piotr Osiewicz 2025-06-12 23:42:30 +02:00 • committed by GitHub
parent d725371c42
commit cd018da1ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/src/debugger.md
View file

@ -112,20 +112,6 @@ Automatic scenario creation is currently supported for Rust, Go and Python. Java
### Example Configurations
#### Go
```json
[
{
"label": "Go (Delve)",
"adapter": "Delve",
"program": "$ZED_FILE",
"request": "launch",
"mode": "debug"
}
]
```
#### JavaScript
##### Debug Active File
@ -287,6 +273,18 @@ for any tests, so you can use the Play button in the gutter to debug these witho
To debug a specific package, you can do so by setting the Delve mode to "debug". In this case "program" should be set to the package name.
```json
[
{
"label": "Go (Delve)",
"adapter": "Delve",
"program": "$ZED_FILE",
"request": "launch",
"mode": "debug"
}
]
```
```json
[
{
@ -294,7 +292,7 @@ To debug a specific package, you can do so by setting the Delve mode to "debug".
"adapter": "Delve",
"request": "launch",
"mode": "debug",
// For Delve, the program is the package name
// For Delve, the program can be a package name
"program": "./cmd/server"
// "args": [],
// "buildFlags": [],
@ -354,7 +352,7 @@ and the "build" command should build that.
You might find yourself needing to connect to an existing instance of Delve that's not necessarily running on your machine; in such case, you can use `tcp_arguments` to instrument Zed's connection to Delve.
````
```
{
"adapter": "Delve",
"label": "Connect to a running Delve instance",
@ -369,9 +367,9 @@ You might find yourself needing to connect to an existing instance of Delve that
}
```
In such case Zed won't spawn a new instance of Delve, as it opts to use an existing one. The consequence of this is that *there will be no terminal* in Zed; you have to interact with the Delve instance directly, as it handles stdin/stdout of the debuggee.
In such case Zed won't spawn a new instance of Delve, as it opts to use an existing one. The consequence of this is that _there will be no terminal_ in Zed; you have to interact with the Delve instance directly, as it handles stdin/stdout of the debuggee.
### Ruby
#### Ruby
To run a ruby task in the debugger, you will need to configure it in the `.zed/debug.json` file in your project. We don't yet have automatic detection of ruby tasks, nor do we support connecting to an existing process.
@ -392,7 +390,7 @@ The configuration should look like this:
// "cwd": ""
}
}
````
```
## Breakpoints