Skip to content

Commit 9c475b8

Browse files
TylerMSFTTylerMSFT
authored andcommitted
alt-text
1 parent f107548 commit 9c475b8

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/linux/cmake-linux-configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,11 @@ If you're targeting Windows Subsystem for Linux (WSL), you don't need to add a r
125125

126126
To target WSL, select **Manage Configurations** in the configuration dropdown in the main toolbar:
127127

128-
![CMake Manage Configurations.](../build/media/vs2019-cmake-manage-configurations.png "CMake configurations drop-down")
128+
![CMake configurations drop-down with Manage Configurations selected](../build/media/vs2019-cmake-manage-configurations.png "CMake configurations drop-down")
129129

130130
The **CMakeSettings.json** window appears.
131131

132-
![Add configuration.](media/cmake-linux-configurations.png "Add a configuration to CMake settings")
132+
![CMake settings dialog with the plus button highlighted which adds the selected configuration: Linux-GCC-debug.](media/cmake-linux-configurations.png )
133133

134134
Press **Add Configuration** (the green '+' button) and then choose **Linux-GCC-Debug** or **Linux-GCC-Release** if using GCC. Use the Clang variants if you're using the Clang/LLVM toolset. Press **Select** and then **Ctrl+S** to save the configuration.
135135

docs/linux/connect-to-your-remote-linux-computer.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ If `ssh` isn't already set up and running on your Linux system, follow these ste
6464

6565
1. In the Connection Manager dialog, choose the **Add** button to add a new connection.
6666

67-
![Screenshot showing the Connection Manager dialog.](media/settings_connectionmanager.png)
67+
![Screenshot showing CrossPlatform > C++ > Connection Manager selected under options, and the Add button highlighted.](media/settings_connectionmanager.png)
6868

6969
In either scenario, the **Connect to Remote System** window is displayed.
7070

71-
![Screenshot showing the Connect to Remote System window.](media/connect.png)
71+
![Screenshot showing the Connect to Remote System window which has fields for the host name, port, user name, auth type, and password.](media/connect.png)
7272

7373
1. Enter the following information:
7474

@@ -90,7 +90,7 @@ If `ssh` isn't already set up and running on your Linux system, follow these ste
9090

9191
If the connection fails, the entry boxes that need to be changed are outlined in red.
9292

93-
![Screenshot showing a Connection Manager Error.](media/settings_connectionmanagererror.png)
93+
![Screenshot showing a Connection Manager Error. The host name and port fields are outlined in red to indicate an error.](media/settings_connectionmanagererror.png)
9494

9595
If you use key files for authentication, make sure the target machine's SSH server is running and configured properly.
9696

@@ -181,7 +181,7 @@ For example: `HostKeyAlgorithms ssh-dss,ssh-rsa`
181181

182182
You can enable logging to help troubleshoot connection problems. On the menu bar, select **Tools > Options**. In the **Options** dialog, select **Cross Platform > Logging**:
183183

184-
![Screenshot showing Remote Logging.](media/remote-logging-vs2019.png)
184+
![Screenshot showing the Remote Logging screen with options to enable logging, log file location, and a checkbox indicating whether to log to the "Cross Platform Logging pane in the output window.](media/remote-logging-vs2019.png)
185185

186186
Logs include connections, all commands sent to the remote machine (their text, exit code and execution time), and all output from Visual Studio to the shell. Logging works for any cross-platform CMake project or MSBuild-based Linux project in Visual Studio.
187187

@@ -199,13 +199,11 @@ For example: `HostKeyAlgorithms ssh-dss,ssh-rsa`
199199

200200
The `rsync` command is used by both MSBuild-based Linux projects and CMake projects to [copy headers from your remote system to Windows for use by IntelliSense](configure-a-linux-project.md#remote_intellisense). When you can't enable TCP port forwarding, disable the automatic download of remote headers. To disable it, use **Tools > Options > Cross Platform > Connection Manager > Remote Headers IntelliSense Manager**. If the remote system doesn't have TCP port forwarding enabled, you'll see this error when the download of remote headers for IntelliSense begins:
201201

202-
![Screenshot showing a Headers Error.](media/port-forwarding-headers-error.png)
203-
204-
202+
![Screenshot showing an error that the SSH channel couldn't be opened, and a path to log file for more details.](media/port-forwarding-headers-error.png)
205203

206204
`rsync` is also used by Visual Studio's CMake support to copy source files to the remote system. If you can't enable TCP port forwarding, you can use `sftp` as your remote copy sources method. `sftp` is often slower than `rsync`, but doesn't have a dependency on TCP port forwarding. You can manage your remote copy sources method with the `remoteCopySourcesMethod` property in the [CMake Settings Editor](../build/cmakesettings-reference.md#settings-for-cmake-linux). If TCP port forwarding is disabled on your remote system, you'll see an error in the CMake output window the first time it invokes `rsync`.
207205

208-
![Screenshot showing an Rsync Error.](media/port-forwarding-copy-error.png)
206+
![Screenshot of the output window showing an Rsync Error that the SSH channel couldn't be opened.](media/port-forwarding-copy-error.png)
209207

210208
`gdbserver` can be used for debugging on embedded devices. If you can't enable TCP port forwarding, then you must use `gdb` for all remote debugging scenarios. `gdb` is used by default when debugging projects on a remote system.
211209

0 commit comments

Comments
 (0)