Adjust remarks for Assembly.Load on .NET Core #9764
Conversation
This file contains 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
|
Learn Build status updates of commit 38029a8:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Reflection/Assembly.xml | View | Details |
xml/System.Reflection/Assembly.xml
- Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
jkotas
reviewed
Mar 26, 2024
xml/System.Reflection/Assembly.xml
Outdated
|
|
||
| This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later. | ||
|
|
||
| The assembly is loaded into the default AssemblyLoadContext. |
There was a problem hiding this comment.
This overload throws NotSupportedException in .NET Core 2.0+:
jkotas
reviewed
Mar 26, 2024
xml/System.Reflection/Assembly.xml
Outdated
|
|
||
| ## Remarks | ||
|
|
||
| This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later. |
There was a problem hiding this comment.
I am not sure about this recommendation for the Assembly.Load overloads that take AssemblyName or assembly name string. I do not think that these overloads are problematic and it is typically fine to use them even in .NET Core 2.0+.
There was a problem hiding this comment.
My assumption is that the typical caller of these Assembly.Load overloads wants to load the assembly into its own context. The explicit replacement of Assembly.Load(assemblyName) is AssemblyLoadContext.GetLoadContext(Assembly.GetExecutingAssembly())!.LoadFromAssemblyName(assemblyName) that is way more complicated.
jkotas
reviewed
Mar 26, 2024
xml/System.Reflection/Assembly.xml
Outdated
|
|
||
| This API is present in .NET Core for compatibility, but it is recommended to use <xref:System.Reflection.AssemblyLoadContext> overloads in .NET Core 2.0 and later. | ||
|
|
||
| The assembly is loaded into the current AssemblyLoadContext. |
There was a problem hiding this comment.
gewarren
requested changes
Mar 28, 2024
xml/System.Reflection/Assembly.xml
Outdated
| @@ -4128,7 +4128,17 @@ Note: In <see href="https://go.microsoft.com/fwlink/?LinkID=247912">.NET for Win | |||
| <param name="assemblyString">The long or short form of the assembly name.</param> | |||
| <summary>Loads an assembly with the specified name.</summary> | |||
| <returns>The loaded assembly.</returns> | |||
| <remarks> | |||
| <remarks FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;net-5.0;net-6.0;net-7.0;net-8.0;net-9.0"> | |||
There was a problem hiding this comment.
Remarks can't be versioned like this unfortunately. You just have to annotate them in the text itself where they are version specific.
dotnet-policy-service
bot
added
the
needs-author-action
dotnet-policy-service
bot
removed
the
needs-author-action
jkotas
reviewed
Apr 16, 2024
| @@ -4041,6 +4041,9 @@ This property is marked obsolete starting in .NET 5, and generates a compile-tim | |||
| <format type="text/markdown"><![CDATA[ | |||
|
|
|||
| ## Remarks | |||
|
|
|||
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |||
There was a problem hiding this comment.
Suggested change
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |
| In .NET Core/5+, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. |
| @@ -4132,6 +4135,9 @@ Note: In <see href="https://go.microsoft.com/fwlink/?LinkID=247912">.NET for Win | |||
| <format type="text/markdown"><![CDATA[ | |||
|
|
|||
| ## Remarks | |||
|
|
|||
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |||
There was a problem hiding this comment.
Suggested change
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |
| In .NET Core/5+, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. |
| @@ -4236,6 +4242,8 @@ To load the correct assembly, it's recommended to call the `Load` method by pass | |||
|
|
|||
| ## Remarks | |||
|
|
|||
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |||
There was a problem hiding this comment.
Suggested change
| In .NET Core 2.0 and later, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. | |
| In .NET Core/5+, the target assembly will be loaded into the current <xref:System.Runtime.Loader.AssemblyLoadContext>. For more information on assembly loading, see <see cref="https://learn.microsoft.com/en-us/dotnet/core/dependency-loading/loading-managed#algorithm" />. |
| The `assemblyFile` parameter must refer to a URI without escape characters. This method supplies escape characters for all invalid characters in the URI. | ||
|
|
||
| Before .NET 5, the following applied: |
There was a problem hiding this comment.
Suggested change
| Before .NET 5, the following applied: | |
| In .NET Framework, the following applied: |
Comment on lines
+5069
to
+5072
| This API is not supported in .NET Core 2.0 or later. It will always throw <xref:System.NotSupportedException>. | ||
|
|
||
| The assembly is loaded into the default AssemblyLoadContext. | ||
|
|
There was a problem hiding this comment.
Suggested change
| This API is not supported in .NET Core 2.0 or later. It will always throw <xref:System.NotSupportedException>. | |
| The assembly is loaded into the default AssemblyLoadContext. | |
| This API is not supported in .NET Core/5+. It will always throw <xref:System.NotSupportedException>. | |
|
Learn Build status updates of commit 3610c3e:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Reflection/Assembly.xml | View | Details |
xml/System.Reflection/Assembly.xml
- Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: xref-not-found - See documentation]
Cross reference not found: 'System.Reflection.AssemblyLoadContext'. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit e78a4cc:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Reflection/Assembly.xml | View | Details |
xml/System.Reflection/Assembly.xml
- Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. - Line 0, Column 0: [Warning: disallowed-html-tag - See documentation]
HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The existing docs are only valid for .NET Framework.
Fixes #9765