You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/remote/containers.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,15 +203,15 @@ If you want to clean out images or mass-delete containers, [see here](/docs/remo
203
203
204
204
VS Code runs extensions in one of two places: locally on the UI / client side, or in the container. While extensions that affect the VS Code UI, like themes and snippets, are installed locally, most extensions will reside inside a particular container. This allows you to install only the extensions you need fora given taskin a container and seamlessly switch your entire tool-chain just by connecting to a new container.
205
205
206
-
If you search and install an extension from the Extensions view, it will automatically be installed in the correct location. You can tell where an extension is installed based on the category or group it is in. There will be a **Local - Installed** category and also one for your container.
206
+
If you install an extension from the Extensions view, it will automatically be installed in the correct location. You can tell where an extension is installed based on the category grouping. There will be a **Local - Installed** category and also one for your container.
>**Note:** If you are an extension author and are finding that your extension is not working properly or installs in the wrong place, see the article on [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
212
+
>**Note:** If you are an extension author and your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
213
213
214
-
Local extensions that actually need to run remotely will appear **Disabled**in the **Local - Installed** category. You can click the **Install** button if you want to install them on your remote host.
214
+
Local extensions that actually need to run remotely will appear **Disabled**in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
@@ -228,7 +228,7 @@ If there are extensions that you would like always installed in any container, y
228
228
229
229
### Advanced: Forcing an extension to run locally / remotely
230
230
231
-
VS Code runs extensions inone of two places: locally on the **UI** / client side, or remotely on the **Workspace** / container side. Extensions typically are designed and tested forusein one side or the other, not both. However, you can force an extension to run in a particular location in your User [settings](/docs/getstarted/settings.md).
231
+
As mentioned, VS Code runs extensions ineither the localclient or the container remote host. Extensions typically are designed and tested forusein one side or the other, not both. However, you can force an extension to run in a particular location in your User [settings](/docs/getstarted/settings.md).
232
232
233
233
For example, the `remote.extensionKind` setting below will force the Azure Cosmos DB extension on the UI side (instead of its Workspace default) and the Debugger for Chrome on the Workspace side (instead of its UI default):
234
234
@@ -593,7 +593,7 @@ See the following examples dev containers for additional information:
593
593
* The unofficial Ubuntu Docker **snap** package for Linux is **not** supported. Follow the [official Docker install instructions for your distribution](https://docs.docker.com/install/#supported-platforms).
594
594
* Local proxy settings are not reused inside the container which can prevent extensions from working unless the appropriate proxy information is configured (for example global `HTTP_PROXY` or `HTTPS_PROXY` environment variables with the appropriate proxy information).
595
595
596
-
See [here for a list of active issues](https://aka.ms/vscode-remote/containers/issues) on GitHub that are tagged with Containers.
596
+
See [here for a list of active issues](https://aka.ms/vscode-remote/containers/issues) related to Containers.
Copy file name to clipboardExpand all lines: docs/remote/ssh.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,15 +80,15 @@ Set the `"remote.SSH.configFile"` property in `settings.json` if you want to use
80
80
81
81
VS Code runs extensions in one of two places: locally on the UI / client side, or remotely on the SSH host. While extensions that affect the VS Code UI, like themes and snippets, are installed locally, most extensions will reside on the SSH host. This ensures you have smooth experience and allows you to install any needed extensions for a given workspace on an SSH host from your local machine. This way, you can pick up exactly where you left off, from a different machine complete with your extensions.
82
82
83
-
If you search for and install an extension in the Extensions view, it will automatically be installed in the correct location. Once installed, you can tell where an extension is installed based on the category it is in. There will be a category for your remote SSH host and a **Local - Installed** category.
83
+
If you install an extension from the Extensions view, it will automatically be installed in the correct location. Once installed, you can tell where an extension is installed based on the category grouping. There will be a category for your remote SSH host and a **Local - Installed** category.
> **Note:** If you are an extension author and find that your extension is not working properly or installs in the wrong place, see the article on [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
89
+
> **Note:** If you are an extension author and find that your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
90
90
91
-
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button on any of them you want to install on your remote host.
91
+
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
@@ -184,7 +184,7 @@ The Docker extension is configured to run as a local "UI" extension by default.
184
184
185
185
### Extension limitations
186
186
187
-
Many extensions will work on remote SSH hosts modification. However, in some cases, certain features may require changes. If you run into an extension issue, there is [a summary of common problems and solutions](/docs/remote/troubleshooting.md#extensiont-tips) that you can mention to the extension author when reporting the issue.
187
+
Many extensions will work on remote SSH hosts modification. However, in some cases, certain features may require changes. If you run into an extension issue, there is [a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
Copy file name to clipboardExpand all lines: docs/remote/wsl.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ DateApproved: 5/2/2019
9
9
---
10
10
# Developing in WSL
11
11
12
-
The **Visual Studio Code Remote - WSL** extension lets you use the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/windows/wsl) as your full-time development environment right from VS Code. You can develop in a Linuxbased environment, use Linux specific toolchains and utilities, and run and debug your Linuxbased applications all from the comfort of Windows.
12
+
The **Visual Studio Code Remote - WSL** extension lets you use the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/windows/wsl) as your full-time development environment right from VS Code. You can develop in a Linux-based environment, use Linux specific toolchains and utilities, and run and debug your Linux-based applications all from the comfort of Windows.
13
13
14
-
The extension runs commands and other extensions directly in WSL so you can edit files located in WSL or the mounted Windows filesystem (e.g.`/mnt/c`) without worrying about pathing issues, binary compatibility, or other cross-OS challenges.
14
+
The extension runs commands and other extensions directly in WSL so you can edit files located in WSL or the mounted Windows filesystem (for example`/mnt/c`) without worrying about pathing issues, binary compatibility, or other cross-OS challenges.
@@ -23,7 +23,7 @@ This lets VS Code provide a **local-quality development experience** — includi
23
23
24
24
To get started you need to:
25
25
26
-
1. Install the [Windows Subsystem for Linux](https://docs.microsoft.com/windows/wsl/install-win10) along with your preferred Linux distribution. VS Code will use your **default distro**, so use `wslconfig.exe` to change your default as needed.
26
+
1. Install the [Windows Subsystem for Linux](https://docs.microsoft.com/windows/wsl/install-win10) along with your preferred Linux distribution. VS Code will use your **default distro**, so use [wslconfig.exe](https://docs.microsoft.com/windows/wsl/wsl-config) to change your default as needed.
27
27
28
28
> **Note:** WSL does have some [known limitations](#known-limitations) for certain types of development that can also affect your VS Code experience.
29
29
@@ -41,9 +41,9 @@ Opening a folder inside the Windows Subsystem for Linux in VS Code is very simil
41
41
42
42
2. Navigate to a folder you'd like to open in VS Code (including, but not limited to, Windows filesystem mounts like `/mnt/c`)
43
43
44
-
3. Type **`code-insiders .`** in the terminal. When doing this for the first time you should see VS Code fetching components needed to run in WSL. This should only take short while, and is only needed once.
44
+
3. Type **`code-insiders .`** in the terminal. When doing this for the first time, you should see VS Code fetching components needed to run in WSL. This should only take short while, and is only needed once.
45
45
46
-
4. After a moment, a new VS Code window will appear, and you'll see a notification letting you know VS Code is opening the folder in WSL.
46
+
4. After a moment, a new VS Code window will appear, and you'll see a notification that VS Code is opening the folder in WSL.
@@ -53,27 +53,27 @@ Opening a folder inside the Windows Subsystem for Linux in VS Code is very simil
53
53
54
54

55
55
56
-
That's it! Any VS Code operations you perform in this window will be executed in the WSL environment including everything from editing and file operations, to debugging, terminals, and more.
56
+
That's it! Any VS Code operations you perform in this window will be executed in the WSL environment, everything from editing and file operations, to debugging, using terminals, and more.
57
57
58
58
## Managing extensions
59
59
60
60
VS Code runs extensions in one of two places: locally on the UI / client side, or in WSL. While extensions that affect the VS Code UI, like themes and snippets, are installed locally, most extensions will reside inside WSL.
61
61
62
-
If you search for an extension in the Extensions view and install, it will automatically be installed in the correct location. Once installed, you can tell where an extension is installed based on the category it is in. There will be **Local - Installed** category and one for WSL.
62
+
If you install an extension from the Extensions view, it will automatically be installed in the correct location. Once installed, you can tell where an extension is installed based on the category grouping. There will be **Local - Installed** category and one for WSL.
> **Note:** If you are an extension author and are finding that your extension is not working properly or installs in the wrong place, see the article on[Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
68
+
> **Note:** If you are an extension author and your extension is not working properly or installs in the wrong place, see [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details.
69
69
70
-
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button on any of them you want to install on your remote host.
70
+
Local extensions that actually need to run remotely will appear **Disabled** in the **Local - Installed** category. You can click the **Install** button to install an extension on your remote host.
### Advanced: Forcing an extension to run locally / remotely
75
75
76
-
VS Code runs extensions in one of two places: locally on the UI / client side, or remotely on the Workspace / WSL side. Extensions typically are designed and tested for use in one side or the other, not both. However, you can force an extension to run in a particular location in your `settings.json` file.
76
+
As mentioned, VS Code runs extensions in either the local client or the WSL remote host. Extensions typically are designed and tested for use in one side or the other, not both. However, you can force an extension to run in a particular location in your `settings.json` file.
77
77
78
78
For example, the setting below will force the Azure Cosmos DB extension on the UI side (instead of its Workspace default) and the Debugger for Chrome on the Workspace side (instead of its UI default):
79
79
@@ -108,14 +108,15 @@ VS Code's local user settings are also reused when you have opened a folder in W
108
108
109
109
This section contains a list of common know issues with WSL. The intent is not to provide a complete list of issues but to highlight some of the common problems seen with WSL.
110
110
111
-
For a more complete list, see [here for a list of active issues](https://aka.ms/vscode-remote/wsl/issues)on GitHub that are tagged with WSL.
111
+
See [here for a list of active issues](https://aka.ms/vscode-remote/wsl/issues)related to WSL.
112
112
113
113
### Common limitations in WSL
114
114
115
115
| Issue | Existing issues |
116
116
|---|---|
117
117
Non-empty folders in the open workspace can't be renamed | https://github.com/Microsoft/WSL/issues/3395, https://github.com/Microsoft/WSL/issues/1956
118
-
Local proxy settings are not reused by VS Code running in WSL which can prevent extensions from working without adding a global `HTTP_PROXY` and `HTTPS_PROXY` environment variable with the appropriate proxy information. |
118
+
119
+
In addition, local proxy settings are not reused by VS Code running in WSL, which can prevent extensions from working without adding a global `HTTP_PROXY` and `HTTPS_PROXY` environment variable with the appropriate proxy information.
119
120
120
121
### Golang in WSL
121
122
@@ -143,13 +144,15 @@ The Docker extension is configured to run as a local "UI" extension that runs on
143
144
144
145
### Extension limitations
145
146
146
-
Many extensions will work in WSL without modification. However, in some cases, certain features may require changes. If you run into an extension issue, [see here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extensiont-tips) that you can mention to the extension author when reporting the issue.
147
+
Many extensions will work in WSL without modification. However, in some cases, certain features may require changes. If you run into an extension issue, [see here for a summary of common problems and solutions](/docs/remote/troubleshooting.md#extension-tips) that you can mention to the extension author when reporting the issue.
147
148
148
149
## Common questions
149
150
150
151
### How do I change the distribution Remote - WSL uses?
151
152
152
-
The Remote - WSL extension uses your **default distribution** which you can change using `wslconfig.exe`. For example:
153
+
The Remote - WSL extension uses your **default distribution**, which you can change using [wslconfig.exe](https://docs.microsoft.com/windows/wsl/wsl-config).
154
+
155
+
For example:
153
156
154
157
```bash
155
158
wslconfig /setdefault Ubuntu
@@ -161,7 +164,7 @@ You can see which distributions you have installed using:
161
164
wslconfig /l
162
165
```
163
166
164
-
### I'm seeing an error about a missing library or dependency, how do I fix this?
167
+
### I'm seeing an error about a missing library or dependency
165
168
166
169
Some extensions rely on libraries not found in the vanilla install of certain WSL Linux distributions. You can add additional libraries into your Linux distribution by using its package manager. For Ubuntu and Debian based distributions, run `sudo apt-get install <package>` to install the needed libraries. Check the documentation for your extension or the runtime that is mentioned for additional installation details.
0 commit comments