Documenting options in launch.json #193
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| Visual Studio Code generates a `launch.json` with almost all of the required information. To get started | ||
| debugging you need to fill in the `program` field with the path to the executable you plan to debug. This must be specified for | ||
| both the launch and attach (if you plan to attach to a running instance at any point) configurations. |
There was a problem hiding this comment.
This is actually only true for gdb/llb in the attach case. Of course, right now, we have a bug that concord is requiring it for attach.
Contributor
Author
There was a problem hiding this comment.
@jacdavis So it sounds like we should leave it like this until we fix that?
|
Only had two comments. Rest looks good to me. |
| **dumpPath**: If you want to debug a Windows dump file, set this to the path to the dump file to start debugging in the `launch` configuration. | ||
|
|
||
| **coreDumpPath**: Full path to a core dump file to debug for the specified program. Set this to the path to the core dump file to start debugging in the `launch` configureation. | ||
|
|
There was a problem hiding this comment.
Note that you can't debug dump files with mingw?
|
I had just a couple of minor things. Otherwise, approved. |
Contributor
Author
|
Adding documentation for launch.json |
abelenky
reviewed
Oct 13, 2016
|
|
||
| **stopAtEntry**: If set to true, the debugger should stop at the entrypoint of the target (ignored on attach). Default value is `false`. | ||
|
|
||
| **setupCommands**: JSON array of commands to execute in order to setup the GDB or LLDB. Example: `"customLaunchSetupCommands": [ { "text": "target-run", "description": "run target", "ignoreFailures": false }]`. |
There was a problem hiding this comment.
Experimentation shows me that the element is NOT named "customLaunchSetupCommands", as shown here, but just "setupCommands". This example (and again down a few lines) is wrong.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@pieandcakes @delmyers @jacdavis
Next attempt at documenting the launch.json. Took feedback from Pierson about trying to organize it more logically and providing some samples