Skip to content

Documentation of System.Runtime.Intrinsics missing #10382

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

Closed
Aniobodo opened this issue Sep 10, 2024 · 3 comments
Closed

Documentation of System.Runtime.Intrinsics missing #10382

Aniobodo opened this issue Sep 10, 2024 · 3 comments
Labels
area-System.Runtime.Intrinsics doc-bug Problem with the content; needs to be fixed Pri3 Indicates issues/PRs that are low priority

Comments

@Aniobodo
Copy link

The current descriptions regarding Vector APIs of System.Runtime.Intrinsics cannot be decribed as documentation.
Please add proper documentation with examples, expected results and explanation to all uncommon jargons.

@issues-automation issues-automation bot added the Pri3 Indicates issues/PRs that are low priority label Sep 10, 2024
@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Sep 10, 2024
@krwq
Copy link
Member

krwq commented May 6, 2025

cc: @tannergooding

@krwq krwq added the doc-bug Problem with the content; needs to be fixed label May 6, 2025
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics

@tannergooding
Copy link
Member

Duplicate of dotnet/runtime#81753

This is a legal problem. The documentation for the instructions, including the relevant psuedo-code describing how they operate, is copyrighted by the respective companies (Intel for Intel's docs, AMD for AMD's docs, etc). Due to the scale, explicit permissions are required to reproduce such documentation in our own.

There is then the additional consideration that our docs are normally creative commons, but this subset would likely not be, which adds its own complications to the process.

The current documentation does what we can and gives enough information for developers to refer to the architecture specific instruction manuals or documentation for more information on behavior.

@dotnet-policy-service dotnet-policy-service bot removed the untriaged New issue has not been triaged by the area owner label May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Runtime.Intrinsics doc-bug Problem with the content; needs to be fixed Pri3 Indicates issues/PRs that are low priority
Projects
None yet
Development

No branches or pull requests

3 participants