Update MSBuild Server docs: enabled by default in .NET 11 SDK - #11420
Update MSBuild Server docs: enabled by default in .NET 11 SDK#11420Jan Provazník (JanProvaznik) wants to merge 1 commit into
Conversation
MSBuild Server is enabled by default for MSBuild-based .NET CLI commands starting with the .NET 11 SDK (dotnet/sdk#55231). - Document the new default and how to opt out with DOTNET_CLI_USE_MSBUILD_SERVER=false. - Remove the change wave 17.4 opt-out. Wave 17.4 has left the current change wave rotation, so setting MSBuildDisableFeaturesFromVersion=17.4 no longer disables the server and instead enables all features. - Note that -mt (multithreaded) builds engage MSBuild Server, and that incompatible invocations such as -help, -version, and binary log replay fall back to an in-process build. - Add guidance on inspecting server status via -v:diag or a binary log. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b3a0ade9-f512-4290-ac92-d8b23053a4ec
|
Microsoft authors of articles need to make updates through the private repository, so the updates can be staged and validated by current validation rules. After you review staging and fix all validation issues, you can add the sign-off comment to let the PR reviewers know the updates are ready to be merged. It's easy to access the private repo version of your articles in GitHub. Just add -pr to the URL, as follows: Public repo URL: We have closed this pull request. Please resubmit the updates through the private repo. For more information, see the contributor guide. |
|
Learn Build status updates of commit 6914efa: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
Summary
MSBuild Server is enabled by default for MSBuild-based .NET CLI commands (
dotnet build,dotnet msbuild) starting with the .NET 11 SDK. This page still described it as opt-in, and its opt-out guidance is now out of date. See dotnet/sdk#55231 (milestone11.0-preview7), which flipsDOTNET_CLI_USE_MSBUILD_SERVERto defaulttrue.Changes
## Enable MSBuild Serverdocuments the .NET 11 default and keeps a sentence about the previous opt-in behavior for readers on earlier SDKs.SET MSBuildDisableFeaturesFromVersion=17.4is now treated as out of rotation and enables all features rather than disabling MSBuild Server. Following the old instruction produces the opposite of the intended effect. MSBuild Server is no longer change-wave gated at all.DOTNET_CLI_USE_MSBUILD_SERVERis documented asfalse.-mt. Multithreaded builds engage MSBuild Server, because multithreaded execution runs project work inside the server process.-help,-version, binary log replay) fall back to building in the launching process.-v:diagor in a binary log.Verification
Claims were checked against the MSBuild implementation on
main:MSBuildForwardingAppWithoutLogging.csin dotnet/sdk (DOTNET_CLI_USE_MSBUILD_SERVERdefaults totrue;MSBUILDUSESERVERis only set when the user has not set it).CommunicationsUtilities.NodeConnectionTimeout(900 * 1000ms)./nodemode:8:NodeMode.OutOfProcServerNode = 8.ChangeWaves.AllWavescurrently starts at 17.10, so 17.4 is out of rotation.-mtimplies server:XMake.ShouldUseMSBuildServer.Notes for reviewers
ms.daterefreshed;author/ms.authorupdated to the current owner..NET 11timing statement is forward-looking; everything else describes shipped behavior.