Skip to content

Add package readmes to illink NuGet packages stating SDK-only support #123505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agocke merged 2 commits into from
Jan 23, 2026
Merged

Add package readmes to illink NuGet packages stating SDK-only support #123505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d3367a
Initial plan
Copilot Jan 22, 2026
010b6e0
Add PACKAGE.md readmes for illink packages stating SDK-only support
Copilot Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions src/tools/illink/src/ILLink.Tasks/ILLink.Tasks.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
<IncludeBuildOutput>false</IncludeBuildOutput>
<IncludeMultiTargetRoslynComponentTargets>false</IncludeMultiTargetRoslynComponentTargets>
<TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);AddBuildOutputToToolsPackage</TargetsForTfmSpecificContentInPackage>
<!-- TODO: Add package readme -->
<EnableDefaultPackageReadmeFile>false</EnableDefaultPackageReadmeFile>
<!-- Don't use the TFM but a short form of it without the version to simulate the package layout. -->
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<OutputPath Condition="'$(TargetFramework)' == '$(NetCoreAppToolCurrent)'">$(OutputPath)net\</OutputPath>
Expand Down
17 changes: 17 additions & 0 deletions src/tools/illink/src/ILLink.Tasks/PACKAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## About

MSBuild tasks for running the IL Linker to trim .NET applications.

## How to Use

Do not directly reference this package. It is used internally by the .NET SDK when projects enable trimming.

## Additional Documentation

- [Trim self-contained deployments and executables](https://learn.microsoft.com/dotnet/core/deploying/trimming/trim-self-contained)
- [Introduction to trim warnings](https://learn.microsoft.com/dotnet/core/deploying/trimming/fixing-warnings)
- [Prepare .NET libraries for trimming](https://learn.microsoft.com/dotnet/core/deploying/trimming/prepare-libraries-for-trimming)

## Feedback & Contributing

Microsoft.NET.ILLink.Tasks is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
1 change: 1 addition & 0 deletions src/tools/illink/src/linker/Mono.Linker.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
<TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);_AddReferenceAssemblyToPackage</TargetsForTfmSpecificContentInPackage>
<DefineConstants>$(DefineConstants);ILLINK</DefineConstants>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<EnableDefaultPackageReadmeFile>true</EnableDefaultPackageReadmeFile>
</PropertyGroup>

<Target Name="_ComputePackRuntimeConfigFilePath">
Expand Down
17 changes: 17 additions & 0 deletions src/tools/illink/src/linker/PACKAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## About

IL Linker tool for trimming .NET applications.

## How to Use

Do not directly reference this package. It is used internally by the .NET SDK when projects enable trimming.

## Additional Documentation

- [Trim self-contained deployments and executables](https://learn.microsoft.com/dotnet/core/deploying/trimming/trim-self-contained)
- [Introduction to trim warnings](https://learn.microsoft.com/dotnet/core/deploying/trimming/fixing-warnings)
- [Prepare .NET libraries for trimming](https://learn.microsoft.com/dotnet/core/deploying/trimming/prepare-libraries-for-trimming)

## Feedback & Contributing

Microsoft.NET.ILLink is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
Loading