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

Add docs for SYSLIB5003 #43288

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .openpublishing.redirection.fundamentals.json
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,10 @@
{
"source_path_from_root": "/docs/fundamentals/networking/http/http-autoclient.md",
"redirect_url": "/dotnet/fundamentals/networking/http/http-overview"
},
{
"source_path_from_root": "/docs/fundamentals/syslib-diagnostics/syslib5003.md",
"redirect_url": "/dotnet/fundamentals/syslib-diagnostics/syslib5003"
Comment on lines +571 to +574
Copy link
Member

Choose a reason for hiding this comment

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

@gewarren Do we need this? I don't understand the logic for which pages need this and which don't.

Copy link
Contributor

Choose a reason for hiding this comment

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

No, this is only needed if you renamed or deleted a file after it was published.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks; this file can be reverted then.

}
]
}
Copy link
Member

Choose a reason for hiding this comment

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

For cleanliness, I suggest reverting this file (just a final line ending difference remains).

Original file line number Diff line number Diff line change
Expand Up @@ -312,4 +312,4 @@
[1227]: syslib1220-1229.md
[1228]: syslib1220-1229.md
[1229]: syslib1220-1229.md
[1230]: syslib1230.md
[1230]: syslib1230.md

Check failure on line 315 in docs/fundamentals/syslib-diagnostics/source-generator-overview.md

View workflow job for this annotation

GitHub Actions / lint

Files should end with a single newline character

docs/fundamentals/syslib-diagnostics/source-generator-overview.md:315:21 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md
24 changes: 24 additions & 0 deletions docs/fundamentals/syslib-diagnostics/syslib5003.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: SYSLIB5003 warning
description: Learn about the diagnostic that generates compile-time warning SYSLIB5003.
ms.date: 11/01/2024
f1_keywords:
- syslib5003
---

# SYSLIB5003: SVE is a preview feature can be used by enabling EnablePreviewFeatures flag

In .NET 9, the first set of non-streaming SVE APIs were introduced and annotated with the <xref:System.Diagnostics.CodeAnalysis.ExperimentalAttribute>. This indicates that both the internal implementation and the generated code for SVE may undergo changes. This includes potential modifications to method signatures, parameters, or namespaces in future updates, aimed at ensuring robust support for upcoming SVE technologies and streaming SVE designs. If you are using these APIs in your project, the `SYSLIB5003` diagnostic will need to be suppressed.
kunalspathak marked this conversation as resolved.
Show resolved Hide resolved

To suppress the warnings in a project file:

```xml
<PropertyGroup>
<!-- SYSLIB50003: System.Runtime.Intrinsics.Arm.Sve is experimental -->
<NoWarn>$(NoWarn);SYSLIB5003</NoWarn>
</PropertyGroup>

## See also

- [Experimental features](experimental-overview.md)
- [Future work](https://devblogs.microsoft.com/dotnet/engineering-sve-in-dotnet/#8.-future)
kunalspathak marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions docs/navigate/tools-diagnostics/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1809,6 +1809,9 @@ items:
- name: Overview
displayName: syslib, experimental
href: ../../fundamentals/syslib-diagnostics/experimental-overview.md
- name: SYSLIB5003
href: ../../fundamentals/syslib-diagnostics/syslib5003.md
displayProperty: syslib5003
- name: Source-generated code
items:
- name: Overview
Expand Down
Loading