Skip to content

Commit

Permalink
Documentation/faq: Correct commands in substitute-path section (go-de…
Browse files Browse the repository at this point in the history
…lve#3222)

The text of the substitute-path section in the FAQ ("Can not set
breakpoints or see source listing in a complicated debugging
environment") mentions the command 'config help substitute-path', but
'help' is not a valid argument to the 'config' command.

Use 'help config' instead, which does mention 'substitute-path' and how
to set it.

Also, the command to list source files is 'sources', not 'source'. Fix
that.
  • Loading branch information
phil-blain authored Dec 15, 2022
1 parent 9523849 commit 72c77b1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Documentation/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ Command failed: open /path/to/the/mainfile.go: no such file or directory

This is not a bug. The Go compiler embeds the paths of source files into the executable so that debuggers, including Delve, can use them. Doing any of the things listed above will prevent this feature from working seamlessly.

The substitute-path feature can be used to solve this problem, see `config help substitute-path` or the `substitutePath` option in launch.json.
The substitute-path feature can be used to solve this problem, see `help config` or the `substitutePath` option in launch.json.

The `source` command could also be useful in troubleshooting this problem, it shows the list of file paths that has been embedded by the compiler into the executable.
The `sources` command could also be useful in troubleshooting this problem, it shows the list of file paths that has been embedded by the compiler into the executable.

If you still think this is a bug in Delve and not a configuration problem, open an [issue](https://github.com/go-delve/delve/issues), filling the issue template and including the logs produced by delve with the options `--log --log-output=rpc,dap`.

0 comments on commit 72c77b1

Please sign in to comment.