Update trimmer docs to include warning IL3003 #27644
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please also add an entry to https://github.com/dotnet/docs/blob/main/docs/fundamentals/toc.yml. |
tlakollo
reviewed
Dec 22, 2021
| } | ||
| void TestMethod() | ||
| { | ||
| // IL3002: Using member 'MethodWithAssemblyFilesUsage' which has 'RequiresAssemblyFilesAttribute' |
tlakollo
reviewed
Dec 22, 2021
Comment on lines
+13
to
+17
| | | Value | | ||
| |-------------------------------------|--------------------------------------| | ||
| | **Rule ID** | IL3003 | | ||
| | **Category** | [SingleFile](singlefile-warnings.md) | | ||
| | **Fix is breaking or non-breaking** | Non-breaking | |
There was a problem hiding this comment.
This table looks different from other docs, I think we should be consistent
vitek-karas
reviewed
Dec 23, 2021
|
|
||
| ## Cause | ||
|
|
||
| When publishing as a single file (for example, by setting the PublishSingleFile property in a project to true), interface implementations or derived classes with members that don't have matching annotations of `[RequiresAssemblyFiles]` can lead to calling an unsafe member with the attribute. There are four possible scenarios where the warning can be generated: |
There was a problem hiding this comment.
In general, please avoid "Safe"/"Unsafe" wording - it feels too much like security related. For trimming we've been trying to use "trim compatible", we can do the same for single-file.
tlakollo
reviewed
Dec 27, 2021
|
|
||
| When publishing as a single file (for example, by setting the PublishSingleFile property in a project to true), calling the `Assembly.GetFile(s)` methods for | ||
| assemblies embedded inside the single-file bundle always throws an exception. | ||
| assemblies embedded inside the single-file bundle always throws an exception, as these methods are not trim compatible. |
There was a problem hiding this comment.
Sorry for the confusion, although Vitek mentioned that the wording safe/unsafe is something we want to avoid, the term trim compatible does not apply for single file, since trimming is an independent process that might or might not be executed for single-file apps. The term to document would be 'single-file compatible'
vitek-karas
reviewed
Jan 7, 2022
| ## Cause | ||
|
|
||
| When publishing an app as a single file (for example, by setting the `PublishSingleFile` property in a project to `true`), calling members annotated with the `RequiresAssemblyFilesAttribute` attribute might be unsafe. These calls can be unsafe because members annotated with this attribute require assembly files to be on disk, and the assemblies embedded in a single-file app are memory loaded. | ||
| When publishing an app as a single file (for example, by setting the `PublishSingleFile` property in a project to `true`), calling members annotated with the `RequiresAssemblyFilesAttribute` attribute is not trim compatible. These calls is not trim compatible because members annotated with this attribute require assembly files to be on disk, and the assemblies embedded in a single-file app are memory loaded. |
There was a problem hiding this comment.
This still talks about "Trim compatible" - but it's about single-file.
vitek-karas
approved these changes
Jan 7, 2022
gewarren
reviewed
Jan 7, 2022
Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the docs related to the trimmer to include info about warning IL3003