forked from dotnet/runtime
-
Notifications
You must be signed in to change notification settings - Fork 1
Feedback for dotnet/runtime#76567 #5
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
steveharter
merged 4 commits into
steveharter:ReflectionReadme
from
jeffhandley:jeffhandley/readme-updates
Oct 6, 2022
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
0cf9219
Fix self-closing br tags
jeffhandley 748422f
Add more content to libraries root README; wordsmithing; fix links
jeffhandley c966e4d
Add more Deployment info. Update some formatting.
jeffhandley 259b709
Consistent verbiage around the shared framework
jeffhandley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,26 @@ | ||
| Each library typically has its own `README.md` that identifies its current development status: | ||
| # .NET Libraries | ||
|
|
||
| This folder contains the source and tests for the .NET Libraries. Different libraries are owned by different team members; refer to the (Areas)[../../docs/area-owners.md#areas] list for lead and owner information. | ||
|
|
||
| ## Development Statuses | ||
|
|
||
| Some libraries are under more active development than others. Depending on the library's status, expectations for issues and pull requests can vary. Check the library's folder for a `README.md` that declares the status for that library. Regardless of a library's status, refer to the [DOs and DON'Ts](../../CONTRIBUTING.md#dos-and-donts) and [Suggested Workflow](../../CONTRIBUTING.md#suggested-workflow) in our contribution guidelines before submitting a pull request. | ||
|
|
||
| - **Active** | ||
| - Under active development by the team | ||
| - PRs for both features and fixes will be considered and championed | ||
| - Issues will be considered for fix or addition to the backlog | ||
| - **Inactive** | ||
| - PRs for both features and fixes will be considered when aligned with current efforts | ||
| - **Inactive** | ||
| - Under minimal development; quality is maintained | ||
| - PRs for both features and fixes will be considered | ||
| - Issues will be considered for fix or addition to the backlog | ||
| - **Legacy** | ||
| - PRs for both features and fixes will be considered | ||
| - **Legacy** | ||
| - Not under development; maintained for compatibility | ||
| - Issues are likely to be closed without fixes | ||
| - PRs are unlikely to be accepted | ||
| - Issues are likely to be closed without fix | ||
|
|
||
| Regardless of a library's status, refer to the [DOs and DON'Ts](https://github.com/dotnet/runtime/blob/main/CONTRIBUTING.md#dos-and-donts) in our contribution guidelines before submitting a pull request. For **Active** or **Inactive** areas, external contributors can request being assigned to issues in a comment. | ||
| ## Deployment | ||
|
|
||
| Some libraries are included in the .NET SDK as part of the runtime's [shared framework](https://learn.microsoft.com/en-us/dotnet/standard/glossary#shared-framework). Other libraries are deployed as out-of-band (OOB) NuGet packages and need to be installed separately. | ||
|
|
||
| For more information, see the [Runtime libraries overview](https://learn.microsoft.com/en-us/dotnet/standard/runtime-libraries-overview). |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,9 @@ | ||
| # System.Reflection.Emit.ILGeneration | ||
| Contains types used with [`System.Reflection.Emit`](../system.reflection.emit.readme.md). | ||
| Contains types used with [`System.Reflection.Emit`](../System.Reflection.Emit/README.md). | ||
|
|
||
| The primary class is [`ILGenerator`](https://learn.microsoft.com/dotnet/api/system.reflection.emit.ilgenerator). | ||
|
|
||
| ## Status: [Inactive](../../libraries/README.md) | ||
| ## Status: [Inactive](../../libraries/README.md#development-statuses) | ||
|
|
||
| ## Deployment | ||
| Inbox</br> | ||
| [System.Reflection.Emit.ILGeneration NuGet Package](https://www.nuget.org/packages/System.Reflection.Emit.ILGeneration) | ||
| [System.Reflection.Emit.ILGeneration](https://www.nuget.org/packages/System.Reflection.Emit.ILGeneration) is included in the shared framework. |
10 changes: 10 additions & 0 deletions
10
src/libraries/System.Reflection.Emit.Lightweight/README.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # System.Reflection.Emit.Lightweight | ||
| The primary class is [`DynamicMethod`](https://learn.microsoft.com/dotnet/api/system.reflection.emit.DynamicMethod). | ||
|
|
||
| ## Status: [Inactive](../../libraries/README.md#development-statuses) | ||
|
|
||
| ## Deployment | ||
| [System.Reflection.Emit.Lightweight](https://www.nuget.org/packages/System.Reflection.Emit.Lightweight) is included in the shared framework. | ||
|
|
||
| ## See also | ||
| [`System.Reflection.Emit`](../System.Reflection.Emit/README.md) |
11 changes: 0 additions & 11 deletions
11
src/libraries/System.Reflection.Emit.Lightweight/readme.md
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,7 @@ | ||
| # System.Reflection.Extensions | ||
| This supports forwarding types to the runtime including [CustomAttributeExtensions](https://learn.microsoft.com/dotnet/api/system.reflection.CustomAttributeExtensions), [InterfaceMapping](https://learn.microsoft.com/dotnet/api/system.reflection.InterfaceMapping) and [RuntimeReflectionExtensions](https://learn.microsoft.com/dotnet/api/system.reflection.RuntimeReflectionExtensions). | ||
|
|
||
| ## Status: [Legacy](../../libraries/README.md) | ||
| ## Status: [Legacy](../../libraries/README.md#development-statuses) | ||
|
|
||
| ## Deployment | ||
| Inbox | ||
|
|
||
| [System.Reflection.Extensions](https://www.nuget.org/packages/System.Reflection.Extensions) is included in the shared framework. |
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
8 changes: 4 additions & 4 deletions
8
src/libraries/System.Reflection.MetadataLoadContext/README.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| # System.Reflection.MetadataLoadContext | ||
| This provides a high-level API for inspecting types given raw assembly contents according to ECMA-335. The types from a provided assembly are loaded into a[`MetadataLoadContext`](https://learn.microsoft.com/dotnet/api/system.reflection.metadataloadcontext) instance which returns `System.Type`, `System.MemberInfo`, etc. However, these reflection types do not support invocation and they are different instances from the types returned from runtime introspection. Because of this, this allows any assembly to be read, even if it's for a different platform provided that all assembly references are accounted for.</br> | ||
| This provides a high-level API for inspecting types given raw assembly contents according to ECMA-335. The types from a provided assembly are loaded into a[`MetadataLoadContext`](https://learn.microsoft.com/dotnet/api/system.reflection.metadataloadcontext) instance which returns `System.Type`, `System.MemberInfo`, etc. However, these reflection types do not support invocation and they are different instances from the types returned from runtime introspection. Because of this, this allows any assembly to be read, even if it's for a different platform provided that all assembly references are accounted for.<br/> | ||
|
|
||
| This library takes a dependency on `System.Reflection.Metadata` for reading the assembly. | ||
|
|
||
| ## Status: [Inactive](../system.reflection/overview.md#status) | ||
| The APIs and functionality are mature, but do get extended occasionally. | ||
|
|
||
| ## Source | ||
| https://github.com/dotnet/runtime/tree/main/src/libraries/System.Reflection.Metadata | ||
|
|
||
| * [../System.Reflection.Metadata](../System.Reflection.Metadata) | ||
|
|
||
| ## Deployment | ||
| Inbox</br> | ||
| https://www.nuget.org/packages/System.Reflection.MetadataLoadContext (contains full code for OOB scenarios). | ||
| [System.Reflection.MetadataLoadContext](https://www.nuget.org/packages/System.Reflection.MetadataLoadContext) NuGet package. |
4 changes: 2 additions & 2 deletions
4
...es/System.Reflection.Primitives/readme.md → ...es/System.Reflection.Primitives/README.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| # System.Reflection.Primitives | ||
| Contains reflection types such as [TypeAttributes](https://learn.microsoft.com/dotnet/api/system.reflection.typeattributes). Some of these types are forwarded to the runtime. In the future, the non-forwarded types may be lifted to the runtime and then type forwards added. | ||
|
|
||
| ## Status: [Legacy](../../libraries/README.md) | ||
| ## Status: [Legacy](../../libraries/README.md#development-statuses) | ||
|
|
||
| ## Deployment | ||
| Inbox | ||
| [System.Reflection.Primitives](https://www.nuget.org/packages/System.Reflection.Primitives) is part of the shared framework. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| # System.Reflection.TypeExtensions | ||
| This is a facade assembly that has extension methods for common reflection types. It was used in the past to expose common functionality across different runtimes in a uniform way. | ||
|
|
||
| ## Status: [Legacy](../../libraries/README.md) | ||
| ## Status: [Legacy](../../libraries/README.md#development-statuses) | ||
|
|
||
| ## Deployment | ||
| Inbox | ||
| [System.Reflection.TypeExtensions](https://www.nuget.org/packages/System.Reflection.TypeExtensions) is part of the shared framework. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.