From 0ba54076b547a6eda1e19dc946e02f0bb3cf80e6 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 14:01:46 -0700 Subject: [PATCH 01/11] Add SVE diagnostic description --- .openpublishing.redirection.fundamentals.json | 4 ++++ .../source-generator-overview.md | 2 ++ .../syslib-diagnostics/syslib5003.md | 23 +++++++++++++++++++ docs/navigate/tools-diagnostics/toc.yml | 3 +++ 4 files changed, 32 insertions(+) create mode 100644 docs/fundamentals/syslib-diagnostics/syslib5003.md diff --git a/.openpublishing.redirection.fundamentals.json b/.openpublishing.redirection.fundamentals.json index c0c1dd8542380..5b5ea56405ee9 100644 --- a/.openpublishing.redirection.fundamentals.json +++ b/.openpublishing.redirection.fundamentals.json @@ -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" } ] } diff --git a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md index 2b34cfaf71162..767e68d8e6e7e 100644 --- a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md +++ b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md @@ -168,6 +168,7 @@ The following table provides an index to the `SYSLIB1XXX` diagnostics in .NET 6 | [SYSLIB1228][1228] | (Reserved for System.Text.Json.SourceGeneration.) | | [SYSLIB1229][1229] | (Reserved for System.Text.Json.SourceGeneration.) | | [SYSLIB1230][1230] | Deriving from a `GeneratedComInterface`-attributed interface defined in another assembly is not supported. | +| [SYSLIB5003][5003] | SVE is a preview feature can be used by enabling `EnablePreviewFeatures` flag. | [!INCLUDE [suppress-source-generator-diagnostics](includes/suppress-source-generator-diagnostics.md)] @@ -313,3 +314,4 @@ The following table provides an index to the `SYSLIB1XXX` diagnostics in .NET 6 [1228]: syslib1220-1229.md [1229]: syslib1220-1229.md [1230]: syslib1230.md +[5003]: syslib5003.md \ No newline at end of file diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md new file mode 100644 index 0000000000000..741ea87fb41aa --- /dev/null +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -0,0 +1,23 @@ +--- +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 first set of non-streaming SVE APIs were introduced as [[Experimental]](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute?view=net-9.0). If you are using these APIs in your project, enable the preview mode in your project using `EnablePreviewFeatures`. + +```csharp + + True + +``` + +[!INCLUDE [suppress-syslib-warning](includes/suppress-source-generator-diagnostics.md)] + +## See also + +- [Future work](https://devblogs.microsoft.com/dotnet/engineering-sve-in-dotnet/#8.-future) diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index b499f28ee9f60..c3148e0d39cd4 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -1902,6 +1902,9 @@ items: - name: SYSLIB1230 href: ../../fundamentals/syslib-diagnostics/syslib1230.md displayProperty: syslib1230, syslib1231, syslib1232, syslib1233, syslib1234, syslib1235, syslib1236, syslib1237, syslib1238, syslib1239 + - name: SYSLIB5003 + href: ../../fundamentals/syslib-diagnostics/syslib5003.md + displayProperty: syslib5003 - name: API compatibility items: - name: Overview From 0d15604317e5c084a7d48c5c64bf9d79ad828cb9 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 14:02:40 -0700 Subject: [PATCH 02/11] Update description --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index 741ea87fb41aa..3f2552af1918e 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -8,7 +8,7 @@ f1_keywords: # SYSLIB5003: SVE is a preview feature can be used by enabling EnablePreviewFeatures flag -In .NET 9 first set of non-streaming SVE APIs were introduced as [[Experimental]](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute?view=net-9.0). If you are using these APIs in your project, enable the preview mode in your project using `EnablePreviewFeatures`. +In .NET 9 first set of non-streaming SVE APIs were introduced as [[Experimental]](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute?view=net-9.0). 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, enable the preview mode in your project using `EnablePreviewFeatures`. ```csharp From c6ed8fb7cd888db036a4dd40e80303bc8790a32e Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 15:40:35 -0700 Subject: [PATCH 03/11] Update docs/fundamentals/syslib-diagnostics/syslib5003.md Co-authored-by: Jeff Handley --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index 3f2552af1918e..cb976c72a7b2e 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -8,7 +8,7 @@ f1_keywords: # SYSLIB5003: SVE is a preview feature can be used by enabling EnablePreviewFeatures flag -In .NET 9 first set of non-streaming SVE APIs were introduced as [[Experimental]](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute?view=net-9.0). 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, enable the preview mode in your project using `EnablePreviewFeatures`. +In .NET 9, the first set of non-streaming SVE APIs were introduced and annotated with the . 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. ```csharp From 6313c61c5a6095c8b28d141522ce55b4c79c33e4 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 15:40:53 -0700 Subject: [PATCH 04/11] Update docs/fundamentals/syslib-diagnostics/syslib5003.md Co-authored-by: Jeff Handley --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index cb976c72a7b2e..fc68394c9c440 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -10,13 +10,13 @@ f1_keywords: In .NET 9, the first set of non-streaming SVE APIs were introduced and annotated with the . 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. -```csharp - - True - -``` +To suppress the warnings in a project file: -[!INCLUDE [suppress-syslib-warning](includes/suppress-source-generator-diagnostics.md)] +```xml + + + $(NoWarn);SYSLIB5003 + ## See also From 9aead2db88eb7a023685f3cc3ef4e4d5c8a789a0 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 15:41:05 -0700 Subject: [PATCH 05/11] Update docs/fundamentals/syslib-diagnostics/syslib5003.md Co-authored-by: Jeff Handley --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index fc68394c9c440..bea56269bf069 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -20,4 +20,5 @@ To suppress the warnings in a project file: ## See also +- [Experimental features](experimental-overview.md) - [Future work](https://devblogs.microsoft.com/dotnet/engineering-sve-in-dotnet/#8.-future) From fe4d1bc4047bc8359d9d8f0551de160c1bc4d796 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 15:41:35 -0700 Subject: [PATCH 06/11] remove from source-generator-overview files --- .../syslib-diagnostics/source-generator-overview.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md index 767e68d8e6e7e..9e0317d53f4f4 100644 --- a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md +++ b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md @@ -168,7 +168,6 @@ The following table provides an index to the `SYSLIB1XXX` diagnostics in .NET 6 | [SYSLIB1228][1228] | (Reserved for System.Text.Json.SourceGeneration.) | | [SYSLIB1229][1229] | (Reserved for System.Text.Json.SourceGeneration.) | | [SYSLIB1230][1230] | Deriving from a `GeneratedComInterface`-attributed interface defined in another assembly is not supported. | -| [SYSLIB5003][5003] | SVE is a preview feature can be used by enabling `EnablePreviewFeatures` flag. | [!INCLUDE [suppress-source-generator-diagnostics](includes/suppress-source-generator-diagnostics.md)] @@ -313,5 +312,4 @@ The following table provides an index to the `SYSLIB1XXX` diagnostics in .NET 6 [1227]: syslib1220-1229.md [1228]: syslib1220-1229.md [1229]: syslib1220-1229.md -[1230]: syslib1230.md -[5003]: syslib5003.md \ No newline at end of file +[1230]: syslib1230.md \ No newline at end of file From 7f26fead94e682925552cae798f4201a3bf1c7ed Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 15:42:49 -0700 Subject: [PATCH 07/11] feedback --- docs/navigate/tools-diagnostics/toc.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/navigate/tools-diagnostics/toc.yml b/docs/navigate/tools-diagnostics/toc.yml index c3148e0d39cd4..0e91f070f6a65 100644 --- a/docs/navigate/tools-diagnostics/toc.yml +++ b/docs/navigate/tools-diagnostics/toc.yml @@ -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 @@ -1902,9 +1905,6 @@ items: - name: SYSLIB1230 href: ../../fundamentals/syslib-diagnostics/syslib1230.md displayProperty: syslib1230, syslib1231, syslib1232, syslib1233, syslib1234, syslib1235, syslib1236, syslib1237, syslib1238, syslib1239 - - name: SYSLIB5003 - href: ../../fundamentals/syslib-diagnostics/syslib5003.md - displayProperty: syslib5003 - name: API compatibility items: - name: Overview From efadf07aa29b018f30d6872368f647c9b564c3e1 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 1 Nov 2024 16:37:19 -0700 Subject: [PATCH 08/11] Update docs/fundamentals/syslib-diagnostics/syslib5003.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index bea56269bf069..551fc02dc8f71 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -8,7 +8,7 @@ f1_keywords: # 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 . 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. +In .NET 9, the first set of non-streaming SVE APIs were introduced and annotated with the . This attribute indicates that both the internal implementation and the generated code for SVE might undergo changes. These potential changes include 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're using these APIs in your project, you'll need to suppress the `SYSLIB5003` diagnostic. To suppress the warnings in a project file: From 2eb823f97dddbb5897bcfd9cd4befc031a5c9826 Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 8 Nov 2024 12:20:42 -0800 Subject: [PATCH 09/11] review comments --- .openpublishing.redirection.fundamentals.json | 4 ---- .../syslib-diagnostics/source-generator-overview.md | 2 +- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.openpublishing.redirection.fundamentals.json b/.openpublishing.redirection.fundamentals.json index 5b5ea56405ee9..c0c1dd8542380 100644 --- a/.openpublishing.redirection.fundamentals.json +++ b/.openpublishing.redirection.fundamentals.json @@ -568,10 +568,6 @@ { "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" } ] } diff --git a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md index 9e0317d53f4f4..2b34cfaf71162 100644 --- a/docs/fundamentals/syslib-diagnostics/source-generator-overview.md +++ b/docs/fundamentals/syslib-diagnostics/source-generator-overview.md @@ -312,4 +312,4 @@ The following table provides an index to the `SYSLIB1XXX` diagnostics in .NET 6 [1227]: syslib1220-1229.md [1228]: syslib1220-1229.md [1229]: syslib1220-1229.md -[1230]: syslib1230.md \ No newline at end of file +[1230]: syslib1230.md From 8376abf4b0feb8c9ac9a4fa4a6bb75ceeb4b638b Mon Sep 17 00:00:00 2001 From: Kunal Pathak Date: Fri, 8 Nov 2024 12:25:05 -0800 Subject: [PATCH 10/11] added link: --- docs/fundamentals/syslib-diagnostics/experimental-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fundamentals/syslib-diagnostics/experimental-overview.md b/docs/fundamentals/syslib-diagnostics/experimental-overview.md index f180077ce23e9..495e2afb4e0f8 100644 --- a/docs/fundamentals/syslib-diagnostics/experimental-overview.md +++ b/docs/fundamentals/syslib-diagnostics/experimental-overview.md @@ -21,7 +21,7 @@ The following table provides an index to the `SYSLIB5XXX` experimental APIs in . | - | - | - | | SYSLIB5001 | .NET 9 | and related APIs in are experimental | | SYSLIB5002 | .NET 9 | alternate colors are experimental | -| SYSLIB5003 | .NET 9 | is experimental | +| [SYSLIB5003](./syslib5003.md) | .NET 9 | is experimental | | SYSLIB5004 | .NET 9 | is experimental since performance is not as optimized as `T.DivRem` | | SYSLIB5005 | .NET 9 | is experimental | From 8fdf14ff2fb51504a79184db185ac8621e359382 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 8 Nov 2024 15:00:15 -0800 Subject: [PATCH 11/11] Update docs/fundamentals/syslib-diagnostics/syslib5003.md --- docs/fundamentals/syslib-diagnostics/syslib5003.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/fundamentals/syslib-diagnostics/syslib5003.md b/docs/fundamentals/syslib-diagnostics/syslib5003.md index 551fc02dc8f71..e21b1b330eebc 100644 --- a/docs/fundamentals/syslib-diagnostics/syslib5003.md +++ b/docs/fundamentals/syslib-diagnostics/syslib5003.md @@ -17,6 +17,7 @@ To suppress the warnings in a project file: $(NoWarn);SYSLIB5003 +``` ## See also