Skip to content
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

Porting new docs for the System.Runtime.Intrinsics namespace #9166

Merged
merged 7 commits into from
Jul 27, 2023

Conversation

tannergooding
Copy link
Member

This handles most of dotnet/runtime#88574. There are some APIs that are missing xml docs entirely that still need to be handled.

@ghost
Copy link

ghost commented Jul 25, 2023

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics
See info in area-owners.md if you want to be subscribed.

Issue Details

This handles most of dotnet/runtime#88574. There are some APIs that are missing xml docs entirely that still need to be handled.

Author: tannergooding
Assignees: tannergooding
Labels:

area-System.Runtime.Intrinsics

Milestone: -

@learn-build-service-prod

This comment was marked as outdated.

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Thanks @tannergooding. I assume for these APIs we mainly care about the summary. Two questions:

  • Are you ok with the formatting of the summaries as they were ported?
  • Do you plan on adding the missing params, returns, and other non-summary elements?

If the answer is yes to both, let's merge.

@tannergooding
Copy link
Member Author

Are you ok with the formatting of the summaries as they were ported?

There's meant to be two lines, each with their own surrounding <para></para>. Will need to update those

Do you plan on adding the missing params, returns, and other non-summary elements?

They should exist for types directly in System.Runtime.Intrinsics. For types in System.Runtime.Intrinsics.Arm64 and System.Runtime.Intrinsics.X86 they are "intentionally" missing, as the correct descriptions are copyright the respective companies and need permission to reproduce. So having the minimal summary that lists the underlying instruction and corresponding native API is how all the APIs are currently handled.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod
Copy link

Learn Build status updates of commit afd94bb:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Sse3.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64`1.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Looks much better with the <para> that were missing. Thanks for re-running the tool.

xml/System.Runtime.Intrinsics.X86/Avx512BW.xml Outdated Show resolved Hide resolved
xml/System.Runtime.Intrinsics.X86/Avx512CD.xml Outdated Show resolved Hide resolved
xml/System.Runtime.Intrinsics.X86/Avx512DQ.xml Outdated Show resolved Hide resolved
xml/System.Runtime.Intrinsics.X86/Avx512F.xml Show resolved Hide resolved
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml Outdated Show resolved Hide resolved
xml/System.Runtime.Intrinsics/Vector512`1.xml Outdated Show resolved Hide resolved
@learn-build-service-prod
Copy link

Learn Build status updates of commit 3916983:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Sse3.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64`1.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link

Learn Build status updates of commit ea2f581:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Sse3.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64`1.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Co-authored-by: Genevieve Warren <[email protected]>
@learn-build-service-prod
Copy link

Learn Build status updates of commit 6de71a7:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Runtime.Intrinsics.Arm/AdvSimd.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.Arm/AdvSimd+Arm64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512BW+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512CD+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512DQ+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512F+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Avx512Vbmi+VL.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/Sse3.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base.xml ✅Succeeded View
xml/System.Runtime.Intrinsics.X86/X86Base+X64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector128`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector256`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector512`1.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64.xml ✅Succeeded View
xml/System.Runtime.Intrinsics/Vector64`1.xml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@tannergooding tannergooding merged commit 6c1d5b6 into dotnet:main Jul 27, 2023
2 checks passed
@tannergooding tannergooding deleted the runtime-88574 branch July 27, 2023 18:11
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.

3 participants