Skip to content

Commit 9febdcf

Browse files
authored
Merge pull request #8048 from microsoft/variables-reference
Move variables article to Reference ToC node
2 parents 8bc2e69 + 879b624 commit 9febdcf

File tree

16 files changed

+99
-90
lines changed

16 files changed

+99
-90
lines changed

docs/copilot/copilot-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ MetaSocialImage: images/shared/github-copilot-social.png
1010
---
1111
# GitHub Copilot in VS Code settings reference
1212

13-
This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/editor/settings.md), as well as the [Variables reference](/docs/editor/variables-reference.md) for information about predefined variable support.
13+
This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/editor/settings.md), as well as the [Variables reference](/docs/reference/variables-reference.md) for information about predefined variable support.
1414

1515
> [!TIP]
1616
> If you don't yet have a Copilot subscription, you can use Copilot for free by signing up for the [Copilot Free plan](https://github.com/github-copilot/signup) and get a monthly limit of completions and chat interactions.

docs/cpp/config-clang-mac.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Here is a sample of a `tasks.json` file on macOS:
163163
}
164164
```
165165

166-
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/editor/variables-reference.md).
166+
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/reference/variables-reference.md).
167167
168168
The `command` setting specifies the program to run. In this case, that is`clang++`.
169169

docs/cpp/config-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Your new `tasks.json` file should look similar to the JSON below:
164164
}
165165
```
166166

167-
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/editor/variables-reference.md).
167+
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/reference/variables-reference.md).
168168
169169
The `command` setting specifies the program to run; in this case that is g++.
170170
The `args` array specifies the command-line arguments that will be passed to g++. These arguments must be specified in the order expected by the compiler.

docs/cpp/config-mingw.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ Your new `tasks.json` file should look similar to the JSON below:
206206
}
207207
```
208208
209-
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/editor/variables-reference.md).
209+
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/reference/variables-reference.md).
210210
211211
The `command` setting specifies the program to run; in this case that is `g++`.
212212

docs/cpp/config-msvc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Your new `tasks.json` file should look similar to the JSON below:
175175
}
176176
```
177177

178-
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/editor/variables-reference.md).
178+
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/reference/variables-reference.md).
179179
180180
The `command` setting specifies the program to run; in this case that is "cl.exe". The `args` array specifies the command-line arguments that will be passed to cl.exe. These arguments must be specified in the order expected by the compiler.
181181

docs/cpp/config-wsl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Your new `tasks.json` file should look similar to the JSON below:
207207
}
208208
```
209209

210-
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/editor/variables-reference.md).
210+
>**Note**: You can learn more about `tasks.json` variables in the [variables reference](/docs/reference/variables-reference.md).
211211
212212
The `command` setting specifies the program to run; in this case that is g++.
213213
The `args` array specifies the command-line arguments that will be passed to g++. These arguments must be specified in the order expected by the compiler.

docs/editor/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Many debuggers support some of the following attributes:
285285

286286
VS Code makes commonly used paths and other values available as variables and supports variable substitution inside strings in `launch.json`. This means that you do not have to use absolute paths in debug configurations. For example, `${workspaceFolder}` gives the root path of a workspace folder, `${file}` the file open in the active editor, and `${env:Name}` the environment variable 'Name'.
287287

288-
You can see a full list of predefined variables in the [Variables Reference](/docs/editor/variables-reference.md) or by invoking IntelliSense inside the `launch.json` string attributes.
288+
You can see a full list of predefined variables in the [Variables Reference](/docs/reference/variables-reference.md) or by invoking IntelliSense inside the `launch.json` string attributes.
289289

290290
```json
291291
{

docs/editor/tasks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ For example, to bind `Ctrl+H` to the **Run tests** task from above, add the foll
464464

465465
## Variable substitution
466466

467-
When authoring tasks configurations, it is useful to have a set of predefined common variables such as the active file (`${file}`) or workspace root folder (`${workspaceFolder}`). VS Code supports variable substitution inside strings in the `tasks.json` file and you can see a full list of predefined variables in the [Variables Reference](/docs/editor/variables-reference.md).
467+
When authoring tasks configurations, it is useful to have a set of predefined common variables such as the active file (`${file}`) or workspace root folder (`${workspaceFolder}`). VS Code supports variable substitution inside strings in the `tasks.json` file and you can see a full list of predefined variables in the [Variables Reference](/docs/reference/variables-reference.md).
468468

469469
>**Note:** Not all properties will accept variable substitution. Specifically, only `command`, `args`, and `options` support variable substitution.
470470
@@ -503,7 +503,7 @@ If simple variable substitution isn't enough, you can also get input from the us
503503

504504
![Inputs Example](images/tasks/run-input-example.gif)
505505

506-
For more information about `inputs`, see the [Variables Reference](/docs/editor/variables-reference.md).
506+
For more information about `inputs`, see the [Variables Reference](/docs/reference/variables-reference.md).
507507

508508
## Operating system specific properties
509509

docs/editor/workspaces/multi-root-workspaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ You can also see the three **Add Config** commands for the folders, `tslint`, `t
210210

211211
![debugging template dropdown](images/multi-root-workspaces/add-launch-config.png)
212212

213-
[Variables](/docs/editor/variables-reference.md) used in a configuration (for example `${workspaceFolder}` or the now deprecated `${workspaceRoot}`) are resolved relative to the folder they belong to. It is possible to scope a variable per workspace folder by appending the root folder's name to a variable (separated by a colon).
213+
[Variables](/docs/reference/variables-reference.md) used in a configuration (for example `${workspaceFolder}` or the now deprecated `${workspaceRoot}`) are resolved relative to the folder they belong to. It is possible to scope a variable per workspace folder by appending the root folder's name to a variable (separated by a colon).
214214

215215
### Workspace launch configurations
216216

@@ -253,7 +253,7 @@ If the individual launch configuration names are not unique, the qualifying fold
253253
}]
254254
```
255255

256-
In addition to `compounds`, the `setting(launch)` section of the workspace configuration file can contain regular launch configurations too. Make sure that all used variables are explicitly scoped to a specific folder because otherwise they are not valid for the workspace. You can find more details about explicitly scoped variables in the [Variables Reference](/docs/editor/variables-reference.md#variables-scoped-per-workspace-folder).
256+
In addition to `compounds`, the `setting(launch)` section of the workspace configuration file can contain regular launch configurations too. Make sure that all used variables are explicitly scoped to a specific folder because otherwise they are not valid for the workspace. You can find more details about explicitly scoped variables in the [Variables Reference](/docs/reference/variables-reference.md#variables-scoped-per-workspace-folder).
257257

258258
Here is an example for a launch configuration where the program lives in a folder "Program" and where all files from a folder "Library" should be skipped when stepping:
259259

docs/python/settings-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ MetaSocialImage: images/tutorial/python-social.png
1212

1313
The Python Extension for Visual Studio Code is highly configurable. This page describes the key settings you can work with.
1414

15-
For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/editor/settings.md), as well as the [Variables reference](/docs/editor/variables-reference.md) for information about predefined variable support.
15+
For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/editor/settings.md), as well as the [Variables reference](/docs/reference/variables-reference.md) for information about predefined variable support.
1616

1717
## General Python settings
1818

@@ -195,7 +195,7 @@ The Python extension settings support predefined variables. Similar to the gener
195195
- **${selectedText}** - the current selected text in the active file
196196
- **${execPath}** - the path to the running VS Code executable
197197

198-
For additional information about predefined variables and example usages, see the [Variables reference](/docs/editor/variables-reference.md) in the general VS Code docs.
198+
For additional information about predefined variables and example usages, see the [Variables reference](/docs/reference/variables-reference.md) in the general VS Code docs.
199199

200200
## Next steps
201201

0 commit comments

Comments
 (0)