From 1a625c9162fd62f3ecf52c7c6e76dbb23ab26671 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 14:15:16 +0000 Subject: [PATCH 1/8] .NET dependabot-bot automated PR. (#44651) Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com> --- .github/dependabot.yml | 66 +++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 0e3e379164501..9f19add8ca327 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -8,6 +8,17 @@ updates: interval: "weekly" day: "wednesday" open-pull-requests-limit: 10 + - package-ecosystem: "nuget" + directory: "/docs/azure/sdk/snippets/authentication/best-practices" #BestPractices.sln + schedule: + interval: "weekly" + day: "wednesday" + open-pull-requests-limit: 5 + groups: + # Group .NET updates together for solutions. + dotnet: + patterns: + - "*" # Prefer a single PR per solution update. - package-ecosystem: "nuget" directory: "/docs/core/extensions/snippets/caching" #caching.sln schedule: @@ -767,6 +778,17 @@ updates: dotnet: patterns: - "*" # Prefer a single PR per project update. + - package-ecosystem: "nuget" + directory: "/docs/ai/how-to/snippets/hosted-app-auth" #hosted-app-auth.csproj + schedule: + interval: "weekly" + day: "wednesday" + open-pull-requests-limit: 5 + groups: + # Group .NET updates together for projects. + dotnet: + patterns: + - "*" # Prefer a single PR per project update. - package-ecosystem: "nuget" directory: "/docs/ai/how-to/snippets/semantic-kernel" #semantic-kernel.csproj schedule: @@ -778,6 +800,17 @@ updates: dotnet: patterns: - "*" # Prefer a single PR per project update. + - package-ecosystem: "nuget" + directory: "/docs/ai/quickstarts/snippets/assistants" #AIAssistants.csproj + schedule: + interval: "weekly" + day: "wednesday" + open-pull-requests-limit: 5 + groups: + # Group .NET updates together for projects. + dotnet: + patterns: + - "*" # Prefer a single PR per project update. - package-ecosystem: "nuget" directory: "/docs/ai/quickstarts/snippets/build-chat-app/azure-openai" #ChatAppAI.csproj schedule: @@ -2164,36 +2197,3 @@ updates: dotnet: patterns: - "*" # Prefer a single PR per project update. - - package-ecosystem: "nuget" - directory: "/docs/devops/snippets/create-dotnet-github-action/DotNet.GitHubAction" #DotNet.GitHubAction.csproj - schedule: - interval: "weekly" - day: "wednesday" - open-pull-requests-limit: 5 - groups: - # Group .NET updates together for projects. - dotnet: - patterns: - - "*" # Prefer a single PR per project update. - - package-ecosystem: "nuget" - directory: "/docs/framework/migration-guide/snippets/csharp" #FrameworkVersions.csproj - schedule: - interval: "weekly" - day: "wednesday" - open-pull-requests-limit: 5 - groups: - # Group .NET updates together for projects. - dotnet: - patterns: - - "*" # Prefer a single PR per project update. - - package-ecosystem: "nuget" - directory: "/docs/framework/migration-guide/snippets/visual-basic" #FrameworkVersions.vbproj - schedule: - interval: "weekly" - day: "wednesday" - open-pull-requests-limit: 5 - groups: - # Group .NET updates together for projects. - dotnet: - patterns: - - "*" # Prefer a single PR per project update. From 8b356839529e80f268dbabd318fcf1b286502f15 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:46:37 -0600 Subject: [PATCH 2/8] Bump the dotnet group (#44661) Bumps the dotnet group in /docs/azure/sdk/snippets/authentication/best-practices with 3 updates: [Azure.Storage.Blobs](https://github.com/Azure/azure-sdk-for-net), [Azure.Identity](https://github.com/Azure/azure-sdk-for-net) and [Microsoft.Extensions.Azure](https://github.com/Azure/azure-sdk-for-net). Updates `Azure.Storage.Blobs` from 12.21.2 to 12.23.0 - [Release notes](https://github.com/Azure/azure-sdk-for-net/releases) - [Commits](https://github.com/Azure/azure-sdk-for-net/compare/Azure.Storage.Blobs_12.21.2...Azure.Storage.Blobs_12.23.0) Updates `Azure.Identity` from 1.13.2 to 1.13.1 - [Release notes](https://github.com/Azure/azure-sdk-for-net/releases) - [Commits](https://github.com/Azure/azure-sdk-for-net/compare/Azure.Identity_1.13.2...Azure.Identity_1.13.1) Updates `Microsoft.Extensions.Azure` from 1.7.5 to 1.9.0 - [Release notes](https://github.com/Azure/azure-sdk-for-net/releases) - [Commits](https://github.com/Azure/azure-sdk-for-net/compare/Microsoft.Extensions.Azure_1.7.5...Microsoft.Extensions.Azure_1.9.0) --- updated-dependencies: - dependency-name: Azure.Storage.Blobs dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dotnet - dependency-name: Azure.Identity dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet - dependency-name: Microsoft.Extensions.Azure dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dotnet ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../sdk/snippets/authentication/Directory.Packages.props | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/azure/sdk/snippets/authentication/Directory.Packages.props b/docs/azure/sdk/snippets/authentication/Directory.Packages.props index 64bda2aecce28..05daaa25dffd4 100644 --- a/docs/azure/sdk/snippets/authentication/Directory.Packages.props +++ b/docs/azure/sdk/snippets/authentication/Directory.Packages.props @@ -4,11 +4,11 @@ - + - + From 76e0ffd052772eff504571863741ad6bb2060ad1 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 3 Feb 2025 08:18:06 -0800 Subject: [PATCH 3/8] Improvements for CA config options (#44647) --- .../code-quality-rule-options.md | 232 +++++++++++------- .../code-analysis/includes/api-surface.md | 10 - .../includes/config-options/api-surface.md | 10 + .../dispose-ownership-transfer.md | 51 ++++ .../excluded-symbol-names.md | 4 +- .../excluded-type-names-with-derived-types.md | 6 +- .../includes/config-options/ignore-ivt.md | 12 + .../code-analysis/includes/ignore-ivt.md | 12 - .../code-analysis/quality-rules/ca1000.md | 2 +- .../code-analysis/quality-rules/ca1001.md | 4 +- .../code-analysis/quality-rules/ca1002.md | 2 +- .../code-analysis/quality-rules/ca1003.md | 2 +- .../code-analysis/quality-rules/ca1005.md | 2 +- .../code-analysis/quality-rules/ca1008.md | 5 +- .../code-analysis/quality-rules/ca1010.md | 4 +- .../code-analysis/quality-rules/ca1012.md | 2 +- .../code-analysis/quality-rules/ca1021.md | 2 +- .../code-analysis/quality-rules/ca1024.md | 2 +- .../code-analysis/quality-rules/ca1027.md | 2 +- .../code-analysis/quality-rules/ca1028.md | 2 +- .../code-analysis/quality-rules/ca1030.md | 2 +- .../code-analysis/quality-rules/ca1031.md | 2 +- .../code-analysis/quality-rules/ca1036.md | 2 +- .../code-analysis/quality-rules/ca1040.md | 2 +- .../code-analysis/quality-rules/ca1041.md | 2 +- .../code-analysis/quality-rules/ca1043.md | 2 +- .../code-analysis/quality-rules/ca1044.md | 2 +- .../code-analysis/quality-rules/ca1045.md | 2 +- .../code-analysis/quality-rules/ca1046.md | 2 +- .../code-analysis/quality-rules/ca1047.md | 2 +- .../code-analysis/quality-rules/ca1051.md | 4 +- .../code-analysis/quality-rules/ca1052.md | 2 +- .../code-analysis/quality-rules/ca1054.md | 8 +- .../code-analysis/quality-rules/ca1055.md | 8 +- .../code-analysis/quality-rules/ca1056.md | 8 +- .../code-analysis/quality-rules/ca1058.md | 2 +- .../code-analysis/quality-rules/ca1062.md | 17 +- .../code-analysis/quality-rules/ca1063.md | 2 +- .../code-analysis/quality-rules/ca1068.md | 8 +- .../code-analysis/quality-rules/ca1070.md | 2 +- .../code-analysis/quality-rules/ca1303.md | 15 +- .../code-analysis/quality-rules/ca1304.md | 6 +- .../code-analysis/quality-rules/ca1305.md | 6 +- .../code-analysis/quality-rules/ca1508.md | 15 +- .../code-analysis/quality-rules/ca1700.md | 2 +- .../code-analysis/quality-rules/ca1707.md | 2 +- .../code-analysis/quality-rules/ca1708.md | 2 +- .../code-analysis/quality-rules/ca1710.md | 52 ++-- .../code-analysis/quality-rules/ca1711.md | 32 +-- .../code-analysis/quality-rules/ca1714.md | 2 +- .../code-analysis/quality-rules/ca1715.md | 16 +- .../code-analysis/quality-rules/ca1716.md | 4 +- .../code-analysis/quality-rules/ca1717.md | 2 +- .../code-analysis/quality-rules/ca1720.md | 2 +- .../code-analysis/quality-rules/ca1721.md | 2 +- .../code-analysis/quality-rules/ca1725.md | 2 +- .../code-analysis/quality-rules/ca1801.md | 2 +- .../code-analysis/quality-rules/ca1802.md | 4 +- .../code-analysis/quality-rules/ca1806.md | 3 - .../code-analysis/quality-rules/ca1812.md | 2 +- .../code-analysis/quality-rules/ca1815.md | 2 +- .../code-analysis/quality-rules/ca1819.md | 2 +- .../code-analysis/quality-rules/ca1822.md | 2 +- .../code-analysis/quality-rules/ca1852.md | 2 +- .../code-analysis/quality-rules/ca2000.md | 23 +- .../code-analysis/quality-rules/ca2100.md | 15 +- .../code-analysis/quality-rules/ca2208.md | 2 +- .../code-analysis/quality-rules/ca2213.md | 13 + .../code-analysis/quality-rules/ca2217.md | 2 +- .../code-analysis/quality-rules/ca2225.md | 2 +- .../code-analysis/quality-rules/ca2226.md | 2 +- .../code-analysis/quality-rules/ca2231.md | 2 +- .../code-analysis/quality-rules/ca2234.md | 2 +- .../code-analysis/quality-rules/ca2301.md | 6 +- .../code-analysis/quality-rules/ca2302.md | 6 +- .../code-analysis/quality-rules/ca2311.md | 6 +- .../code-analysis/quality-rules/ca2312.md | 6 +- .../code-analysis/quality-rules/ca2321.md | 6 +- .../code-analysis/quality-rules/ca2322.md | 6 +- .../code-analysis/quality-rules/ca2327.md | 6 +- .../code-analysis/quality-rules/ca2328.md | 6 +- .../code-analysis/quality-rules/ca2329.md | 6 +- .../code-analysis/quality-rules/ca2330.md | 6 +- .../code-analysis/quality-rules/ca3001.md | 6 +- .../code-analysis/quality-rules/ca3002.md | 6 +- .../code-analysis/quality-rules/ca3003.md | 6 +- .../code-analysis/quality-rules/ca3004.md | 6 +- .../code-analysis/quality-rules/ca3005.md | 6 +- .../code-analysis/quality-rules/ca3006.md | 6 +- .../code-analysis/quality-rules/ca3007.md | 6 +- .../code-analysis/quality-rules/ca3008.md | 6 +- .../code-analysis/quality-rules/ca3009.md | 6 +- .../code-analysis/quality-rules/ca3010.md | 6 +- .../code-analysis/quality-rules/ca3011.md | 6 +- .../code-analysis/quality-rules/ca3012.md | 6 +- .../code-analysis/quality-rules/ca5361.md | 6 +- .../code-analysis/quality-rules/ca5376.md | 6 +- .../code-analysis/quality-rules/ca5377.md | 6 +- .../code-analysis/quality-rules/ca5378.md | 6 +- .../code-analysis/quality-rules/ca5380.md | 6 +- .../code-analysis/quality-rules/ca5381.md | 6 +- .../code-analysis/quality-rules/ca5382.md | 6 +- .../code-analysis/quality-rules/ca5383.md | 6 +- .../code-analysis/quality-rules/ca5384.md | 6 +- .../code-analysis/quality-rules/ca5387.md | 6 +- .../code-analysis/quality-rules/ca5388.md | 6 +- .../code-analysis/quality-rules/ca5389.md | 6 +- .../code-analysis/quality-rules/ca5390.md | 6 +- .../code-analysis/quality-rules/ca5399.md | 6 +- .../code-analysis/quality-rules/ca5400.md | 4 +- 110 files changed, 537 insertions(+), 376 deletions(-) delete mode 100644 docs/fundamentals/code-analysis/includes/api-surface.md create mode 100644 docs/fundamentals/code-analysis/includes/config-options/api-surface.md create mode 100644 docs/fundamentals/code-analysis/includes/config-options/dispose-ownership-transfer.md rename docs/fundamentals/code-analysis/includes/{ => config-options}/excluded-symbol-names.md (73%) rename docs/fundamentals/code-analysis/includes/{ => config-options}/excluded-type-names-with-derived-types.md (74%) create mode 100644 docs/fundamentals/code-analysis/includes/config-options/ignore-ivt.md delete mode 100644 docs/fundamentals/code-analysis/includes/ignore-ivt.md diff --git a/docs/fundamentals/code-analysis/code-quality-rule-options.md b/docs/fundamentals/code-analysis/code-quality-rule-options.md index 9aa8cec9a55f1..d38213abc9dc2 100644 --- a/docs/fundamentals/code-analysis/code-quality-rule-options.md +++ b/docs/fundamentals/code-analysis/code-quality-rule-options.md @@ -1,7 +1,7 @@ --- title: Code quality rule configuration options description: Learn how to specify additional configuration options for code quality rules. -ms.date: 05/19/2023 +ms.date: 01/31/2025 no-loc: ["EditorConfig"] --- # Code quality rule configuration options @@ -71,53 +71,52 @@ The syntax for configuring an option for a *specific* rule is as follows: ## Options -This section lists some of the available options. To see the full list of available options, see [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md). +This section lists the available configuration options for code analyzers. For more information, see [Analyzer configuration](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md). +- [additional_enum_none_names](#additional_enum_none_names) +- [additional_inheritance_excluded_symbol_names](#additional_inheritance_excluded_symbol_names) +- [additional_required_generic_interfaces](#additional_required_generic_interfaces) +- [additional_required_suffixes](#additional_required_suffixes) +- [additional_use_results_methods](#additional_use_results_methods) +- [additional\_string\_formatting\_methods](#additional_string_formatting_methods) +- [allowed_suffixes](#allowed_suffixes) +- [analyzed_symbol_kinds](#analyzed_symbol_kinds) - [api\_surface](#api_surface) +- [assume_method_enumerates_parameters](#assume_method_enumerates_parameters) +- [Dataflow analysis options](#dataflow-analysis-options) +- [disallowed\_symbol\_names](#disallowed_symbol_names) +- [enable_platform_analyzer_on_pre_net5_target](#additional_inheritance_excluded_symbol_names) +- [enum_values_prefix_trigger](#enum_values_prefix_trigger) +- [enumeration_methods](#enumeration_methods) +- [exclude_aspnet_core_mvc_controllerbase](#exclude_aspnet_core_mvc_controllerbase) +- [exclude_indirect_base_types](#exclude_indirect_base_types) +- [exclude_structs](#exclude_structs) - [exclude\_async\_void\_methods](#exclude_async_void_methods) -- [exclude\_single\_letter\_type\_parameters](#exclude_single_letter_type_parameters) -- [output\_kind](#output_kind) -- [required\_modifiers](#required_modifiers) - [exclude\_extension\_method\_this\_parameter](#exclude_extension_method_this_parameter) -- [null\_check\_validation\_methods](#null_check_validation_methods) -- [additional\_string\_formatting\_methods](#additional_string_formatting_methods) -- [excluded\_type\_names\_with\_derived\_types](#excluded_type_names_with_derived_types) -- [excluded\_symbol\_names](#excluded_symbol_names) -- [disallowed\_symbol\_names](#disallowed_symbol_names) - [exclude\_ordefault\_methods](#exclude_ordefault_methods) +- [exclude\_single\_letter\_type\_parameters](#exclude_single_letter_type_parameters) +- [excluded\_symbol\_names](#excluded_symbol_names) +- [excluded\_type\_names\_with\_derived\_types](#excluded_type_names_with_derived_types) - [ignore_internalsvisibleto](#ignore_internalsvisibleto) +- [linq_chain_methods](#linq_chain_methods) +- [null\_check\_validation\_methods](#null_check_validation_methods) +- [output\_kind](#output_kind) +- [points_to_analysis_kind](#points_to_analysis_kind) +- [required\_modifiers](#required_modifiers) - [try_determine_additional_string_formatting_methods_automatically](#try_determine_additional_string_formatting_methods_automatically) - [unsafe_DllImportSearchPath_bits](#unsafe_dllimportsearchpath_bits) -- [exclude_aspnet_core_mvc_controllerbase](#exclude_aspnet_core_mvc_controllerbase) -- [dispose_analysis_kind](#dispose_analysis_kind) -- [dispose_ownership_transfer_at_constructor](#dispose_ownership_transfer_at_constructor) -- [dispose_ownership_transfer_at_method_call](#dispose_ownership_transfer_at_method_call) -- [enum_values_prefix_trigger](#enum_values_prefix_trigger) -- [exclude_indirect_base_types](#exclude_indirect_base_types) -- [additional_required_suffixes](#additional_required_suffixes) -- [additional_required_generic_interfaces](#additional_required_generic_interfaces) -- [additional_inheritance_excluded_symbol_names](#additional_inheritance_excluded_symbol_names) -- [analyzed_symbol_kinds](#analyzed_symbol_kinds) - [use_naming_heuristic](#use_naming_heuristic) -- [additional_use_results_methods](#additional_use_results_methods) -- [allowed_suffixes](#allowed_suffixes) -- [enable_platform_analyzer_on_pre_net5_target](#additional_inheritance_excluded_symbol_names) -- [exclude_structs](#exclude_structs) -- [additional_enum_none_names](#additional_enum_none_names) -- [enumeration_methods](#enumeration_methods) -- [linq_chain_methods](#linq_chain_methods) -- [assume_method_enumerates_parameters](#assume_method_enumerates_parameters) ### api_surface -| Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | -| Which part of the API surface to analyze | `public` (applies to `public` and `protected` APIs)
`internal` or `friend` (applies to `internal` and `private protected` APIs)
`private` (applies to `private` APIs)
`all` (applies to all APIs)

Separate multiple values with a comma (,) | `public` | [CA1000](quality-rules/ca1000.md) [CA1002](quality-rules/ca1002.md) [CA1003](quality-rules/ca1003.md) [CA1005](quality-rules/ca1005.md) [CA1008](quality-rules/ca1008.md) [CA1010](quality-rules/ca1010.md) [CA1012](quality-rules/ca1012.md) [CA1021](quality-rules/ca1021.md) [CA1024](quality-rules/ca1024.md) [CA1027](quality-rules/ca1027.md) [CA1028](quality-rules/ca1028.md) [CA1030](quality-rules/ca1030.md) [CA1036](quality-rules/ca1036.md) [CA1040](quality-rules/ca1040.md) [CA1041](quality-rules/ca1041.md) [CA1043](quality-rules/ca1043.md) [CA1044](quality-rules/ca1044.md) [CA1045](quality-rules/ca1045.md) [CA1046](quality-rules/ca1046.md) [CA1047](quality-rules/ca1047.md) [CA1051](quality-rules/ca1051.md) [CA1052](quality-rules/ca1052.md) [CA1054](quality-rules/ca1054.md) [CA1055](quality-rules/ca1055.md) [CA1056](quality-rules/ca1056.md) [CA1058](quality-rules/ca1058.md) [CA1062](quality-rules/ca1062.md) [CA1063](quality-rules/ca1063.md) [CA1068](quality-rules/ca1068.md) [CA1070](quality-rules/ca1070.md) [CA1700](quality-rules/ca1700.md) [CA1707](quality-rules/ca1707.md) [CA1708](quality-rules/ca1708.md) [CA1710](quality-rules/ca1710.md) [CA1711](quality-rules/ca1711.md) [CA1714](quality-rules/ca1714.md) [CA1715](quality-rules/ca1715.md) [CA1716](quality-rules/ca1716.md) [CA1717](quality-rules/ca1717.md) [CA1720](quality-rules/ca1720.md) [CA1721](quality-rules/ca1721.md) [CA1725](quality-rules/ca1725.md) [CA1801](quality-rules/ca1801.md) [CA1802](quality-rules/ca1802.md) [CA1815](quality-rules/ca1815.md) [CA1819](quality-rules/ca1819.md) [CA1822](quality-rules/ca1822.md) [CA1859](quality-rules/ca1859.md) [CA2208](quality-rules/ca2208.md) [CA2217](quality-rules/ca2217.md) [CA2225](quality-rules/ca2225.md) [CA2226](quality-rules/ca2226.md) [CA2231](quality-rules/ca2231.md) [CA2234](quality-rules/ca2234.md) | +| Description | Allowable values | Default value | Configurable rules | +|------------------------------------------|------------------|---------------|--------------------| +| Which part of the API surface to analyze | `public` (applies to `public` and `protected` APIs)
`internal` or `friend` (applies to `internal` and `private protected` APIs)
`private` (applies to `private` APIs)
`all` (applies to all APIs)

Separate multiple values with a comma (,) | `public` | [CA1000](quality-rules/ca1000.md) [CA1002](quality-rules/ca1002.md) [CA1003](quality-rules/ca1003.md) [CA1005](quality-rules/ca1005.md) [CA1008](quality-rules/ca1008.md) [CA1010](quality-rules/ca1010.md) [CA1012](quality-rules/ca1012.md) [CA1021](quality-rules/ca1021.md) [CA1024](quality-rules/ca1024.md) [CA1027](quality-rules/ca1027.md) [CA1028](quality-rules/ca1028.md) [CA1030](quality-rules/ca1030.md) [CA1036](quality-rules/ca1036.md) [CA1040](quality-rules/ca1040.md) [CA1041](quality-rules/ca1041.md) [CA1043](quality-rules/ca1043.md) [CA1044](quality-rules/ca1044.md) [CA1045](quality-rules/ca1045.md) [CA1046](quality-rules/ca1046.md) [CA1047](quality-rules/ca1047.md) [CA1051](quality-rules/ca1051.md) [CA1052](quality-rules/ca1052.md) [CA1054](quality-rules/ca1054.md) [CA1055](quality-rules/ca1055.md) [CA1056](quality-rules/ca1056.md) [CA1058](quality-rules/ca1058.md) [f](quality-rules/ca1062.md) [CA1063](quality-rules/ca1063.md) [CA1068](quality-rules/ca1068.md) [CA1070](quality-rules/ca1070.md) [CA1700](quality-rules/ca1700.md) [CA1707](quality-rules/ca1707.md) [CA1708](quality-rules/ca1708.md) [CA1710](quality-rules/ca1710.md) [CA1711](quality-rules/ca1711.md) [CA1714](quality-rules/ca1714.md) [CA1715](quality-rules/ca1715.md) [CA1716](quality-rules/ca1716.md) [CA1717](quality-rules/ca1717.md) [CA1720](quality-rules/ca1720.md) [CA1721](quality-rules/ca1721.md) [CA1725](quality-rules/ca1725.md) [CA1801](quality-rules/ca1801.md) [CA1802](quality-rules/ca1802.md) [CA1815](quality-rules/ca1815.md) [CA1819](quality-rules/ca1819.md) [CA1822](quality-rules/ca1822.md) [CA1859](quality-rules/ca1859.md) [CA2208](quality-rules/ca2208.md) [CA2217](quality-rules/ca2217.md) [CA2225](quality-rules/ca2225.md) [CA2226](quality-rules/ca2226.md) [CA2231](quality-rules/ca2231.md) [CA2234](quality-rules/ca2234.md) | ### exclude_async_void_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Whether to ignore asynchronous methods that don't return a value | `true`
`false` | `false` | [CA2007](quality-rules/ca2007.md) | > [!NOTE] @@ -126,7 +125,7 @@ This section lists some of the available options. To see the full list of availa ### exclude_single_letter_type_parameters | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Whether to exclude single-character [type parameters](../../csharp/programming-guide/generics/generic-type-parameters.md) from the rule, for example, `S` in `Collection` | `true`
`false` | `false` | [CA1715](quality-rules/ca1715.md) | > [!NOTE] @@ -135,207 +134,258 @@ This section lists some of the available options. To see the full list of availa ### output_kind | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies that code in a project that generates this type of assembly should be analyzed | One or more fields of the enumeration

Separate multiple values with a comma (,) | All output kinds | [CA2007](quality-rules/ca2007.md) | ### required_modifiers | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies the required modifiers for APIs that should be analyzed | One or more values from the below allowed modifiers table

Separate multiple values with a comma (,) | Depends on each rule | [CA1802](quality-rules/ca1802.md) | -| Allowed Modifier | Summary | -| --- | --- | -| `none` | No modifier requirement | +| Allowed Modifier | Summary | +|----------------------|---------------------------------------------------------| +| `none` | No modifier requirement | | `static` or `Shared` | Must be declared as `static` (`Shared` in Visual Basic) | -| `const` | Must be declared as `const` | -| `readonly` | Must be declared as `readonly` | -| `abstract` | Must be declared as `abstract` | -| `virtual` | Must be declared as `virtual` | -| `override` | Must be declared as `override` | -| `sealed` | Must be declared as `sealed` | -| `extern` | Must be declared as `extern` | -| `async` | Must be declared as `async` | +| `const` | Must be declared as `const` | +| `readonly` | Must be declared as `readonly` | +| `abstract` | Must be declared as `abstract` | +| `virtual` | Must be declared as `virtual` | +| `override` | Must be declared as `override` | +| `sealed` | Must be declared as `sealed` | +| `extern` | Must be declared as `extern` | +| `async` | Must be declared as `async` | ### exclude_extension_method_this_parameter | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Whether to skip analysis for the `this` parameter of extension methods | `true`
`false` | `false` | [CA1062](quality-rules/ca1062.md) | ### null_check_validation_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Names of null-check validation methods that validate that arguments passed to the method are non-null | Allowed method name formats (separated by \|):
- Method name only (includes all methods with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](/dotnet/csharp/language-reference/language-specification/documentation-comments#id-string-format), with an optional `M:` prefix | None | [CA1062](quality-rules/ca1062.md) | ### additional_string_formatting_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Names of additional string formatting methods | Allowed method name formats (separated by \|):
- Method name only (includes all methods with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](/dotnet/csharp/language-reference/language-specification/documentation-comments#id-string-format), with an optional `M:` prefix | None | [CA2241](quality-rules/ca2241.md) | ### excluded_type_names_with_derived_types | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Names of types, such that the type and all its derived types are excluded for analysis | Allowed symbol name formats (separated by \|):
- Type name only (includes all types with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](/dotnet/csharp/language-reference/language-specification/documentation-comments#id-string-format), with an optional `T:` prefix | None | [CA1001](quality-rules/ca1001.md) [CA1054](quality-rules/ca1054.md) [CA1055](quality-rules/ca1055.md) [CA1056](quality-rules/ca1056.md) [CA1062](quality-rules/ca1062.md) [CA1068](quality-rules/ca1068.md) [CA1303](quality-rules/ca1303.md) [CA1304](quality-rules/ca1304.md) [CA1305](quality-rules/ca1305.md) [CA1508](quality-rules/ca1508.md) [CA2000](quality-rules/ca2000.md) [CA2100](quality-rules/ca2100.md) [CA2301](quality-rules/ca2301.md) [CA2302](quality-rules/ca2302.md) [CA2311](quality-rules/ca2311.md) [CA2312](quality-rules/ca2312.md) [CA2321](quality-rules/ca2321.md) [CA2322](quality-rules/ca2322.md) [CA2327](quality-rules/ca2327.md) [CA2328](quality-rules/ca2328.md) [CA2329](quality-rules/ca2329.md) [CA2330](quality-rules/ca2330.md) [CA3001](quality-rules/ca3001.md) [CA3002](quality-rules/ca3002.md) [CA3003](quality-rules/ca3003.md) [CA3004](quality-rules/ca3004.md) [CA3005](quality-rules/ca3005.md) [CA3006](quality-rules/ca3006.md) [CA3007](quality-rules/ca3007.md) [CA3008](quality-rules/ca3008.md) [CA3009](quality-rules/ca3009.md) [CA3010](quality-rules/ca3010.md) [CA3011](quality-rules/ca3011.md) [CA3012](quality-rules/ca3012.md) [CA5361](quality-rules/ca5361.md) [CA5376](quality-rules/ca5376.md) [CA5377](quality-rules/ca5377.md) [CA5378](quality-rules/ca5378.md) [CA5380](quality-rules/ca5380.md) [CA5381](quality-rules/ca5381.md) [CA5382](quality-rules/ca5382.md) [CA5383](quality-rules/ca5383.md) [CA5384](quality-rules/ca5384.md) [CA5387](quality-rules/ca5387.md) [CA5388](quality-rules/ca5388.md) [CA5389](quality-rules/ca5389.md) [CA5390](quality-rules/ca5390.md) [CA5399](quality-rules/ca5399.md) [CA5400](quality-rules/ca5400.md) | ### excluded_symbol_names | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Names of symbols that are excluded for analysis | Allowed symbol name formats (separated by \|):
- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](/dotnet/csharp/language-reference/language-specification/documentation-comments#id-string-format). Each symbol name requires a symbol kind prefix, such as `M:` prefix for methods, `T:` prefix for types, and `N:` prefix for namespaces.
- `.ctor` for constructors and `.cctor` for static constructors | None | [CA1001](quality-rules/ca1001.md) [CA1054](quality-rules/ca1054.md) [CA1055](quality-rules/ca1055.md) [CA1056](quality-rules/ca1056.md) [CA1062](quality-rules/ca1062.md) [CA1068](quality-rules/ca1068.md) [CA1303](quality-rules/ca1303.md) [CA1304](quality-rules/ca1304.md) [CA1305](quality-rules/ca1305.md) [CA1508](quality-rules/ca1508.md) [CA2000](quality-rules/ca2000.md) [CA2100](quality-rules/ca2100.md) [CA2301](quality-rules/ca2301.md) [CA2302](quality-rules/ca2302.md) [CA2311](quality-rules/ca2311.md) [CA2312](quality-rules/ca2312.md) [CA2321](quality-rules/ca2321.md) [CA2322](quality-rules/ca2322.md) [CA2327](quality-rules/ca2327.md) [CA2328](quality-rules/ca2328.md) [CA2329](quality-rules/ca2329.md) [CA2330](quality-rules/ca2330.md) [CA3001](quality-rules/ca3001.md) [CA3002](quality-rules/ca3002.md) [CA3003](quality-rules/ca3003.md) [CA3004](quality-rules/ca3004.md) [CA3005](quality-rules/ca3005.md) [CA3006](quality-rules/ca3006.md) [CA3007](quality-rules/ca3007.md) [CA3008](quality-rules/ca3008.md) [CA3009](quality-rules/ca3009.md) [CA3010](quality-rules/ca3010.md) [CA3011](quality-rules/ca3011.md) [CA3012](quality-rules/ca3012.md) [CA5361](quality-rules/ca5361.md) [CA5376](quality-rules/ca5376.md) [CA5377](quality-rules/ca5377.md) [CA5378](quality-rules/ca5378.md) [CA5380](quality-rules/ca5380.md) [CA5381](quality-rules/ca5381.md) [CA5382](quality-rules/ca5382.md) [CA5383](quality-rules/ca5383.md) [CA5384](quality-rules/ca5384.md) [CA5387](quality-rules/ca5387.md) [CA5388](quality-rules/ca5388.md) [CA5389](quality-rules/ca5389.md) [CA5390](quality-rules/ca5390.md) [CA5399](quality-rules/ca5399.md) [CA5400](quality-rules/ca5400.md) | ### disallowed_symbol_names | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Names of symbols that are disallowed in the context of the analysis | Allowed symbol name formats (separated by \|):
- Symbol name only (includes all symbols with the name, regardless of the containing type or namespace)
- Fully qualified names in the symbol's [documentation ID format](/dotnet/csharp/language-reference/language-specification/documentation-comments#id-string-format). Each symbol name requires a symbol kind prefix, such as `M:` prefix for methods, `T:` prefix for types, and `N:` prefix for namespaces.
- `.ctor` for constructors and `.cctor` for static constructors | None | [CA1031](quality-rules/ca1031.md) | ### exclude_ordefault_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Excludes `FirstOrDefault` and `LastOrDefault` methods from analysis. | `true` or `false` | `false` | [CA1826](quality-rules/ca1826.md) | ### ignore_internalsvisibleto | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Includes assemblies marked with in analysis. | `true` or `false` | `true` | [CA1812](quality-rules/ca1812.md) [CA1852](quality-rules/ca1852.md) | ### try_determine_additional_string_formatting_methods_automatically | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Boolean option to enable heuristic detection of additional string formatting methods.
A method is considered a string formatting method if it has a `string format` parameter followed by a `params object[]` parameter. | `true` or `false` | `false` | [CA2241](quality-rules/ca2241.md) | ### unsafe_DllImportSearchPath_bits | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Configure which value of `DllImportSearchPath` is unsafe for the analysis | Integer values of `System.Runtime.InteropServices.DllImportSearchPath` | `770` (that is, `AssemblyDirectory | UseDllDirectoryForDependencies | ApplicationDirectory`) | [CA5393](quality-rules/ca5393.md) | ### exclude_aspnet_core_mvc_controllerbase | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Exclude ASP.NET Core MVC ControllerBase when considering CSRF | `true` or `false` | `true` | [CA5391](quality-rules/ca5391.md) | -### dispose_analysis_kind - -| Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | -| Specifies which paths to analyze for dispose violations | - `AllPaths` - Track and report missing dispose violations on all paths (non-exception and exception paths). Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `AllPathsOnlyNotDisposed` - Track and report missing dispose violations on all paths (non-exception and exception paths). Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `NonExceptionPaths` - Track and report missing dispose violations only on non-exception program paths. Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `NonExceptionPathsOnlyNotDisposed` - Track and report missing dispose violations only on non-exception program paths. Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks. | `NonExceptionPaths` | [CA2000](quality-rules/ca2000.md) | - -### dispose_ownership_transfer_at_constructor - -| Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | -| Configure dispose ownership transfer for arguments passed to constructor invocation | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) | - -### dispose_ownership_transfer_at_method_call - -| Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | -| Configure dispose ownership transfer for disposable objects passed as arguments to method calls | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) | - ### enum_values_prefix_trigger | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies the threshold to trigger the enum values naming rule | - `AnyEnumValue` - The rule is triggered if _any_ of the enum values starts with the enum type name.
- `AllEnumValues` - The rule is triggered if _all_ of the enum values start with the enum type name.
- `Heuristic` - The rule is triggered using the default FxCop heuristic (that is, when at least 75% of the enum values start with the enum type name).
| `Heuristic` | [CA1712](quality-rules/ca1712.md) | ### exclude_indirect_base_types | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Exclude indirect base types | `true` or `false` | `true` | [CA1710](quality-rules/ca1710.md) | ### additional_required_suffixes | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional required suffixes | List of type names (separated by \|) with their required suffix (separated by `->`). Allowed type name formats:
- Type name only (includes all types with the name, regardless of the containing type or namespace).
- Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix.| None | [CA1710](quality-rules/ca1710.md) | ### additional_required_generic_interfaces | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional required generic interfaces | List of interface names (separated by \|) with their required generic fully qualified interface (separated by `->`). Allowed interface formats:
- Interface name only (includes all interfaces with the name, regardless of the containing type or namespace).
- Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix. | None | [CA1010](quality-rules/ca1010.md) | Examples: | Option Value | Summary | -| --- | --- | +|--------------|---------| | ``dotnet_code_quality.CA1010.additional_required_generic_interfaces = ISomething->System.Collections.Generic.IEnumerable`1`` | All types implementing `ISomething` regardless of its namespace are expected to also implement ``System.Collections.Generic.IEnumerable\`1``. | | ``dotnet_code_quality.CA1010.additional_required_generic_interfaces = T:System.Collections.IDictionary->T:System.Collections.Generic.IDictionary`2`` | All types implementing `System.Collections.IDictionary` are expected to also implement ``System.Collections.Generic.IDictionary`2``. | ### additional_inheritance_excluded_symbol_names | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies types or namespaces to exclude from the inheritance hierarchy tree | Allowed type name formats:
- Type or namespace name (includes all types with the name, regardless of the containing type or namespace, and all types whose namespace contains the name).
- Type or namespace name ending with a wildcard symbol (includes all types whose name starts with the given name, regardless of the containing type or namespace, and all types whose namespace contains the name).
- Fully qualified names in the symbol's documentation ID format with an optional `T:` prefix for types or `N:` prefix for namespaces.
- Fully qualified type or namespace name with an optional `T:` prefix for type or `N:` prefix for namespace and ending with the wildcard symbol (includes all types whose fully qualified name starts with the given type name, or all types whose fully qualified name starts with the given namespace name). | `N:System.*` (This value is always automatically added to the value provided) | [CA1501](quality-rules/ca1501.md) | ### analyzed_symbol_kinds | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies the symbol kinds to analyze | One or more fields of as a comma-separated list. | `Namespace, NamedType, Method, Property, Event, Parameter` | [CA1716](quality-rules/ca1716.md) | ### use_naming_heuristic | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Configures whether parameters or property names containing `Text`, `Message`, or `Caption` trigger this rule | `true` or `false` | `false` | [CA1303](quality-rules/ca1303.md) | ### additional_use_results_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional custom APIs whose results must be used | Names of additional methods (separated by \|). Allowed method name formats:
- Method name only (includes all methods with the name, regardless of the containing type or namespace).
- Fully qualified names in the symbol's documentation ID format with an optional `M:` prefix. | None | [CA1806](quality-rules/ca1806.md) | ### allowed_suffixes | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies allowable suffixes | List (separated by \|) of allowed suffixes. | None | [CA1711](quality-rules/ca1711.md) | ### enable_platform_analyzer_on_pre_net5_target | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies whether to enable analysis for TFMs prior to .NET 5 | `true` or `false` | `false` | [CA1416](quality-rules/ca1416.md) | ### exclude_structs | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies whether to exclude structs from analysis | `true` or `false` | `false` | [CA1051](quality-rules/ca1051.md) | ### additional_enum_none_names | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional allowable names for a zero-value enumeration field | List of additional names (separated by \|). | None | [CA1008](quality-rules/ca1008.md) | ### enumeration_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional custom methods that enumerate an IEnumerable | Fully qualified names of additional methods (separated by \|). | None | [CA1851](quality-rules/ca1851.md) | ### linq_chain_methods | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies additional customized LINQ chain methods (that is, methods take an `IEnumerable` argument and return a new `IEnumerable` instance) | Fully qualified names of additional methods (separated by \|). | None | [CA1851](quality-rules/ca1851.md) | ### assume_method_enumerates_parameters | Description | Allowable values | Default value | Configurable rules | -| - | - | - | - | +|-------------|------------------|---------------|--------------------| | Specifies whether to assume that customized methods enumerate their `IEnumerable` parameters | `true` or `false` | `false` | [CA1851](quality-rules/ca1851.md) | + +### Dataflow analysis options + +The options in this section configure dataflow analysis rules. The options are: + +- [dispose_analysis_kind](#dispose_analysis_kind) +- [dispose_ownership_transfer_at_constructor](#dispose_ownership_transfer_at_constructor) +- [dispose_ownership_transfer_at_method_call](#dispose_ownership_transfer_at_method_call) +- [interprocedural_analysis_kind](#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](#max_interprocedural_method_call_chain) +- [copy_analysis](#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](#sufficient_iterationcount_for_weak_kdf_algorithm) + +For more information about dataflow analysis, see [Writing dataflow analysis based analyzers](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md#dataflow-analysis). + +### dispose_analysis_kind + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies which paths to analyze for dispose violations | - `AllPaths` - Track and report missing dispose violations on all paths (non-exception and exception paths). Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `AllPathsOnlyNotDisposed` - Track and report missing dispose violations on all paths (non-exception and exception paths). Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `NonExceptionPaths` - Track and report missing dispose violations only on non-exception program paths. Additionally, also flag use of non-recommended dispose patterns that might cause potential dispose leaks.
- `NonExceptionPathsOnlyNotDisposed` - Track and report missing dispose violations only on non-exception program paths. Do not flag use of non-recommended dispose patterns that might cause potential dispose leaks. | `NonExceptionPaths` | [CA2000](quality-rules/ca2000.md) | + +### dispose_ownership_transfer_at_constructor + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Configure dispose ownership transfer for arguments passed to constructor invocation | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) | + +### dispose_ownership_transfer_at_method_call + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Configure dispose ownership transfer for disposable objects passed as arguments to method calls | `true` or `false` | `false` | [CA2000](quality-rules/ca2000.md) | + +### interprocedural_analysis_kind + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies whether to perform interprocedural analysis for source method invocations | `None`, `NonContextSensitive`, `ContextSensitive` | *Specific to each configurable rule* | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | + +### max_interprocedural_method_call_chain + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies the maximum method call chain length to analyze for interprocedural dataflow analysis | Unsigned integer | 3 | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | + +### max_interprocedural_lambda_or_local_function_call_chain + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies the maximum lambda or local function call chain length to analyze for interprocedural dataflow analysis | Unsigned integer | 3 | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | + +### points_to_analysis_kind + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies whether to perform [PointsToAnalysis](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Writing%20dataflow%20analysis%20based%20analyzers.md) | `None`, `PartialWithoutTrackingFieldsAndProperties`, `Complete` | *Specific to each rule* | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | + +### copy_analysis + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Specifies whether to perform [copy analysis](https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Writing%20dataflow%20analysis%20based%20analyzers.md) (tracks value and reference copies) | `true` or `false` | `true` for most rules | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | + +### sufficient_IterationCount_for_weak_KDF_algorithm + +| Description | Allowable values | Default value | Configurable rules | +|-------------|------------------|---------------|--------------------| +| Configures a sufficient iteration count when using a weak key derivation function (KDF) algorithm | Integer | 100000 for most rules | [CA1062](quality-rules/ca1062.md), [CA1303](quality-rules/ca1303.md), [CA1508](quality-rules/ca1508.md), [CA2000](quality-rules/ca2000.md), [CA2100](quality-rules/ca2100.md), [CA2213](quality-rules/ca2213.md) | diff --git a/docs/fundamentals/code-analysis/includes/api-surface.md b/docs/fundamentals/code-analysis/includes/api-surface.md deleted file mode 100644 index 276693ef95fdb..0000000000000 --- a/docs/fundamentals/code-analysis/includes/api-surface.md +++ /dev/null @@ -1,10 +0,0 @@ -### Include specific API surfaces - -You can configure which parts of your codebase to run this rule on, based on their accessibility. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an *.editorconfig* file in your project: - -```ini -dotnet_code_quality.CAXXXX.api_surface = private, internal -``` - -> [!NOTE] -> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule. diff --git a/docs/fundamentals/code-analysis/includes/config-options/api-surface.md b/docs/fundamentals/code-analysis/includes/config-options/api-surface.md new file mode 100644 index 0000000000000..838bc96e6138e --- /dev/null +++ b/docs/fundamentals/code-analysis/includes/config-options/api-surface.md @@ -0,0 +1,10 @@ +### Include specific API surfaces + +You can configure which parts of your codebase to run this rule on, based on their accessibility, by setting the [api_surface](../../code-quality-rule-options.md#api_surface) option. For example, to specify that the rule should run only against the non-public API surface, add the following key-value pair to an *.editorconfig* file in your project: + +```ini +dotnet_code_quality.CAXXXX.api_surface = private, internal +``` + +> [!NOTE] +> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule. diff --git a/docs/fundamentals/code-analysis/includes/config-options/dispose-ownership-transfer.md b/docs/fundamentals/code-analysis/includes/config-options/dispose-ownership-transfer.md new file mode 100644 index 0000000000000..553a030d6cfa6 --- /dev/null +++ b/docs/fundamentals/code-analysis/includes/config-options/dispose-ownership-transfer.md @@ -0,0 +1,51 @@ +### Configure dispose ownership transfer + +The [dispose_ownership_transfer_at_constructor](../../code-quality-rule-options.md#dispose_ownership_transfer_at_constructor) and [dispose_ownership_transfer_at_method_call](../../code-quality-rule-options.md#dispose_ownership_transfer_at_method_call) options configure the transfer of dispose ownership. + +For example, to specify that the rule transfers dispose ownership for arguments passed to constructors, add the following key-value pair to an *.editorconfig* file in your project: + +```ini +dotnet_code_quality.CAXXXX.dispose_ownership_transfer_at_constructor = true +``` + +> [!NOTE] +> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule. + +#### dispose_ownership_transfer_at_constructor + +Consider the following code example. + +```csharp +class A : IDisposable +{ + public void Dispose() { } +} + +class Test +{ + DisposableOwnerType M1() + { + return new DisposableOwnerType(new A()); + } +} +``` + +- If `dotnet_code_quality.dispose_ownership_transfer_at_constructor` is set to `true`, dispose ownership for the `new A()` allocation is transferred to the returned `DisposableOwnerType` instance. +- If `dotnet_code_quality.dispose_ownership_transfer_at_constructor` is set to `false`, `Test.M1()` has the dispose ownership for `new A()`, and results in a `CA2000` violation for a dispose leak. + +#### dispose_ownership_transfer_at_method_call + +Consider the following code example. + +```csharp +class Test +{ + void M1() + { + TransferDisposeOwnership(new A()); + } +} +``` + +- If `dotnet_code_quality.dispose_ownership_transfer_at_method_call` is set to `true`, dispose ownership for the `new A()` allocation is transferred to the `TransferDisposeOwnership` method. +- If `dotnet_code_quality.dispose_ownership_transfer_at_method_call` is set to `false`, `Test.M1()` has the dispose ownership for `new A()`, and results in a `CA2000` violation for a dispose leak. diff --git a/docs/fundamentals/code-analysis/includes/excluded-symbol-names.md b/docs/fundamentals/code-analysis/includes/config-options/excluded-symbol-names.md similarity index 73% rename from docs/fundamentals/code-analysis/includes/excluded-symbol-names.md rename to docs/fundamentals/code-analysis/includes/config-options/excluded-symbol-names.md index 5a6b8783d258f..b530aad4a2d2d 100644 --- a/docs/fundamentals/code-analysis/includes/excluded-symbol-names.md +++ b/docs/fundamentals/code-analysis/includes/config-options/excluded-symbol-names.md @@ -1,6 +1,6 @@ ### Exclude specific symbols -You can exclude specific symbols, such as types and methods, from analysis. For example, to specify that the rule should not run on any code within types named `MyType`, add the following key-value pair to an *.editorconfig* file in your project: +You can exclude specific symbols, such as types and methods, from analysis by setting the [excluded_symbol_names](../../code-quality-rule-options.md#excluded_symbol_names) option. For example, to specify that the rule should not run on any code within types named `MyType`, add the following key-value pair to an *.editorconfig* file in your project: ```ini dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType @@ -12,7 +12,7 @@ dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType Allowed symbol name formats in the option value (separated by `|`): - Symbol name only (includes all symbols with the name, regardless of the containing type or namespace). -- Fully qualified names in the symbol's [documentation ID format](../../../csharp/language-reference/xmldoc/index.md#id-strings). Each symbol name requires a symbol-kind prefix, such as `M:` for methods, `T:` for types, and `N:` for namespaces. +- Fully qualified names in the symbol's [documentation ID format](../../../../csharp/language-reference/xmldoc/index.md#id-strings). Each symbol name requires a symbol-kind prefix, such as `M:` for methods, `T:` for types, and `N:` for namespaces. - `.ctor` for constructors and `.cctor` for static constructors. Examples: diff --git a/docs/fundamentals/code-analysis/includes/excluded-type-names-with-derived-types.md b/docs/fundamentals/code-analysis/includes/config-options/excluded-type-names-with-derived-types.md similarity index 74% rename from docs/fundamentals/code-analysis/includes/excluded-type-names-with-derived-types.md rename to docs/fundamentals/code-analysis/includes/config-options/excluded-type-names-with-derived-types.md index d4a8017aa7fe2..ef3217af608a9 100644 --- a/docs/fundamentals/code-analysis/includes/excluded-type-names-with-derived-types.md +++ b/docs/fundamentals/code-analysis/includes/config-options/excluded-type-names-with-derived-types.md @@ -1,6 +1,6 @@ ### Exclude specific types and their derived types -You can exclude specific types and their derived types from analysis. For example, to specify that the rule should not run on any methods within types named `MyType` and their derived types, add the following key-value pair to an *.editorconfig* file in your project: +You can exclude specific types and their derived types from analysis by setting the [excluded_type_names_with_derived_types](../../code-quality-rule-options.md#excluded_type_names_with_derived_types) option. For example, to specify that the rule should not run on any methods within types named `MyType` and their derived types, add the following key-value pair to an *.editorconfig* file in your project: ```ini dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType @@ -12,12 +12,12 @@ dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType Allowed symbol name formats in the option value (separated by `|`): - Type name only (includes all types with the name, regardless of the containing type or namespace). -- Fully qualified names in the symbol's [documentation ID format](../../../csharp/language-reference/xmldoc/index.md#id-strings), with an optional `T:` prefix. +- Fully qualified names in the symbol's [documentation ID format](../../../../csharp/language-reference/xmldoc/index.md#id-strings), with an optional `T:` prefix. Examples: -| Option Value | Summary | +| Option value | Summary | | --- | --- | |`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType` | Matches all types named `MyType` and all of their derived types. | |`dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType1|MyType2` | Matches all types named either `MyType1` or `MyType2` and all of their derived types. | diff --git a/docs/fundamentals/code-analysis/includes/config-options/ignore-ivt.md b/docs/fundamentals/code-analysis/includes/config-options/ignore-ivt.md new file mode 100644 index 0000000000000..1ce4a74785ea0 --- /dev/null +++ b/docs/fundamentals/code-analysis/includes/config-options/ignore-ivt.md @@ -0,0 +1,12 @@ +### Ignore InternalsVisibleTo attribute + +By default, this rule is disabled if the assembly being analyzed uses to expose its internal symbols. You can set the [ignore_internalsvisibleto](../../code-quality-rule-options.md#ignore_internalsvisibleto) option to change the configuration. To specify that the rule should run even if the assembly is marked with , add the following key-value pair to an *.editorconfig* file in your project: + +```ini +dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true +``` + +> [!NOTE] +> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule. + +This option is available starting in .NET 8. diff --git a/docs/fundamentals/code-analysis/includes/ignore-ivt.md b/docs/fundamentals/code-analysis/includes/ignore-ivt.md deleted file mode 100644 index 7dd183c5ebec8..0000000000000 --- a/docs/fundamentals/code-analysis/includes/ignore-ivt.md +++ /dev/null @@ -1,12 +0,0 @@ -### Ignore InternalsVisibleTo attribute - -By default, this rule is disabled if the assembly being analyzed uses to expose its internal symbols. To specify that the rule should run even if the assembly is marked with , add the following key-value pair to an *.editorconfig* file in your project: - -```ini -dotnet_code_quality.CAXXXX.ignore_internalsvisibleto = true -``` - -> [!NOTE] -> Replace the `XXXX` part of `CAXXXX` with the ID of the applicable rule. - -This option is available starting in .NET 8. diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1000.md b/docs/fundamentals/code-analysis/quality-rules/ca1000.md index 6d9d6bc365d65..93411c2d92505 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1000.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1000.md @@ -87,7 +87,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules that it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1001.md b/docs/fundamentals/code-analysis/quality-rules/ca1001.md index ecfdece026ae1..77597421fdc8d 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1001.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1001.md @@ -72,9 +72,9 @@ Use the following options to configure which parts of your codebase to run this These options can be configured for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1002.md b/docs/fundamentals/code-analysis/quality-rules/ca1002.md index 1d159898c44f4..e7ab8e82def88 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1002.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1002.md @@ -76,7 +76,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1003.md b/docs/fundamentals/code-analysis/quality-rules/ca1003.md index 629717e24575c..8c4a52bb43ed1 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1003.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1003.md @@ -52,7 +52,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1005.md b/docs/fundamentals/code-analysis/quality-rules/ca1005.md index 2001ffe127daf..0917340f090a3 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1005.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1005.md @@ -66,7 +66,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1008.md b/docs/fundamentals/code-analysis/quality-rules/ca1008.md index 0eb04d0553b06..18ae0c97a276b 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1008.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1008.md @@ -69,10 +69,11 @@ Use the following option to configure which parts of your codebase to run this r - [Include specific API surfaces](#include-specific-api-surfaces) - [Additional zero-value field names](#additional-zero-value-field-names) +- [additional_enum_none_names](../code-quality-rule-options.md#additional_enum_none_names) -You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Design) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Additional zero-value field names diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1010.md b/docs/fundamentals/code-analysis/quality-rules/ca1010.md index 8f953a73bf8eb..cbab27d88eeb0 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1010.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1010.md @@ -75,9 +75,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Additional required generic interfaces](#additional-required-generic-interfaces) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Additional required generic interfaces diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1012.md b/docs/fundamentals/code-analysis/quality-rules/ca1012.md index 94da4c7a87562..d88374c4a577a 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1012.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1012.md @@ -68,7 +68,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1021.md b/docs/fundamentals/code-analysis/quality-rules/ca1021.md index eb45046f3271d..9a14bde679511 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1021.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1021.md @@ -76,7 +76,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example 1 diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1024.md b/docs/fundamentals/code-analysis/quality-rules/ca1024.md index 4db59e85e151a..e8fa701b931a2 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1024.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1024.md @@ -81,7 +81,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1027.md b/docs/fundamentals/code-analysis/quality-rules/ca1027.md index 4df689929e350..26416d64b12c2 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1027.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1027.md @@ -68,7 +68,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1028.md b/docs/fundamentals/code-analysis/quality-rules/ca1028.md index 5b43cb7e343f2..d8a96446e32c7 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1028.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1028.md @@ -69,7 +69,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1030.md b/docs/fundamentals/code-analysis/quality-rules/ca1030.md index bb19a51c163ea..be21728d0c6c5 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1030.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1030.md @@ -73,4 +73,4 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1031.md b/docs/fundamentals/code-analysis/quality-rules/ca1031.md index 60b3aab77a28f..93a3c044207f5 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1031.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1031.md @@ -77,7 +77,7 @@ Examples: |`dotnet_code_quality.CA1031.disallowed_symbol_names = T:NS1.ExceptionType1|T:NS1.ExceptionType2` | Matches types named 'ExceptionType1' and 'ExceptionType2' with respective fully qualified names. | -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1036.md b/docs/fundamentals/code-analysis/quality-rules/ca1036.md index 5356e53984d1c..bbcdb7a25dcf2 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1036.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1036.md @@ -102,7 +102,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1040.md b/docs/fundamentals/code-analysis/quality-rules/ca1040.md index 2e887b53b2902..295630c8b96b0 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1040.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1040.md @@ -71,7 +71,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1041.md b/docs/fundamentals/code-analysis/quality-rules/ca1041.md index 9a0856d271da9..7e83233151a4d 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1041.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1041.md @@ -50,7 +50,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1043.md b/docs/fundamentals/code-analysis/quality-rules/ca1043.md index b3947a25a3302..5769cf6c875cc 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1043.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1043.md @@ -69,7 +69,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1044.md b/docs/fundamentals/code-analysis/quality-rules/ca1044.md index fb07a42d98f84..727d9a39dd71a 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1044.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1044.md @@ -50,7 +50,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1045.md b/docs/fundamentals/code-analysis/quality-rules/ca1045.md index 2e348ed9c7dd2..6c3636aa9d513 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1045.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1045.md @@ -75,7 +75,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example 1 diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1046.md b/docs/fundamentals/code-analysis/quality-rules/ca1046.md index c6ca9af2709ec..07a214db4fd61 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1046.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1046.md @@ -64,7 +64,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Design) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example 1 diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1047.md b/docs/fundamentals/code-analysis/quality-rules/ca1047.md index f1c8d1493b1c8..ea6fe877cd3df 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1047.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1047.md @@ -50,7 +50,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1051.md b/docs/fundamentals/code-analysis/quality-rules/ca1051.md index 2958434101d7a..90e39357a6055 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1051.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1051.md @@ -74,9 +74,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Exclude structs](#exclude-structs) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Exclude structs diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1052.md b/docs/fundamentals/code-analysis/quality-rules/ca1052.md index f7482960ddb06..e889aa8218dea 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1052.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1052.md @@ -77,7 +77,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example of a violation diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1054.md b/docs/fundamentals/code-analysis/quality-rules/ca1054.md index 2952bf1ed596c..50bca12d233c1 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1054.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1054.md @@ -69,13 +69,13 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1055.md b/docs/fundamentals/code-analysis/quality-rules/ca1055.md index afc73ddbdf6b2..760ecb6f09206 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1055.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1055.md @@ -69,13 +69,13 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1056.md b/docs/fundamentals/code-analysis/quality-rules/ca1056.md index f1b3d1ff35e6d..abb9c52f5a713 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1056.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1056.md @@ -69,13 +69,13 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1058.md b/docs/fundamentals/code-analysis/quality-rules/ca1058.md index 4fc4613851ca8..62063da3b87bd 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1058.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1058.md @@ -105,4 +105,4 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1062.md b/docs/fundamentals/code-analysis/quality-rules/ca1062.md index 5bf9a8c0b44be..214949d4c0f70 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1062.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1062.md @@ -74,16 +74,25 @@ Use the following options to configure which parts of your codebase to run this - [Exclude extension method 'this' parameter](#exclude-extension-method-this-parameter) - [Null check validation methods](#null-check-validation-methods) -These options can be configured for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +In addition, the following other dataflow analysis–related options apply to this rule: -[!INCLUDE[api-surface](../includes/api-surface.md)] +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) + +These options can be configured for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] > [!NOTE] > This option is supported for CA1062 in .NET 7 and later versions only. -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ### Exclude extension method 'this' parameter diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1063.md b/docs/fundamentals/code-analysis/quality-rules/ca1063.md index caa0df89db82c..9fe21a01d62cc 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1063.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1063.md @@ -88,7 +88,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Pseudo-code example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1068.md b/docs/fundamentals/code-analysis/quality-rules/ca1068.md index a88931d0a2bae..101cb65e71328 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1068.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1068.md @@ -89,13 +89,13 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Design](design-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1070.md b/docs/fundamentals/code-analysis/quality-rules/ca1070.md index 0974bd7335024..5aebf46ef2237 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1070.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1070.md @@ -73,7 +73,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Design](design-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## See also diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1303.md b/docs/fundamentals/code-analysis/quality-rules/ca1303.md index 4ae1422f130dc..1e2ac4aa72428 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1303.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1303.md @@ -86,11 +86,20 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) - [Use naming heuristic](#use-naming-heuristic) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Globalization](globalization-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +In addition, the following dataflow analysis–related options apply to this rule: -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Globalization](globalization-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] + +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ### Use naming heuristic diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1304.md b/docs/fundamentals/code-analysis/quality-rules/ca1304.md index 9e8bd59eeee05..e3568f5496c14 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1304.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1304.md @@ -80,11 +80,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Globalization](globalization-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Globalization](globalization-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example showing how to fix violations diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1305.md b/docs/fundamentals/code-analysis/quality-rules/ca1305.md index 4da0880fc0c34..69124ffef6603 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1305.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1305.md @@ -86,11 +86,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Globalization](globalization-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Globalization](globalization-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1508.md b/docs/fundamentals/code-analysis/quality-rules/ca1508.md index 495f1e6d78292..09ba79b23b45c 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1508.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1508.md @@ -89,11 +89,20 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Maintainability](maintainability-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +In addition, the following dataflow analysis–related options apply to this rule: -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Maintainability](maintainability-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] + +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## See also diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1700.md b/docs/fundamentals/code-analysis/quality-rules/ca1700.md index 7475852d38df2..f87c858c3aa69 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1700.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1700.md @@ -74,7 +74,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1707.md b/docs/fundamentals/code-analysis/quality-rules/ca1707.md index 60dc2e20d248d..5f98badefe422 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1707.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1707.md @@ -68,7 +68,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1708.md b/docs/fundamentals/code-analysis/quality-rules/ca1708.md index fb8f19355f034..f50c82ecb8889 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1708.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1708.md @@ -47,7 +47,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example of a violation diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1710.md b/docs/fundamentals/code-analysis/quality-rules/ca1710.md index 0067abd9d57af..ce8458edd620f 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1710.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1710.md @@ -35,39 +35,39 @@ Naming conventions provide a common look for libraries that target the common la The following table lists the base types and interfaces that have associated suffixes. -| Base type/Interface | Suffix | -| ---------------------------------------------------------------------------------- | ----------------------- | -| | Attribute | -| | EventArgs | -| | Exception | -| | Collection | -| | Dictionary | -| | Collection | -| | Dictionary | -| | Collection or Queue | -| | Collection or Stack | -| | Collection | -| | Dictionary | -| | DataSet | -| | Collection or DataTable | -| | Stream | -| | Permission | -| | Condition | -| An event-handler delegate. | EventHandler | +| Base type/Interface | Suffix | +|------------------------------------------------------------------------------------|-----------------------------| +| | `Attribute` | +| | `EventArgs` | +| | `Exception` | +| | `Collection` | +| | `Dictionary` | +| | `Collection` | +| | `Dictionary` | +| | `Collection` or `Queue` | +| | `Collection` or `Stack` | +| | `Collection` | +| | `Dictionary` | +| | `DataSet` | +| | `Collection` or `DataTable` | +| | `Stream` | +| | `Permission` | +| | `Condition` | +| An event-handler delegate. | `EventHandler` | Types that implement and are a generalized type of data structure, such as a dictionary, stack, or queue, are allowed names that provide meaningful information about the intended usage of the type. -Types that implement and are a collection of specific items have names that end with the word 'Collection'. For example, a collection of objects would have the name 'QueueCollection'. The 'Collection' suffix signifies that the members of the collection can be enumerated by using the `foreach` (`For Each` in Visual Basic) statement. +Types that implement and are a collection of specific items have names that end with the word `Collection`. For example, a collection of objects would have the name `QueueCollection`. The `Collection` suffix signifies that the members of the collection can be enumerated by using the `foreach` (`For Each` in Visual Basic) statement. -Types that implement or have names that end with the word 'Dictionary' even if the type also implements or . The 'Collection' and 'Dictionary' suffix naming conventions enable users to distinguish between the following two enumeration patterns. +Types that implement or have names that end with the word `Dictionary` even if the type also implements or . The `Collection` and `Dictionary` suffix naming conventions enable users to distinguish between the following two enumeration patterns. -Types with the 'Collection' suffix follow this enumeration pattern. +Types with the `Collection` suffix follow this enumeration pattern. ```csharp foreach(SomeType x in SomeCollection) { } ``` -Types with the 'Dictionary' suffix follow this enumeration pattern. +Types with the `Dictionary` suffix follow this enumeration pattern. ```csharp foreach(SomeType x in SomeDictionary.Values) { } @@ -81,7 +81,7 @@ Rename the type so that it is suffixed with the correct term. ## When to suppress warnings -It is safe to suppress a warning to use the 'Collection' suffix if the type is a generalized data structure that might be extended or that will hold an arbitrary set of diverse items. In this case, a name that provides meaningful information about the implementation, performance, or other characteristics of the data structure might make sense (for example, BinaryTree). In cases where the type represents a collection of a specific type (for example, StringCollection), do not suppress a warning from this rule because the suffix indicates that the type can be enumerated by using a `foreach` statement. +It is safe to suppress a warning to use the `Collection` suffix if the type is a generalized data structure that might be extended or that will hold an arbitrary set of diverse items. In this case, a name that provides meaningful information about the implementation, performance, or other characteristics of the data structure might make sense (for example, BinaryTree). In cases where the type represents a collection of a specific type (for example, StringCollection), do not suppress a warning from this rule because the suffix indicates that the type can be enumerated by using a `foreach` statement. For other suffixes, do not suppress a warning from this rule. The suffix allows the intended usage to be evident from the type name. @@ -112,9 +112,9 @@ Use the following options to configure which parts of your codebase to run this - [Exclude indirect base types](#exclude-indirect-base-types) - [Additional required suffixes](#additional-required-suffixes) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Naming](naming-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Exclude indirect base types diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1711.md b/docs/fundamentals/code-analysis/quality-rules/ca1711.md index ba2fac78988e0..420a159dbffe8 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1711.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1711.md @@ -31,20 +31,20 @@ By default, this rule only looks at externally visible identifiers, but this is By convention, only the names of types that extend certain base types or that implement certain interfaces, or types derived from these types, should end with specific reserved suffixes. Other type names should not use these reserved suffixes. -The following table lists the reserved suffixes and the base types and interfaces with which they are associated. - -|Suffix|Base type/Interface| -|------------|--------------------------| -|Attribute|| -|Collection|











| -|Dictionary|

| -|EventArgs|| -|EventHandler|An event-handler delegate| -|Exception|| -|Permission|| -|Queue|| -|Stack|| -|Stream|| +The following table lists the reserved suffixes and the base types and interfaces with which they're associated. + +| Suffix | Base type/Interface | +|----------------|-------------------------------------------------------------| +| `Attribute` | | +| `Collection` |











| +| `Dictionary` |

| +| `EventArgs` | | +| `EventHandler` | An event-handler delegate | +| `Exception` | | +| `Permission` | | +| `Queue` | | +| `Stack` | | +| `Stream` | | In addition, the following suffixes should **not** be used: @@ -90,9 +90,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Allow suffixes](#allow-suffixes) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Naming](naming-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Allow suffixes diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1714.md b/docs/fundamentals/code-analysis/quality-rules/ca1714.md index 10e78446fc40f..c8067803ef1e5 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1714.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1714.md @@ -68,7 +68,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1715.md b/docs/fundamentals/code-analysis/quality-rules/ca1715.md index b18f72e6b8a96..88e27e9c63d23 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1715.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1715.md @@ -16,13 +16,13 @@ dev_langs: --- # CA1715: Identifiers should have correct prefix -| Property | Value | -|-------------------------------------|------------------------------------------------------------------------------------------------------| -| **Rule ID** | CA1715 | -| **Title** | Identifiers should have correct prefix | -| **Category** | [Naming](naming-warnings.md) | +| Property | Value | +|-------------------------------------|----------------------------------------| +| **Rule ID** | CA1715 | +| **Title** | Identifiers should have correct prefix | +| **Category** | [Naming](naming-warnings.md) | | **Fix is breaking or non-breaking** | Breaking - when fired on interfaces.

Non-breaking - when raised on generic type parameters. | -| **Enabled by default in .NET 9** | No | +| **Enabled by default in .NET 9** | No | ## Cause @@ -51,9 +51,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Single-character type parameters](#single-character-type-parameters) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Naming](naming-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Single-character type parameters diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1716.md b/docs/fundamentals/code-analysis/quality-rules/ca1716.md index aad92556ff1b1..7bc744fd4a850 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1716.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1716.md @@ -73,9 +73,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Analyzed symbol kinds](#analyzed-symbol-kinds) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Naming](naming-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Analyzed symbol kinds diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1717.md b/docs/fundamentals/code-analysis/quality-rules/ca1717.md index d58c9d096a434..2509a57814b58 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1717.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1717.md @@ -70,7 +70,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1720.md b/docs/fundamentals/code-analysis/quality-rules/ca1720.md index aada31291e9e4..93e737b5c6e8f 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1720.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1720.md @@ -122,7 +122,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1721.md b/docs/fundamentals/code-analysis/quality-rules/ca1721.md index 43027e49b6cf1..544945ddf4944 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1721.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1721.md @@ -72,7 +72,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1725.md b/docs/fundamentals/code-analysis/quality-rules/ca1725.md index e952e8656ccfd..e03cefe580848 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1725.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1725.md @@ -66,4 +66,4 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Naming](naming-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1801.md b/docs/fundamentals/code-analysis/quality-rules/ca1801.md index 342df73970ec2..24064becfac01 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1801.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1801.md @@ -94,7 +94,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Performance) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] By default, the CA1801 rule applies to all API surfaces (public, internal, and private). diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1802.md b/docs/fundamentals/code-analysis/quality-rules/ca1802.md index e6e4971d28287..f61ab048a9dd8 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1802.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1802.md @@ -81,9 +81,9 @@ Use the following options to configure which parts of your codebase to run this - [Include specific API surfaces](#include-specific-api-surfaces) - [Required modifiers](#required-modifiers) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Performance](performance-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Performance](performance-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ### Required modifiers diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1806.md b/docs/fundamentals/code-analysis/quality-rules/ca1806.md index 355b46c4ce3c2..3a2fa43a3af4b 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1806.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1806.md @@ -29,11 +29,8 @@ dev_langs: There are several possible reasons for this warning: - A new object is created but never used. - - A method that creates and returns a new string is called and the new string is never used. - - A COM or P/Invoke method that returns a `HRESULT` or error code that's never used. - - A language-integrated query (LINQ) method that returns a result that's never used. ## Rule description diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1812.md b/docs/fundamentals/code-analysis/quality-rules/ca1812.md index 1e2c04b7570df..e2862bc883b54 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1812.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1812.md @@ -102,7 +102,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Performance) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE [ignore-ivt](../includes/ignore-ivt.md)] +[!INCLUDE [ignore-ivt](../includes/config-options/ignore-ivt.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1815.md b/docs/fundamentals/code-analysis/quality-rules/ca1815.md index 1b3727aea8b93..62e43d270ec2e 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1815.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1815.md @@ -66,7 +66,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Performance](performance-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1819.md b/docs/fundamentals/code-analysis/quality-rules/ca1819.md index 9d84bdf7c173f..c208c7ca47235 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1819.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1819.md @@ -73,7 +73,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Performance](performance-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example violation diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1822.md b/docs/fundamentals/code-analysis/quality-rules/ca1822.md index 17817091fd76f..fc63b9fc548af 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1822.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1822.md @@ -64,7 +64,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Performance](performance-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1852.md b/docs/fundamentals/code-analysis/quality-rules/ca1852.md index 34efdc573faef..10e38f544fbca 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1852.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1852.md @@ -94,4 +94,4 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Performance) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE [ignore-ivt](../includes/ignore-ivt.md)] +[!INCLUDE [ignore-ivt](../includes/config-options/ignore-ivt.md)] diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2000.md b/docs/fundamentals/code-analysis/quality-rules/ca2000.md index e10386aa4d28c..06f7a363ad113 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2000.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2000.md @@ -1,7 +1,7 @@ --- title: "CA2000: Dispose objects before losing scope (code analysis)" description: "Learn about code analysis rule CA2000: Dispose objects before losing scope" -ms.date: 05/14/2019 +ms.date: 02/01/2025 f1_keywords: - CA2000 - Dispose objects before losing scope @@ -95,16 +95,29 @@ For more information, see [How to suppress code analysis warnings](../suppress-w ## Configure code to analyze -Use the following options to configure which parts of your codebase to run this rule on. +Use the following options to configure which parts of your codebase to run this rule on, and when dispose ownership should be transferred. - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) +- [Configure dispose ownership transfer](#configure-dispose-ownership-transfer) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Reliability](reliability-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +In addition, the following other dataflow analysis–related options apply to this rule: -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +- [dispose_analysis_kind](../code-quality-rule-options.md#dispose_analysis_kind) +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Reliability](reliability-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] + +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] + +[!INCLUDE[dispose-ownership-transfer](../includes/config-options/dispose-ownership-transfer.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2100.md b/docs/fundamentals/code-analysis/quality-rules/ca2100.md index a2bc0b65b0455..b895770a83559 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2100.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2100.md @@ -92,11 +92,20 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +In addition, the following dataflow analysis–related options apply to this rule: -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] + +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2208.md b/docs/fundamentals/code-analysis/quality-rules/ca2208.md index 4647e58ed041d..01a18c7671706 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2208.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2208.md @@ -91,7 +91,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category (Design) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] By default, the CA2208 rule applies to all API surfaces (public, internal, and private). diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2213.md b/docs/fundamentals/code-analysis/quality-rules/ca2213.md index aee59138b33bf..124bc3a84088b 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2213.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2213.md @@ -74,6 +74,19 @@ dotnet_diagnostic.CA2213.severity = none For more information, see [How to suppress code analysis warnings](../suppress-warnings.md). +## Configure dataflow analysis + +Use the following options to configure dataflow analysis for this rule: + +- [interprocedural_analysis_kind](../code-quality-rule-options.md#interprocedural_analysis_kind) +- [max_interprocedural_lambda_or_local_function_call_chain](../code-quality-rule-options.md#max_interprocedural_lambda_or_local_function_call_chain) +- [max_interprocedural_method_call_chain](../code-quality-rule-options.md#max_interprocedural_method_call_chain) +- [points_to_analysis_kind](../code-quality-rule-options.md#points_to_analysis_kind) +- [copy_analysis](../code-quality-rule-options.md#copy_analysis) +- [sufficient_IterationCount_for_weak_KDF_algorithm](../code-quality-rule-options.md#sufficient_iterationcount_for_weak_kdf_algorithm) + +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). + ## Example The following snippet shows a type `TypeA` that implements . diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2217.md b/docs/fundamentals/code-analysis/quality-rules/ca2217.md index 5bf7a0ecf15f8..01182494ba083 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2217.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2217.md @@ -50,7 +50,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Usage](usage-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2225.md b/docs/fundamentals/code-analysis/quality-rules/ca2225.md index 3549dbbfc1e0a..69fd1fc7b6c89 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2225.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2225.md @@ -118,7 +118,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Usage](usage-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2226.md b/docs/fundamentals/code-analysis/quality-rules/ca2226.md index 4b8b6759d11d2..189a0b134c2c6 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2226.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2226.md @@ -49,7 +49,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Usage](usage-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Related rules diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2231.md b/docs/fundamentals/code-analysis/quality-rules/ca2231.md index ac3325412723d..9d4dba6a1e1ec 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2231.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2231.md @@ -86,7 +86,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Usage](usage-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2234.md b/docs/fundamentals/code-analysis/quality-rules/ca2234.md index 3da8a585843e8..fbf4b31a24651 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2234.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2234.md @@ -69,7 +69,7 @@ Use the following option to configure which parts of your codebase to run this r You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Usage](usage-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[api-surface](../includes/api-surface.md)] +[!INCLUDE[api-surface](../includes/config-options/api-surface.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2301.md b/docs/fundamentals/code-analysis/quality-rules/ca2301.md index 797f5026c9145..f77161bc03667 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2301.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2301.md @@ -51,11 +51,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2302.md b/docs/fundamentals/code-analysis/quality-rules/ca2302.md index 077f14f9e4856..a2d924bd0defa 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2302.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2302.md @@ -53,11 +53,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2311.md b/docs/fundamentals/code-analysis/quality-rules/ca2311.md index 7b1a211472f1b..593b644e2db73 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2311.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2311.md @@ -51,11 +51,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2312.md b/docs/fundamentals/code-analysis/quality-rules/ca2312.md index f77b4347ff5de..7810bcc64ab51 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2312.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2312.md @@ -55,11 +55,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2321.md b/docs/fundamentals/code-analysis/quality-rules/ca2321.md index bfd4d5c80bc3a..500a32ab198d7 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2321.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2321.md @@ -68,11 +68,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2322.md b/docs/fundamentals/code-analysis/quality-rules/ca2322.md index fe5b94db4cc80..65d7bd745f0d1 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2322.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2322.md @@ -69,11 +69,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2327.md b/docs/fundamentals/code-analysis/quality-rules/ca2327.md index b4f04c30aaf6b..614d0c3bf6519 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2327.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2327.md @@ -78,11 +78,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2328.md b/docs/fundamentals/code-analysis/quality-rules/ca2328.md index 087cd3e0af686..48e631e37a2de 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2328.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2328.md @@ -84,11 +84,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2329.md b/docs/fundamentals/code-analysis/quality-rules/ca2329.md index e43e4e596c446..96dc3dcd19a13 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2329.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2329.md @@ -71,11 +71,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca2330.md b/docs/fundamentals/code-analysis/quality-rules/ca2330.md index bdcb721d1fa45..b2af060af47b2 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca2330.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca2330.md @@ -77,11 +77,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3001.md b/docs/fundamentals/code-analysis/quality-rules/ca3001.md index b6b181b829981..cbc2dfb7ae366 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3001.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3001.md @@ -72,11 +72,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3002.md b/docs/fundamentals/code-analysis/quality-rules/ca3002.md index fc4e308c35487..6661a9f33ed77 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3002.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3002.md @@ -79,11 +79,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3003.md b/docs/fundamentals/code-analysis/quality-rules/ca3003.md index b9c5f236cdb2a..14aad1052dcd6 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3003.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3003.md @@ -61,11 +61,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3004.md b/docs/fundamentals/code-analysis/quality-rules/ca3004.md index 43bc006331420..f7f72bef166a0 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3004.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3004.md @@ -72,11 +72,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3005.md b/docs/fundamentals/code-analysis/quality-rules/ca3005.md index e7128ca22de4c..0029bae581daa 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3005.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3005.md @@ -78,11 +78,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3006.md b/docs/fundamentals/code-analysis/quality-rules/ca3006.md index 7875ad5f211ca..d9f9271f1c876 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3006.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3006.md @@ -73,11 +73,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3007.md b/docs/fundamentals/code-analysis/quality-rules/ca3007.md index 7bdbcd85d8968..d09f8095b2339 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3007.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3007.md @@ -78,11 +78,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3008.md b/docs/fundamentals/code-analysis/quality-rules/ca3008.md index 28f89dc534c82..b38aacc011d7b 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3008.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3008.md @@ -76,11 +76,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3009.md b/docs/fundamentals/code-analysis/quality-rules/ca3009.md index 8ce297120d882..d9884c4c8fb3a 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3009.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3009.md @@ -90,8 +90,8 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3010.md b/docs/fundamentals/code-analysis/quality-rules/ca3010.md index 8ce200e7e2c97..a8535e1687611 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3010.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3010.md @@ -53,11 +53,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3011.md b/docs/fundamentals/code-analysis/quality-rules/ca3011.md index 26c6379f50fbf..41dabc54ad5af 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3011.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3011.md @@ -53,11 +53,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca3012.md b/docs/fundamentals/code-analysis/quality-rules/ca3012.md index 1a5da3db71266..61158fdba2fc9 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca3012.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca3012.md @@ -77,11 +77,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5361.md b/docs/fundamentals/code-analysis/quality-rules/ca5361.md index 5669a62663e59..6183e1b57634c 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5361.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5361.md @@ -67,11 +67,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5376.md b/docs/fundamentals/code-analysis/quality-rules/ca5376.md index 608c9935cce68..87ffdca671533 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5376.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5376.md @@ -43,11 +43,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5377.md b/docs/fundamentals/code-analysis/quality-rules/ca5377.md index ff19ee3fbeb7d..9b4cb84559998 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5377.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5377.md @@ -62,11 +62,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5378.md b/docs/fundamentals/code-analysis/quality-rules/ca5378.md index 3a6d3c9773a71..1ba4d167ced50 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5378.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5378.md @@ -67,11 +67,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5380.md b/docs/fundamentals/code-analysis/quality-rules/ca5380.md index b95a58b7ba1ee..c08cd8a785d21 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5380.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5380.md @@ -44,11 +44,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5381.md b/docs/fundamentals/code-analysis/quality-rules/ca5381.md index 51177883a8fb0..f9337d7733170 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5381.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5381.md @@ -44,11 +44,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5382.md b/docs/fundamentals/code-analysis/quality-rules/ca5382.md index c85efb7c3c3d9..f1d44ad8b9342 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5382.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5382.md @@ -80,11 +80,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5383.md b/docs/fundamentals/code-analysis/quality-rules/ca5383.md index 7c3aceb08a9be..1958027cfc5f4 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5383.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5383.md @@ -80,11 +80,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5384.md b/docs/fundamentals/code-analysis/quality-rules/ca5384.md index 4136101b1c51d..86db1a51556b2 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5384.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5384.md @@ -65,11 +65,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5387.md b/docs/fundamentals/code-analysis/quality-rules/ca5387.md index 22caee67c18ca..5fe07f219baaa 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5387.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5387.md @@ -63,11 +63,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5388.md b/docs/fundamentals/code-analysis/quality-rules/ca5388.md index d20ddd461dff6..0ddcec3481456 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5388.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5388.md @@ -66,11 +66,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5389.md b/docs/fundamentals/code-analysis/quality-rules/ca5389.md index f1c353d008fae..ac579aa03653a 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5389.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5389.md @@ -70,11 +70,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Example diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5390.md b/docs/fundamentals/code-analysis/quality-rules/ca5390.md index 3a2d8331d2b8a..0b298a86d174c 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5390.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5390.md @@ -47,11 +47,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5399.md b/docs/fundamentals/code-analysis/quality-rules/ca5399.md index 91b9dd1bcf1e6..fd377631e2b57 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5399.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5399.md @@ -42,11 +42,11 @@ Use the following options to configure which parts of your codebase to run this - [Exclude specific symbols](#exclude-specific-symbols) - [Exclude specific types and their derived types](#exclude-specific-types-and-their-derived-types) -You can configure these options for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). +You can configure these options for just this rule, for all rules they apply to, or for all rules in this category ([Security](security-warnings.md)) that they apply to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples diff --git a/docs/fundamentals/code-analysis/quality-rules/ca5400.md b/docs/fundamentals/code-analysis/quality-rules/ca5400.md index 932928229ca58..183ca25ca0474 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca5400.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca5400.md @@ -63,9 +63,9 @@ Use the following options to configure which parts of your codebase to run this You can configure this option for just this rule, for all rules it applies to, or for all rules in this category ([Security](security-warnings.md)) that it applies to. For more information, see [Code quality rule configuration options](../code-quality-rule-options.md). -[!INCLUDE[excluded-symbol-names](../includes/excluded-symbol-names.md)] +[!INCLUDE[excluded-symbol-names](../includes/config-options/excluded-symbol-names.md)] -[!INCLUDE[excluded-type-names-with-derived-types](../includes/excluded-type-names-with-derived-types.md)] +[!INCLUDE[excluded-type-names-with-derived-types](../includes/config-options/excluded-type-names-with-derived-types.md)] ## Pseudo-code examples From 9c9921bf1eb991c47a7c35576ccb0a2d3bfbe638 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Mon, 3 Feb 2025 08:41:01 -0800 Subject: [PATCH 4/8] Update package index with latest published versions (#44663) --- docs/azure/includes/dotnet-all.md | 2 +- docs/azure/includes/dotnet-new.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/azure/includes/dotnet-all.md b/docs/azure/includes/dotnet-all.md index 6fc9294cfb7a2..2fdc8c2519c9e 100644 --- a/docs/azure/includes/dotnet-all.md +++ b/docs/azure/includes/dotnet-all.md @@ -289,7 +289,7 @@ | Resource Management - NetApp Files | NuGet [1.8.0](https://www.nuget.org/packages/Azure.ResourceManager.NetApp/1.8.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetApp-readme) | GitHub [1.8.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetApp_1.8.0/sdk/netapp/Azure.ResourceManager.NetApp/) | | Resource Management - Network | NuGet [1.10.0](https://www.nuget.org/packages/Azure.ResourceManager.Network/1.10.0) | [docs](/dotnet/api/overview/azure/ResourceManager.Network-readme) | GitHub [1.10.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Network_1.10.0/sdk/network/Azure.ResourceManager.Network/) | | Resource Management - Network Analytics | NuGet [1.0.0](https://www.nuget.org/packages/Azure.ResourceManager.NetworkAnalytics/1.0.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkAnalytics-readme) | GitHub [1.0.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkAnalytics_1.0.0/sdk/networkanalytics/Azure.ResourceManager.NetworkAnalytics/) | -| Resource Management - Network Cloud | NuGet [1.0.1](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.0.1)
NuGet [1.1.0-beta.1](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.1.0-beta.1) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkCloud-readme) | GitHub [1.0.1](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.0.1/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/)
GitHub [1.1.0-beta.1](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.1.0-beta.1/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/) | +| Resource Management - Network Cloud | NuGet [1.1.0](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.1.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkCloud-readme) | GitHub [1.1.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.1.0/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/) | | Resource Management - Network Function | NuGet [1.0.0-beta.4](https://www.nuget.org/packages/Azure.ResourceManager.NetworkFunction/1.0.0-beta.4) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkFunction-readme?view=azure-dotnet-preview&preserve-view=true) | GitHub [1.0.0-beta.4](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkFunction_1.0.0-beta.4/sdk/networkfunction/Azure.ResourceManager.NetworkFunction/) | | Resource Management - New Relic Observability | NuGet [1.1.0](https://www.nuget.org/packages/Azure.ResourceManager.NewRelicObservability/1.1.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NewRelicObservability-readme) | GitHub [1.1.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NewRelicObservability_1.1.0/sdk/newrelicobservability/Azure.ResourceManager.NewRelicObservability/) | | Resource Management - Nginx | NuGet [1.0.0](https://www.nuget.org/packages/Azure.ResourceManager.Nginx/1.0.0)
NuGet [1.1.0-beta.2](https://www.nuget.org/packages/Azure.ResourceManager.Nginx/1.1.0-beta.2) | [docs](/dotnet/api/overview/azure/ResourceManager.Nginx-readme) | GitHub [1.0.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Nginx_1.0.0/sdk/nginx/Azure.ResourceManager.Nginx/)
GitHub [1.1.0-beta.2](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Nginx_1.1.0-beta.2/sdk/nginx/Azure.ResourceManager.Nginx/) | diff --git a/docs/azure/includes/dotnet-new.md b/docs/azure/includes/dotnet-new.md index 01119636288fa..a184f7e2a55f1 100644 --- a/docs/azure/includes/dotnet-new.md +++ b/docs/azure/includes/dotnet-new.md @@ -296,7 +296,7 @@ | Resource Management - NetApp Files | NuGet [1.8.0](https://www.nuget.org/packages/Azure.ResourceManager.NetApp/1.8.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetApp-readme) | GitHub [1.8.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetApp_1.8.0/sdk/netapp/Azure.ResourceManager.NetApp/) | | Resource Management - Network | NuGet [1.10.0](https://www.nuget.org/packages/Azure.ResourceManager.Network/1.10.0) | [docs](/dotnet/api/overview/azure/ResourceManager.Network-readme) | GitHub [1.10.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Network_1.10.0/sdk/network/Azure.ResourceManager.Network/) | | Resource Management - Network Analytics | NuGet [1.0.0](https://www.nuget.org/packages/Azure.ResourceManager.NetworkAnalytics/1.0.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkAnalytics-readme) | GitHub [1.0.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkAnalytics_1.0.0/sdk/networkanalytics/Azure.ResourceManager.NetworkAnalytics/) | -| Resource Management - Network Cloud | NuGet [1.0.1](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.0.1)
NuGet [1.1.0-beta.1](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.1.0-beta.1) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkCloud-readme) | GitHub [1.0.1](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.0.1/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/)
GitHub [1.1.0-beta.1](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.1.0-beta.1/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/) | +| Resource Management - Network Cloud | NuGet [1.1.0](https://www.nuget.org/packages/Azure.ResourceManager.NetworkCloud/1.1.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkCloud-readme) | GitHub [1.1.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkCloud_1.1.0/sdk/networkcloud/Azure.ResourceManager.NetworkCloud/) | | Resource Management - Network Function | NuGet [1.0.0-beta.4](https://www.nuget.org/packages/Azure.ResourceManager.NetworkFunction/1.0.0-beta.4) | [docs](/dotnet/api/overview/azure/ResourceManager.NetworkFunction-readme?view=azure-dotnet-preview&preserve-view=true) | GitHub [1.0.0-beta.4](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NetworkFunction_1.0.0-beta.4/sdk/networkfunction/Azure.ResourceManager.NetworkFunction/) | | Resource Management - New Relic Observability | NuGet [1.1.0](https://www.nuget.org/packages/Azure.ResourceManager.NewRelicObservability/1.1.0) | [docs](/dotnet/api/overview/azure/ResourceManager.NewRelicObservability-readme) | GitHub [1.1.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.NewRelicObservability_1.1.0/sdk/newrelicobservability/Azure.ResourceManager.NewRelicObservability/) | | Resource Management - Nginx | NuGet [1.0.0](https://www.nuget.org/packages/Azure.ResourceManager.Nginx/1.0.0)
NuGet [1.1.0-beta.2](https://www.nuget.org/packages/Azure.ResourceManager.Nginx/1.1.0-beta.2) | [docs](/dotnet/api/overview/azure/ResourceManager.Nginx-readme) | GitHub [1.0.0](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Nginx_1.0.0/sdk/nginx/Azure.ResourceManager.Nginx/)
GitHub [1.1.0-beta.2](https://github.com/Azure/azure-sdk-for-net/tree/Azure.ResourceManager.Nginx_1.1.0-beta.2/sdk/nginx/Azure.ResourceManager.Nginx/) | From 7ec7c8aa106af19ee47b9fb6b51f39b42d7f96cd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:35:36 -0800 Subject: [PATCH 5/8] Bump the dotnet group (#44660) Bumps the dotnet group in /docs/ai/quickstarts/snippets/assistants with 3 updates: [Azure.AI.OpenAI](https://github.com/Azure/azure-sdk-for-net), [OpenAI](https://github.com/openai/openai-dotnet) and [Azure.Identity](https://github.com/Azure/azure-sdk-for-net). Updates `Azure.AI.OpenAI` from 2.1.0-beta.2 to 2.1.0 - [Release notes](https://github.com/Azure/azure-sdk-for-net/releases) - [Commits](https://github.com/Azure/azure-sdk-for-net/compare/Azure.AI.OpenAI_2.1.0-beta.2...Azure.AI.OpenAI_2.1.0) Updates `OpenAI` from 2.1.0 to 2.1.0 - [Release notes](https://github.com/openai/openai-dotnet/releases) - [Changelog](https://github.com/openai/openai-dotnet/blob/main/CHANGELOG.md) - [Commits](https://github.com/openai/openai-dotnet/compare/OpenAI_2.1.0...OpenAI_2.1.0) Updates `Azure.Identity` from 1.13.1 to 1.13.2 - [Release notes](https://github.com/Azure/azure-sdk-for-net/releases) - [Commits](https://github.com/Azure/azure-sdk-for-net/compare/Azure.Identity_1.13.1...Azure.Identity_1.13.2) --- updated-dependencies: - dependency-name: Azure.AI.OpenAI dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet - dependency-name: OpenAI dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet - dependency-name: Azure.Identity dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- docs/ai/quickstarts/snippets/assistants/AIAssistants.csproj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ai/quickstarts/snippets/assistants/AIAssistants.csproj b/docs/ai/quickstarts/snippets/assistants/AIAssistants.csproj index fc0f58f7521c5..4e6b79d1c9152 100644 --- a/docs/ai/quickstarts/snippets/assistants/AIAssistants.csproj +++ b/docs/ai/quickstarts/snippets/assistants/AIAssistants.csproj @@ -8,8 +8,8 @@ - - + + From 96d0fa96acf00062e9ae4b3cf3a4628b17710f16 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:35:58 -0800 Subject: [PATCH 6/8] Bump actions/setup-dotnet from 4.2.0 to 4.3.0 (#44658) Bumps [actions/setup-dotnet](https://github.com/actions/setup-dotnet) from 4.2.0 to 4.3.0. - [Release notes](https://github.com/actions/setup-dotnet/releases) - [Commits](https://github.com/actions/setup-dotnet/compare/87b7050bc53ea08284295505d98d2aa94301e852...3951f0dfe7a07e2313ec93c75700083e2005cbab) --- updated-dependencies: - dependency-name: actions/setup-dotnet dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/snippets5000.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/snippets5000.yml b/.github/workflows/snippets5000.yml index a97fe3924add0..8481e4177ec8a 100644 --- a/.github/workflows/snippets5000.yml +++ b/.github/workflows/snippets5000.yml @@ -41,7 +41,7 @@ jobs: # Get the latest preview SDK (or sdk not installed by the runner) - name: Setup .NET if: ${{ env.DOTNET_DO_INSTALL == 'true' }} - uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 #@4.2.0 + uses: actions/setup-dotnet@3951f0dfe7a07e2313ec93c75700083e2005cbab #@4.3.0 with: dotnet-version: ${{ env.DOTNET_VERSION }} dotnet-quality: ${{ env.DOTNET_QUALITY }} From b5a038cd50c241227afe63f8d2f3aa482c6316a4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:37:13 -0800 Subject: [PATCH 7/8] Bump github/codeql-action from 3.28.6 to 3.28.8 (#44657) Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.28.6 to 3.28.8. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/17a820bf2e43b47be2c72b39cc905417bc1ab6d0...dd746615b3b9d728a6a37ca2045b68ca76d4841a) --- updated-dependencies: - dependency-name: github/codeql-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/scorecards.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml index b92c62a2c2829..7139faf353a3f 100644 --- a/.github/workflows/scorecards.yml +++ b/.github/workflows/scorecards.yml @@ -71,6 +71,6 @@ jobs: # Upload the results to GitHub's code scanning dashboard. - name: "Upload to code-scanning" - uses: github/codeql-action/upload-sarif@17a820bf2e43b47be2c72b39cc905417bc1ab6d0 # v3.28.6 + uses: github/codeql-action/upload-sarif@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8 with: sarif_file: results.sarif From 5802e8b74127b0d9d2a116d5be43674d78179c30 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:38:18 -0800 Subject: [PATCH 8/8] Bump the dotnet group (#44659) Bumps the dotnet group in /docs/core/diagnostics/snippets/Microsoft.Diagnostics.NETCore.Client/csharp with 2 updates: [Microsoft.Diagnostics.NETCore.Client](https://github.com/dotnet/diagnostics) and [Microsoft.Diagnostics.Tracing.TraceEvent](https://github.com/Microsoft/perfview). Updates `Microsoft.Diagnostics.NETCore.Client` from 0.2.553101 to 0.2.510501 - [Release notes](https://github.com/dotnet/diagnostics/releases) - [Commits](https://github.com/dotnet/diagnostics/commits) Updates `Microsoft.Diagnostics.Tracing.TraceEvent` from 3.1.18 to 3.1.19 - [Release notes](https://github.com/Microsoft/perfview/releases) - [Commits](https://github.com/Microsoft/perfview/compare/v3.1.18...v3.1.19) --- updated-dependencies: - dependency-name: Microsoft.Diagnostics.NETCore.Client dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet - dependency-name: Microsoft.Diagnostics.Tracing.TraceEvent dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dotnet ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .../csharp/Microsoft.Diagnostics.NETCore.Client.Samples.csproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/diagnostics/snippets/Microsoft.Diagnostics.NETCore.Client/csharp/Microsoft.Diagnostics.NETCore.Client.Samples.csproj b/docs/core/diagnostics/snippets/Microsoft.Diagnostics.NETCore.Client/csharp/Microsoft.Diagnostics.NETCore.Client.Samples.csproj index c1a2a67a17e57..fa1e2b1be14ff 100644 --- a/docs/core/diagnostics/snippets/Microsoft.Diagnostics.NETCore.Client/csharp/Microsoft.Diagnostics.NETCore.Client.Samples.csproj +++ b/docs/core/diagnostics/snippets/Microsoft.Diagnostics.NETCore.Client/csharp/Microsoft.Diagnostics.NETCore.Client.Samples.csproj @@ -7,7 +7,7 @@ - +