Mark the System.Formats.Nrbf assembly as [Experimental] with SYSLIB5005 #107905
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
dotnet-issue-labeler
bot
added
needs-area-label
jeffhandley
added
binaryformatter-migration
This comment was marked as resolved.
This comment was marked as resolved.
|
Tagging subscribers to 'binaryformatter-migration': @adamsitnik, @bartonjs, @jeffhandley, @terrajobst |
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| [assembly: System.Diagnostics.CodeAnalysis.ExperimentalAttribute("SYSLIB5005", UrlFormat = "https://aka.ms/dotnet-warnings/{0}")] |
There was a problem hiding this comment.
Huh, we don't have any kind of description on experimental that provides more detail in the diagnostic. I thought we did. Should we look at adding that? Someone can go to the docs, but it'd be nice if the message here could say that it's fully supported but the shape might change.
There was a problem hiding this comment.
I thought we did too until I did one of the earlier experimentals. But yeah, that API doesn't have a message attribute; it always uses a message from Roslyn. I'll submit an API suggestion to add it.
|
/backport to release/9.0-rc2 |
|
Started backporting to release/9.0-rc2: https://github.com/dotnet/runtime/actions/runs/10911050092 |
This marks the entire assembly for
System.Formats.Nrbfas[Experimental], claiming the diagnostic ID ofSYSLIB5005for it as the API shape is subject to change in .NET 10.Because the package has down-level targets, we include an internal copy of
ExperimentalAttributefor versions earlier than .NET 8 when the attribute was introduced. VS 17.11 respects the internal attribute and provides the same experience for showing the diagnostic, even when targeting .NET Framework and using the package.While making this change, I noticed the
<EnableDefaultPackageReadmeFile>property was still set tofalseand thePACKAGE.mdfile was therefore not being used in the NuGet package. That has been corrected.Before we merge this PR, we will merge PRs for dotnet/winforms and dotnet/wpf to suppress the
SYSLIB5005diagnostic where these APIs are referenced. We plan to backport this change torelease/9.0andrelease/9.0-rc2.