Skip to content

Commit 85917c1

Browse files
Merge pull request #4518 from TylerMSFT/alt-text
alt-text improvements
2 parents 4913bbe + 32ee5eb commit 85917c1

9 files changed

+81
-81
lines changed

docs/get-started/includes/git-source-control.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To associate your code with Git, you start by creating a new Git repository wher
2020

2121
1. In the **Create a Git repository** dialog box, sign in to GitHub.
2222

23-
:::image type="content" source="../media/vs-2022/git-create-repo.png" alt-text="Screenshot of the Create a Git Repository dialog window where you can sign in to GitHub.":::
23+
:::image type="content" source="../media/vs-2022/git-create-repo.png" alt-text="Screenshot of the Create a Git Repository dialog window where you create a new GitHub repository.":::
2424

2525
The repository name auto-populates based on your folder location. By default, your new repository is private, which means you're the only one who can access it.
2626

@@ -29,9 +29,9 @@ To associate your code with Git, you start by creating a new Git repository wher
2929
3030
1. Select **Create and Push**.
3131

32-
After you create your repository, you see status details in the status bar.
32+
After you create your repository, status details appear in the status bar.
3333

34-
:::image type="content" source="../media/vs-2022/git-new-private-repo-status-details.png" alt-text="Screenshot of the repo status bar that's below the Solution Explorer pane in Visual Studio.":::
34+
:::image type="content" source="../media/vs-2022/git-new-private-repo-status-details.png" alt-text="Screenshot of the repo status bar located below the Visual Studio Solution Explorer pane, showing the branch name and number of outstanding changes.":::
3535

3636
The first icon with the arrows shows how many outgoing/incoming commits are in your current branch. You can use this icon to pull any incoming commits or push any outgoing commits. You can also choose to view these commits first. To do so, select the icon, and then select **View Outgoing/Incoming**.
3737

docs/get-started/tutorial-console-cpp.md

Lines changed: 49 additions & 44 deletions
Large diffs are not rendered by default.

docs/linux/cmake-linux-configure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ When you do a build:
108108

109109
## Choose a Linux target
110110

111-
When you open a CMake project folder, Visual Studio parses the *CMakeLists.txt* file and specifies a Windows target of **x86-Debug**. To target a remote Linux system, you'll change the project settings based on your Linux compiler. For example, if you're using GCC on Linux and compiling with debug info, choose: **Linux-GCC-Debug** or **Linux-GCC-Release**.
111+
When you open a CMake project folder, Visual Studio parses the *CMakeLists.txt* file, and specifies a Windows target of **x86-Debug**. To target a remote Linux system, you'll change the project settings based on your Linux compiler. For example, if you're using GCC on Linux and compiling with debug info, choose: **Linux-GCC-Debug** or **Linux-GCC-Release**.
112112

113113
If you specify a remote Linux target, your source is copied to the remote system.
114114

@@ -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, which is 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 the options pane and CrossPlatform > C plus plus > Connection Manager selected. The Add button is 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 host name, port, user name, authentication 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 of the Connect to Remote System window with the host name and port fields outlined in red to indicate that they are incorrect.](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 of the Remote Logging screen with options to enable logging, log file location, and whether to log to 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 which shows 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

docs/linux/create-a-new-linux-project.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Create a Linux MSBuild C++ project in Visual Studio"
33
ms.date: "10/15/2020"
44
description: "Create a new MSBuild-based Linux project in Visual Studio."
5-
ms.assetid: 5d7c1d67-bc31-4f96-8622-2b4cf91372fd
65
---
76
# Create a Linux MSBuild C++ project in Visual Studio
87

@@ -25,7 +24,7 @@ To create a new Linux project in Visual Studio 2017, follow these steps:
2524
1. Select **File > New Project** in Visual Studio, or press **Ctrl + Shift + N**.
2625
1. Select the **Visual C++ > Cross Platform > Linux** node, and then select the project type to create. Enter a **Name** and **Location**, and choose **OK**.
2726

28-
![Screenshot showing the New Project dialog box with Visual C plus plus > Cross Platform > Linux selected, all of the project types called out, and the Name and Location text boxes also called out.](media/newproject.png)
27+
![The New Project dialog box with Visual C plus plus > Cross Platform > Linux selected and all project types and Name and Location text boxes called out.](media/newproject.png)
2928

3029
| Project Type | Description |
3130
| ------------ | --- |
@@ -52,7 +51,7 @@ To create a new Linux project in Visual Studio, follow these steps:
5251
1. In the **Search for templates** textbox, enter **Linux** to list the available templates for Linux projects.
5352
1. Select the project type to create, for example **Console Application**, and then choose **Next**. Enter a **Name** and **Location**, and choose **Create**.
5453

55-
![Screenshot of the new project dialog box with the language drop-down set to C++ and the platform drop-down set to Linux.](media/newproject-vs2019.png)
54+
![Screenshot of the new project dialog box with the language drop-down set to C plus plus and the platform drop-down set to Linux.](media/newproject-vs2019.png)
5655

5756
| Project Type | Description |
5857
| ------------ | --- |

docs/linux/deploy-run-and-debug-your-linux-project.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Deploy, run, and debug your Linux MSBuild C++ project in Visual Studio"
33
description: "Describes how to compile, execute, and debug code on the remote target from inside a MSBuild-based Linux C++ project in Visual Studio."
44
ms.date: "08/08/2020"
5-
ms.assetid: f7084cdb-17b1-4960-b522-f84981bea879
65
ms.custom: intro-deployment
76
---
87
# Deploy, run, and debug your Linux MSBuild project
@@ -56,11 +55,11 @@ There are several ways to interact with and debug your Linux project.
5655

5756
When the remote target is available, you'll see it listed by either name or IP address.
5857

59-
![Screenshot showing a Remote target.](media/remote_target.png)
58+
![Screenshot showing a Remote target IP address.](media/remote_target.png)
6059

6160
If you haven't connected to the remote target yet, you'll see an instruction to use [Linux Connection Manager](connect-to-your-remote-linux-computer.md) to connect to the remote target.
6261

63-
![Screenshot showing the Remote Architecture.](media/architecture.png)
62+
![Screenshot showing the Remote Architecture, which is x64.](media/architecture.png)
6463

6564
1. Set a breakpoint by clicking in the left gutter of some code that you know will execute.
6665

@@ -99,7 +98,7 @@ There are several ways to interact with and debug your Linux project.
9998

10099
## Debug with Attach to Process
101100

102-
The [Debugging](prop-pages/debugging-linux.md) property page for Visual Studio projects, and the **Launch.vs.json** settings for CMake projects, have settings that enable you to attach to a running process. If you require additional control beyond what is provided in those settings, you can place a file named `Microsoft.MIEngine.Options.xml` in the root of your solution or workspace. Here is a simple example:
101+
The [Debugging](prop-pages/debugging-linux.md) property page for Visual Studio projects, and the **Launch.vs.json** settings for CMake projects, have settings that enable you to attach to a running process. If you require more control beyond what is provided in those settings, you can place a file named `Microsoft.MIEngine.Options.xml` in the root of your solution or workspace. Here is a simple example:
103102

104103
```xml
105104
<?xml version="1.0" encoding="utf-8"?>
@@ -116,7 +115,7 @@ ExePath="C:\temp\ConsoleApplication17\ConsoleApplication17\bin\x64\Debug\Console
116115
</SupplementalLaunchOptions>
117116
```
118117

119-
The **AttachOptionsForConnection** has most of the attributes you might need. The example above shows how to specify a location to search for additional .so libraries. The child element **ServerOptions** enables attaching to the remote process with gdbserver instead. To do that, you need to specify a local gdb client (the one shipped in Visual Studio 2017 is shown above) and a local copy of the binary with symbols. The **SetupCommands** element enables you to pass commands directly to gdb. You can find all the options available in the [LaunchOptions.xsd schema](https://github.com/Microsoft/MIEngine/blob/master/src/MICore/LaunchOptions.xsd) on GitHub.
118+
The **AttachOptionsForConnection** has most of the attributes you might need. The example above shows how to specify a location to search for more .so libraries. The child element **ServerOptions** enables attaching to the remote process with gdbserver instead. To do that, you need to specify a local gdb client (the one shipped in Visual Studio 2017 is shown above) and a local copy of the binary with symbols. The **SetupCommands** element enables you to pass commands directly to gdb. You can find all the options available in the [LaunchOptions.xsd schema](https://github.com/Microsoft/MIEngine/blob/master/src/MICore/LaunchOptions.xsd) on GitHub.
120119

121120
::: moniker range=">=msvc-160"
122121

@@ -126,13 +125,13 @@ You can separate your remote build machine from your remote debug machine for bo
126125

127126
By default, the remote debug machine is the same as the remote build machine (**Configuration Properties** > **General** > **Remote Build Machine**). To specify a new remote debug machine, right-click on the project in **Solution Explorer** and go to **Configuration Properties** > **Debugging** > **Remote Debug Machine**.
128127

129-
![Screenshot showing the Linux remote debug machine property in the Property Pages dialog.](media/linux-remote-debug-machine.png)
128+
![Screenshot showing the Linux remote debug machine property in the Property Pages dialog which shows the username, authentication type, and port.](media/linux-remote-debug-machine.png)
130129

131130
The drop-down menu for **Remote Debug Machine** is populated with all established remote connections. To add a new remote connection, navigate to **Tools** > **Options** > **Cross Platform** > **Connection Manager** or search for "Connection Manager" in **Quick Launch**. You can also specify a new remote deploy directory in the project's Property Pages (**Configuration Properties** > **General** > **Remote Deploy Directory**).
132131

133132
By default, only the files necessary for the process to debug will be deployed to the remote debug machine. You can use **Solution Explorer** to configure which source files will be deployed to the remote debug machine. When you click on a source file, you'll see a preview of its File Properties directly below the Solution Explorer.
134133

135-
![Screenshot showing the Linux deployable files specified in the Properties window.](media/linux-deployable-content.png)
134+
![Screenshot showing the properties of the file main.cpp with the property content = False highlighted.](media/linux-deployable-content.png)
136135

137136
The **Content** property specifies whether the file will be deployed to the remote debug machine. You can disable deployment entirely by navigating to **Property Pages** > **Configuration Manager** and unchecking **Deploy** for the desired configuration.
138137

@@ -159,7 +158,7 @@ In some cases, you may require more control over your project's deployment. For
159158

160159
For CMake projects that target a remote Linux machine, you can specify a new remote debug machine in launch.vs.json. By default, the value of "remoteMachineName" is synchronized with the "remoteMachineName" property in CMakeSettings.json, which corresponds to your remote build machine. These properties no longer need to match, and the value of "remoteMachineName" in launch.vs.json will dictate which remote machine is used for deploy and debug.
161160

162-
![The CMake remote debug machine specified in the launch.vs.json file.](media/cmake-remote-debug-machine.png)
161+
![The CMake remote debug machine specified in the launch_schema.json file. The remote Machine Name is ${debugInfo . remoteMachineName}](media/cmake-remote-debug-machine.png)
163162

164163
IntelliSense will suggest all a list of all established remote connections. You can add a new remote connection by navigating to **Tools** > **Options** > **Cross Platform** > **Connection Manager** or searching for "Connection Manager" in **Quick Launch**.
165164

docs/linux/download-install-and-setup-the-linux-development-workload.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Install the C++ Linux workload in Visual Studio"
33
description: "How to download, install, and set up the Linux workload for C++ in Visual Studio."
44
ms.date: "05/03/2020"
5-
ms.assetid: e11b40b2-f3a4-4f06-b788-73334d58dfd9
65
ms.custom: intro-installation
76
---
87
# Download, install, and set up the Linux workload
@@ -29,11 +28,11 @@ For any of these scenarios, the **Linux development with C++** workload is requi
2928

3029
1. Type "Visual Studio Installer" in the Windows search box:
3130

32-
![Screenshot showing the Windows search box.](media/visual-studio-installer-search.png)
31+
![Screenshot of the Windows search box which contains the text: `visual studio installer`.](media/visual-studio-installer-search.png)
3332

3433
1. Look for the installer under the **Apps** results and double-click it. When the installer opens, choose **Modify**, and then click on the **Workloads** tab. Scroll down to **Other toolsets** and select the **Linux development with C++** workload.
3534

36-
![Screenshot showing the Visual C++ for Linux Development workload item in Visual Studio Installer.](media/linuxworkload.png)
35+
![Screenshot highlighting the Visual C++ for Linux Development workload item in Visual Studio Installer.](media/linuxworkload.png)
3736

3837
1. If you're targeting IoT or embedded platforms, go to the **Installation details** pane on the right. Under **Linux development with C++**, expand **Optional Components**, and choose the components you need. CMake support for Linux is selected by default.
3938

0 commit comments

Comments
 (0)