New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add /waitfordebugger
argument to MGCB.
#8227
base: develop
Are you sure you want to change the base?
Conversation
The call to `System.Diagnostics.Debugger.Launch` is not supported on Unix based platforms. This makes debugging `MGCB.exe` and Content Pipeline extensions difficult. So lets add a new argument which will make `MGCB.exe` wait for a debugger to attach. Also add a extra update to the `launch.json` to demonstrate how to attach the `dotnet` debugger to an existing process. This new system will also work on Windows. To use this in VSCode you can add the following to the `launch.json` ```json { // Use IntelliSense to learn about possible attributes. // Hover to view descriptions of existing attributes. // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "Attach to Process", "type": "coreclr", "request": "attach", "processId": "${input.processid}", } ], "inputs": [ { "id": "processid", "type": "promptString", "default": "0", "description": "Enter Process Id of process to attach to." } ] } ``` you can then add the following to your `csproj`. ``` <MonoGameMGCBAdditionalArguments>/waitfordebugger</MonoGameMGCBAdditionalArguments> ``` This will cause the `MGCB.exe` to print the ProcessId to the console during the build and wait for the debugger to attach. Once you have the ProcessId you can run the VSCode `Attach to Process` and enter the ProcessId when prompted. The debugger should then attach. If you want to prcess without attaching the debugger just hit any key in the console or terminal windows where `MGCB.exe` is running.
{ | ||
var currentProcess = Process.GetCurrentProcess(); | ||
Console.WriteLine($"Waiting for debugger to attach ({currentProcess.MainModule.FileName} PID {currentProcess.Id}). Press any key to continue without debugger."); | ||
while (!Debugger.IsAttached) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Braces should be be in new lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, let us use the same braces formatting as the rest of MonoGame, braces on new lines, indented with the function.
Other than that, it is good to go.
The call to
System.Diagnostics.Debugger.Launch
is not supported on Unix based platforms. This makesdebugging
MGCB.exe
and Content Pipeline extensions difficult.So lets add a new argument which will make
MGCB.exe
wait for a debugger to attach. Also add a extraupdate to the
launch.json
to demonstrate how toattach the
dotnet
debugger to an existing process.This new system will also work on Windows.
To use this in VSCode you can add the following to the
launch.json
you can then add the following to your
csproj
.This will cause the
MGCB.exe
to print the ProcessId to the console during the build and wait for the debugger to attach. Once you have the ProcessId you can run the VSCodeAttach to Process
and enter the ProcessId when prompted. The debugger should then attach.If you want to prcess without attaching the debugger just hit any key in the console or terminal windows where
MGCB.exe
is running.