Skip to content

Commit 825595f

Browse files
TylerMSFTTylerMSFT
TylerMSFT
authored and
TylerMSFT
committed
minor wording updates
1 parent 76edb90 commit 825595f

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

‎docs/build/cmake-remote-debugging.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "How to use Visual Studio C++ on Windows to create and build a CMak
99

1010
This tutorial uses Visual Studio C++ on Windows to create and build a CMake project that you can deploy and debug on a remote Windows machine. This tutorial is specific to Windows ARM64, but the steps can be generalized for other architectures.
1111

12-
In Visual Studio, the default debugging experience for ARM64 is remote debugging an ARM64 Windows machine. Debugging an ARM64 CMake project without configuring your debug settings as shown in this tutorial will result in an error that Visual Studio can't find the remote machine.
12+
In Visual Studio, the default debugging experience for ARM64 is remote debugging an ARM64 Windows machine. If you try to debug an ARM64 CMake project without configuring your debug settings as shown in this tutorial, you'll get an error that Visual Studio can't find the remote machine.
1313

1414
In this tutorial, you'll learn how to:
1515

@@ -50,7 +50,7 @@ On the Windows host machine:
5050

5151
Give Visual Studio a few moments to create the project and populate the **Solution Explorer**.
5252

53-
## Change the configuration to target ARM64
53+
## Configure for ARM64
5454

5555
To target an ARM64 Windows machine, you need to build using ARM64 build tools.
5656

@@ -65,7 +65,7 @@ In the **CMakeSettings** dialog that appears, select **arm64-debug**, and then p
6565

6666
This adds a debug configuration named **arm64-Debug** to your *`CmakeSettings.json`* file. This configuration name is a unique, friendly name that makes it easier for you to identify these settings in the **Configuration** dropdown.
6767

68-
The **Toolset** dropdown will be set to **msvc_arm64_x64**. Your settings should now look something like this:
68+
The **Toolset** dropdown will be set to **msvc_arm64_x64**. Your settings should now look like this:
6969

7070
![CMake settings dialog](media/cmake-settings-editor2.png)
7171

@@ -92,13 +92,13 @@ Open the project folder (in this example, **CMakeProject3 Project**), and then r
9292

9393
This creates a `launch.vs.json` file in your project. Open it and change the following entries to enable remote debugging:
9494

95-
- `projectTarget` : this is set for you if you added the debug configuration file from the **Solution Explorer** targets view per the instructions above.
96-
- `remoteMachineName` : set to the IP address of the remote ARM64 machine, or its machine name.
95+
- `projectTarget`: this is set for you if you added the debug configuration file from the **Solution Explorer** targets view per the instructions above.
96+
- `remoteMachineName`: set to the IP address of the remote ARM64 machine, or its machine name.
9797

9898
For more information about `launch.vs.json` settings, see [launch.vs.json schema reference](launch-vs-schema-reference-cpp.md).
9999

100100
> [!Note]
101-
> If you are using the folder view instead of the targets view in **Solution Explorer**, right-click the `CMakeLists.txt` file and select **Add Debug Configuration**. This experience differs from adding the debug configuration from the targets view in the following ways:
101+
> If you're using the folder view instead of the targets view in **Solution Explorer**, right-click the `CMakeLists.txt` file and select **Add Debug Configuration**. This experience differs from adding the debug configuration from the targets view in the following ways:
102102
> - You'll be asked to select a debugger (select **C/C++ Remote Windows Debug**).
103103
> - Visual Studio will provide less configuration template information in the `launch.vs.json` file so you'll need to add it yourself. You'll need to provide the `remoteMachineName` and `projectTarget` entries. When you add the configuration from the targets view, you only need to specify `remoteMachineName`.
104104
> - For the `projectTarget` setting value, check the startup item dropdown to get the unique name of your target, for example, in this tutorial it is `CMakeProject3.exe'.
@@ -111,7 +111,7 @@ For example, on the remote machine, from the Visual Studio Remote Debugger menu
111111

112112
![Remote debugger authentication options](media/remote-debugger-options.png)
113113

114-
Then, in Visual Studio on the host machine, update the `launch.vs.json` file to match. For example, if you choose **No Authentication** on the remote debugger, update the `launch.vs.json` file in your project by adding **"windowsAuthenticationType": "Remote Windows with No authentication"** to the `configurations` section `launch.vs.json`. Otherwise, `"windowsAuthenticationType"` defaults to `"Remote Windows authentication"` and doesn't need to be explicitly stated. This example is the `launch.vs.json` file, configured for no authentication:
114+
Then, in Visual Studio on the host machine, update the `launch.vs.json` file to match. For example, if you choose **No Authentication** on the remote debugger, update the `launch.vs.json` file in your project by adding **"windowsAuthenticationType": "Remote Windows with No authentication"** to the `configurations` section `launch.vs.json`. Otherwise, `"windowsAuthenticationType"` defaults to `"Remote Windows authentication"` and doesn't need to be explicitly stated. This example shows a `launch.vs.json` file configured for no authentication:
115115

116116
``` XAML
117117
{
@@ -145,7 +145,7 @@ Then, in Visual Studio on the host machine, update the `launch.vs.json` file to
145145

146146
On the host machine, in the Visual Studio **Solution Explorer**, open the CPP file for your CMake project. If you're still in **CMake Targets View**, you'll need to open the **(executable)** node to see it.
147147

148-
The default CPP file is a simple hello world console app. Set a breakpoint on `return 0;` so that the program doesn't close on the remote machine.
148+
The default CPP file is a simple hello world console app. Set a breakpoint on `return 0;`.
149149

150150
On the Visual Studio toolbar, use the **Startup Item** dropdown to select the name you specified for `"name"` in your `launch.vs.json` file:
151151

@@ -154,7 +154,7 @@ On the Visual Studio toolbar, use the **Startup Item** dropdown to select the na
154154
To start debugging, on the Visual Studio toolbar choose **Debug** > **Start Debugging** (or press **F5**).
155155

156156
If it doesn't start, ensure that the following are set correctly in the `launch.vs.json` file:
157-
- `"remoteMachineName"` should be set to the IP address, or machine name, of the remote ARM64 Windows machine.
157+
- `"remoteMachineName"` should be set to the IP address, or the machine name, of the remote ARM64 Windows machine.
158158
- `"name"` should match the selection in the Visual Studio startup item dropdown.
159159
- `"projectTarget"` should match the name of the CMake target you want to debug.
160160
- `"type"` should be `"remoteWindows"`
@@ -165,6 +165,8 @@ After the project builds, the app should appear on the remote ARM64 Windows mach
165165

166166
![Hello CMake console app running on remote Windows ARM64 machine](media/remote-cmake-app.png)
167167

168+
Visual Studio on the host machine should be stopped at the breakpoint for `return 0;`.
169+
168170
## What you learned
169171

170172
In this tutorial, you created a CMake project, configured it to build for Windows on ARM64, and debugged it on a remote ARM64 Windows machine.

‎docs/build/launch-vs-schema-reference-cpp.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ Used when debugging and deploying an app on a remote machine.
6363
|Property|Type|Description|
6464
|-|-|-|
6565
|`cwd`|string|The working directory of the target on the remote machine. When using CMake, the macro `${debugInfo.defaultWorkingDirectory}` can be used as the value of this field. The default value is the directory of the debug program/command.|
66-
|`deploy`|string|Specifies extra files/directories to deploy. For example:<br> `"deploy": {"sourcePath":"<Full path to source file/directory on host machine>", "targetPath":"<Full destination path to file/directory on target machine>"}` |
67-
|`deployDirectory`|string|The location on the remote machine where project outputs are automatically deployed to. Defaults to "`C:\Windows Default Deploy Directory\<name of launch entry>`|
68-
|`deployDebugRuntimeLibraries`|string|Specifies to deploy the debug runtime libraries for the active platform. Defaults to `"true"` if the active configurationType is `"Debug"`|
69-
|`deployRuntimeLibraries`|string|Specifies to deploy the runtime libraries for the active platform. Defaults to `"true"` if the active configurationType is `"MinSizeRel"`, `"RelWithDebInfo"`, or `"Release"`.|
70-
|`disableDeploy` | boolean | Specifies whether any files should be deployed. |
71-
|`remoteMachineName`|string|Specifies the name of the remote ARM64 Windows machine where the program is launched. May be the server name or the remote machine's IP address|
72-
|`windowsAuthenticationType`|string|Specifies the type of remote connection. Possible values are `"Remote Windows authentication"` and `"Remote Windows with No authentication"`. The default is `"Remote Windows authentication"`. This should match the authentication setting specified on the remote debugger running on the remote machine.|
66+
|`deploy`|string|Specifies extra files or directories to deploy. For example:<br> `"deploy": {"sourcePath":"<Full path to source file/directory on host machine>", "targetPath":"<Full destination path to file/directory on target machine>"}` |
67+
|`deployDirectory`|string|The location on the remote machine where project outputs are automatically deployed to. Defaults to "`C:\Windows Default Deploy Directory\<name of app>`|
68+
|`deployDebugRuntimeLibraries`|string|Specifies whether to deploy the debug runtime libraries for the active platform. Defaults to `"true"` if the active configurationType is `"Debug"`|
69+
|`deployRuntimeLibraries`|string|Specifies whether to deploy the runtime libraries for the active platform. Defaults to `"true"` if the active configurationType is `"MinSizeRel"`, `"RelWithDebInfo"`, or `"Release"`.|
70+
|`disableDeploy` | boolean | Specifies whether files should be deployed. |
71+
|`remoteMachineName`|string|Specifies the name of the remote ARM64 Windows machine where the program is launched. May be the server name or the remote machine's IP address. |
72+
|`windowsAuthenticationType`|string|Specifies the type of remote connection. Possible values are `"Remote Windows authentication"` and `"Remote Windows with No authentication"`. The default is `"Remote Windows authentication"`. This should match the authentication setting specified on the remote debugger that is running on the remote machine.|
7373

7474
## <a name="launch_setup_commands"></a> Launch setup commands
7575

0 commit comments

Comments
 (0)