Skip to content
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.

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

Update System.Formats.Nrbf ref sources and restore package description #108430

Merged
merged 4 commits into from
Oct 2, 2024

Conversation

jeffhandley
Copy link
Member

In Mark the System.Formats.Nrbf assembly as [Experimental] with SYSLIB5005 (#107905), the System.Formats.Nrbf package description was removed entirely rather than being shortened. This restores the short package description that is used in tooling when the full package README isn't displayed.

I also found the ref source for System.Formats.Nrbf and System.Reflection.Metadata was out of sync. It looks like the files were hand-edited and there were a few details missing along with inconsistencies compared to what dotnet msbuild /t:GenerateReferenceAssemblySource generates.

The intention is to make these corrections for .NET 9, backporting to release/9.0 after merged to main.

@jeffhandley jeffhandley added binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it area-System.Formats.Nrbf labels Oct 1, 2024
@jeffhandley jeffhandley self-assigned this Oct 1, 2024

This comment was marked as resolved.

1 similar comment

This comment was marked as duplicate.

Copy link
Contributor

Tagging subscribers to 'binaryformatter-migration': @adamsitnik, @bartonjs, @jeffhandley, @terrajobst

Copy link
Contributor

@buyaa-n buyaa-n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a NIT, overall LGTM

Copy link
Member

@ericstj ericstj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - keeping in sync with the output of GenAPI will make this easier to maintain and ensure you don't miss things that APICompat doesn't yet catch.

@jeffhandley jeffhandley merged commit 3ca4ec8 into dotnet:main Oct 2, 2024
83 of 85 checks passed
@jeffhandley jeffhandley deleted the jeffhandley/nrbf-docs-ref branch October 2, 2024 03:22
@jeffhandley
Copy link
Member Author

/backport to release/9.0

Copy link
Contributor

github-actions bot commented Oct 2, 2024

Started backporting to release/9.0: https://github.com/dotnet/runtime/actions/runs/11137272638

sirntar pushed a commit to sirntar/runtime that referenced this pull request Oct 3, 2024
dotnet#108430)

* Restore System.Formats.Nrbf package description alongside package README

* Add missing struct members to ref source

* Update ref to match dotnet msbuild /t:GenerateReferenceAssemblySource

* Remove 'EnableDefaultPackageReadmeFile' since 'true' is the default
lambdageek pushed a commit to lambdageek/runtime that referenced this pull request Oct 3, 2024
dotnet#108430)

* Restore System.Formats.Nrbf package description alongside package README

* Add missing struct members to ref source

* Update ref to match dotnet msbuild /t:GenerateReferenceAssemblySource

* Remove 'EnableDefaultPackageReadmeFile' since 'true' is the default
@github-actions github-actions bot locked and limited conversation to collaborators Nov 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Formats.Nrbf binaryformatter-migration Issues related to the removal of BinaryFormatter and migrations away from it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants