Skip to content

Commit 9c9f439

Browse files
authored
Update Change Waves env var in docs (#7909)
1 parent 0ccbfca commit 9c9f439

18 files changed

+63
-63
lines changed

documentation/wiki/ChangeWaves-Dev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A Change Wave is a set of risky features developed under the same opt-out flag.
77
Opt-out is a better approach for us because we'd likely get limited feedback when a feature impacts customer builds. When a feature does impact a customer negatively, it's a quick switch to disable and allows time to adapt. The key aspect to Change Waves is that it smooths the transition for customers adapting to risky changes that the MSBuild team feels strongly enough to take.
88

99
## How do They Work?
10-
The opt-out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the Change Wave (or version) that contains the feature you want **disabled**. This version happens to be the version of MSBuild that the features were developed for. See the mapping of change waves to features below.
10+
The opt-out comes in the form of setting the environment variable `MSBUILDDISABLEFEATURESFROMVERSION` to the Change Wave (or version) that contains the feature you want **disabled**. This version happens to be the version of MSBuild that the features were developed for. See the mapping of change waves to features below.
1111

1212
## Choosing a Change Wave for a New Feature
1313
This is determined on a case by case basis and should be discussed with the MSBuild team. A safe bet would be to check our [currently active Change Waves](ChangeWaves.md#change-waves-&-associated-features) and pick the version after the latest MSBuild version. This version corresponds to the latest version of Visual Studio.
@@ -56,7 +56,7 @@ If you need to condition a Task or Target, use the built in `AreFeaturesEnabled`
5656
```
5757
5858
## Test Your Feature
59-
Create tests as you normally would. Include one test with environment variable `MSBuildDisableFeaturesFromVersion` set to `ChangeWaves.Wave17_4`. Set this like so:
59+
Create tests as you normally would. Include one test with environment variable `MSBUILDDISABLEFEATURESFROMVERSION` set to `ChangeWaves.Wave17_4`. Set this like so:
6060
```c#
6161
using TestEnvironment env = TestEnvironment.Create();
6262

documentation/wiki/ChangeWaves.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ A Change Wave is a set of risky features developed under the same opt-out flag.
55
Opt-out is a better approach for us because we'd likely get limited feedback when a feature impacts customer builds. When a feature does impact a customer negatively, it's a quick switch to disable and allows time to adapt. The key aspect to Change Waves is that it smooths the transition for customers adapting to risky changes that the MSBuild team feels strongly enough to take.
66

77
## How do they work?
8-
The opt-out comes in the form of setting the environment variable `MSBuildDisableFeaturesFromVersion` to the Change Wave (or version) that contains the feature you want **disabled**. This version happens to be the version of MSBuild that the features were developed for. See the mapping of change waves to features below.
8+
The opt-out comes in the form of setting the environment variable `MSBUILDDISABLEFEATURESFROMVERSION` to the Change Wave (or version) that contains the feature you want **disabled**. This version happens to be the version of MSBuild that the features were developed for. See the mapping of change waves to features below.
99

1010
## When do they become permanent?
1111
A wave of features is set to "rotate out" (i.e. become standard functionality) two bands after its release. For example, wave 16.8 stayed opt-out through wave 16.10, becoming standard functionality when wave 17.0 is introduced.
1212

13-
## MSBuildDisableFeaturesFromVersion Values & Outcomes
14-
| `MSBuildDisableFeaturesFromVersion` Value | Result | Receive Warning? |
13+
## MSBUILDDISABLEFEATURESFROMVERSION Values & Outcomes
14+
| `MSBUILDDISABLEFEATURESFROMVERSION` Value | Result | Receive Warning? |
1515
| :------------- | :---------- | :----------: |
1616
| Unset | All Change Waves will be enabled, meaning all features behind each Change Wave will be enabled. | No |
1717
| Any valid & current Change Wave (Ex: `16.8`) | All features behind Change Wave `16.8` and higher will be disabled. | No |

src/Build.UnitTests/ChangeWaves_Tests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public ChangeWaves_Tests(ITestOutputHelper output)
2424
}
2525

2626
/// <summary>
27-
/// Performs necessary operations for setting the MSBuildDisableFeaturesFromVersion environment variable.
27+
/// Performs necessary operations for setting the MSBUILDDISABLEFEATURESFROMVERSION environment variable.
2828
/// This is required because Change Waves is static and stale values can be seen between tests in the same assembly.
2929
/// </summary>
3030
/// <param name="wave">The version to set as the current Change Wave.</param>
@@ -41,7 +41,7 @@ private void SetChangeWave(string wave, TestEnvironment env)
4141
/// </summary>
4242
/// <param name="testEnvironment">The TestEnvironment being used for this test.</param>
4343
/// <param name="versionToCheckAgainstCurrentChangeWave">The version to compare to the current set Change Wave.</param>
44-
/// <param name="currentChangeWaveShouldUltimatelyResolveTo">What the project property for the environment variable MSBuildDisableFeaturesFromVersion ultimately resolves to.</param>
44+
/// <param name="currentChangeWaveShouldUltimatelyResolveTo">What the project property for the environment variable MSBUILDDISABLEFEATURESFROMVERSION ultimately resolves to.</param>
4545
/// <param name="warningCodesLogShouldContain">An array of warning codes that should exist in the resulting log. Ex: "MSB4271".</param>
4646
private void buildSimpleProjectAndValidateChangeWave(TestEnvironment testEnvironment, Version versionToCheckAgainstCurrentChangeWave, Version currentChangeWaveShouldUltimatelyResolveTo, params string[] warningCodesLogShouldContain)
4747
{

src/Build/Resources/Strings.resx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,11 +322,11 @@
322322
</comment>
323323
</data>
324324
<data name="ChangeWave_InvalidFormat" xml:space="preserve">
325-
<value>MSB4271: Environment variable MSBuildDisableFeaturesFromVersion is set to an invalid format. Enabling all change wave versions. Entered value: {0}. Current Change Waves: {1}.</value>
325+
<value>MSB4271: Environment variable MSBUILDDISABLEFEATURESFROMVERSION is set to an invalid format. Enabling all change wave versions. Entered value: {0}. Current Change Waves: {1}.</value>
326326
<comment>{StrBegin="MSB4271: "}UE: Value should be of the format: xx.yy</comment>
327327
</data>
328328
<data name="ChangeWave_OutOfRotation" xml:space="preserve">
329-
<value>MSB4272: Environment variable MSBuildDisableFeaturesFromVersion is set to a version that is out of rotation. Defaulting to Change Wave version: {0}. Entered value: {1}. Current Change Waves: {2}.</value>
329+
<value>MSB4272: Environment variable MSBUILDDISABLEFEATURESFROMVERSION is set to a version that is out of rotation. Defaulting to Change Wave version: {0}. Entered value: {1}. Current Change Waves: {2}.</value>
330330
<comment>{StrBegin="MSB4272: "}</comment>
331331
</data>
332332
<data name="SearchPathsForMSBuildExtensionsPath" xml:space="preserve">

src/Build/Resources/xlf/Strings.cs.xlf

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Build/Resources/xlf/Strings.de.xlf

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Build/Resources/xlf/Strings.es.xlf

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Build/Resources/xlf/Strings.fr.xlf

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Build/Resources/xlf/Strings.it.xlf

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)