Skip to content

Commit 0159f5e

Browse files
author
Colin Robertson
authored
Merge pull request MicrosoftDocs#2205 from MicrosoftDocs/master637255088272661076
Fix git push error for protected CLA branch
2 parents e8e5d0f + 3f91111 commit 0159f5e

File tree

4 files changed

+763
-565
lines changed

4 files changed

+763
-565
lines changed

docs/build/configure-cmake-debugging-sessions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ In Visual Studio 2019 version 16.6, we added a new debug configuration of `type:
9090
- `name`: A friendly name to identify the configuration in the **Startup Item** dropdown.
9191
- `project`: Specifies the relative path to the project file. Normally, you don't need to change this path when debugging a CMake project.
9292
- `projectTarget`: Specifies the CMake target to invoke when building the project. Visual Studio autopopulates this property if you enter *launch.vs.json* from the **Debug Menu** or **Targets View**. This target value must match the name of an existing debug target listed in the **Startup Item** dropdown.
93-
- `debuggerConfiguration`: Indicates which set of debugging default values to use. In Visual Studio 2019 version 16.6, the only valid option is `gdb`. Earlier versions also support `gdbserver`.
93+
- `debuggerConfiguration`: Indicates which set of debugging default values to use. In Visual Studio 2019 version 16.6, the only valid option is `gdb`. Visual Studio 2019 version 16.7 or later also supports `gdbserver`.
9494
- `args`: Command-line arguments passed on startup to the program being debugged.
9595
- `env`: Additional environment variables passed to the program being debugged. For example, `{"DISPLAY": "0.0"}`.
9696
- `processID`: Linux process ID to attach to. Only used when attaching to a remote process. For more information, see [Troubleshoot attaching to processes using GDB](https://github.com/Microsoft/MIEngine/wiki/Troubleshoot-attaching-to-processes-using-GDB).
@@ -103,6 +103,15 @@ In Visual Studio 2019 version 16.6, we added a new debug configuration of `type:
103103
- `gdbpath`: Defaults to `/usr/bin/gdb`. Full Unix path to the `gdb` used to debug. Only required if using a custom version of `gdb`.
104104
- `preDebugCommand`: A Linux command to run immediately before invoking `gdb`. `gdb` doesn't start until the command completes. You can use the option to run a script before the execution of `gdb`.
105105

106+
#### Additional options allowed with the `gdbserver` configuration (16.7 or later)
107+
108+
- `program`: Defaults to `"${debugInfo.fullTargetPath}"`. The Unix path to the application to debug. Only required if different than the target executable in the build or deploy location.
109+
- `remoteMachineName`: Defaults to `"${debugInfo.remoteMachineName}"`. Name of the remote system that hosts the program to debug. Only required if different than the build system. Must have an existing entry in the [Connection Manager](../linux/connect-to-your-remote-linux-computer.md). Press **Ctrl+Space** to view a list of all existing remote connections.
110+
- `cwd`: Defaults to `"${debugInfo.defaultWorkingDirectory}"`. Full Unix path to the directory on the remote system where `program` is run. The directory must exist.
111+
- `gdbPath`: Defaults to `${debugInfo.vsInstalledGdb}`. Full Windows path to the `gdb` used to debug. Defaults to the `gdb` installed with the Linux development with C/C++ workload.
112+
- `gdbserverPath`: Defaults to `usr/bin/gdbserver`. Full Unix path to the `gdbserver` used to debug.
113+
- `preDebugCommand`: A Linux command to run immediately before starting `gdbserver`. `gdbserver` doesn't start until the command completes.
114+
106115
#### Deployment options
107116

108117
Use the following options to separate your build machine (defined in CMakeSettings.json) from your remote debug machine.

0 commit comments

Comments
 (0)