Skip to content

Commit b727ffb

Browse files
authored
Improve Microsoft.Net.Sdk.Compilers.Toolset package description (dotnet#42212)
2 parents d29653c + d8b0b6a commit b727ffb

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

src/Microsoft.Net.Sdk.Compilers.Toolset/Microsoft.Net.Sdk.Compilers.Toolset.csproj

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,25 @@
22

33
<PropertyGroup>
44
<TargetFramework>$(SdkTargetFramework)</TargetFramework>
5-
<Description>Transport package for Microsoft.Net.Compilers.Toolset.Framework assemblies. For internal use only.</Description>
5+
<Description><![CDATA[
6+
Transport package for Microsoft.Net.Compilers.Toolset.Framework assemblies. For internal use only:
7+
do not reference this package directly as it is explicitly not supported in that fashion.
8+
9+
This package is automatically downloaded when your MSBuild version does not match your SDK version.
10+
Then the package is used to build your project with the compiler version matching your SDK version
11+
instead of the one bundled with MSBuild.
12+
13+
If you want to download this package using the dotnet CLI, you can use the following command:
14+
15+
```
16+
dotnet restore /p:BuildWithNetFrameworkHostedCompiler=true
17+
```
18+
19+
If you want to disable automatic download and use of this package, set property `BuildWithNetFrameworkHostedCompiler` to `false`
20+
(for example, in your `.csproj` or `Directory.Build.props` file).
21+
However, be aware that you will be building with mismatched compiler and SDK versions.
22+
That is explicitly not supported and can lead to errors (especially with analyzers and source generators).
23+
]]></Description>
624
<IsPackable>true</IsPackable>
725
<IsShippingPackage>true</IsShippingPackage>
826
<IncludeBuildOutput>false</IncludeBuildOutput>

0 commit comments

Comments
 (0)