Skip to content

Add description how to embed linker XML files #1674

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

Merged
merged 4 commits into from
Dec 8, 2020

Conversation

vitek-karas
Copy link
Member

Some additional description of the various formats and when/how they can be used.

Some additional description of the various formats and when/how they can be used.
@vitek-karas vitek-karas added this to the .NET 6.0 milestone Dec 7, 2020
@vitek-karas vitek-karas self-assigned this Dec 7, 2020
The `fullname` attribute specifies the fullname of the type in the format specified by ECMA-335. This is in certain cases not the same as the one reported by Type.FullName for example for nested types.
Descriptors are used to direct linker to always keep some items in the assembly, regardless if linker can find any references to them.

Descriptor XML can be embedded in an assembly. In that case it must be stored as an embedded resource with logical name `ILLink.Descriptors.xml`. To achieve this when build an assembly use this in the project file to include the XML:
Copy link
Contributor

Choose a reason for hiding this comment

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

logical name sounds a bit offensive to me ;-)

Copy link
Member Author

Choose a reason for hiding this comment

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

That's an MSBuild terminology - I didn't come up with that 😞

@vitek-karas vitek-karas merged commit 7b82b56 into dotnet:master Dec 8, 2020
@vitek-karas vitek-karas deleted the EmbeddedXmlDocs branch December 8, 2020 16:48
agocke pushed a commit to dotnet/runtime that referenced this pull request Nov 16, 2022
Some additional description of the various formats and when/how they can be used.

Co-authored-by: Sven Boemer <[email protected]>

Commit migrated from dotnet/linker@7b82b56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants