swift-mirror/userdocs/diagnostics/diagnostic-groups.md

Diagnostic groups

Detailed explanations for various compiler diagnostics.

Overview

Diagnostic groups collect some number of diagnostics together under a common group name. This allows for extra documentation to help explain relevant language concepts, as well as the ability to control the behavior of warnings in a more precise manner (when that group contains warnings):

• -Werror <group> - upgrades warnings in the specified group to errors
• -Wwarning <group> - indicates that warnings in the specified group should remain warnings, even if they were previously upgraded to errors

As a concrete example, to upgrade deprecated declaration warnings to errors:

-Werror DeprecatedDeclaration

Or upgrade all warnings except deprecated declaration to errors:

-warnings-as-errors -Wwarning DeprecatedDeclaration

Groups with warnings

• doc:add-preconcurrency-import
• doc:always-available-domain
• doc:trailing-closure-matching
• doc:compilation-caching
• doc:string-interpolation-conformance
• doc:deprecated-declaration
• doc:implementation-only-deprecated
• doc:dynamic-exclusivity
• doc:embedded-restrictions
• doc:existential-type
• doc:explicit-sendable-annotations
• doc:preconcurrency-import
• doc:foreign-reference-type
• doc:return-type-implicit-copy
• doc:implicit-strong-capture
• doc:clang-declaration-import
• doc:inconsistent-import-access
• doc:isolated-conformances
• doc:error-in-future-swift-version
• doc:old-suppressed-associatedtypes
• doc:module-version-missing
• doc:module-self-import
• doc:oslog
• doc:option-obsoleted-by-module-selectors
• doc:result-builder-methods
• doc:spi-import-ignored
• doc:semantic-copies
• doc:strict-language-features
• doc:strict-memory-safety
• doc:unavailable-sendable-conformance
• doc:unknown-warning-group
• doc:unnecessary-effect-marker
• doc:unsupported-scoped-import
• doc:untyped-throws
• doc:unused-import-access
• doc:no-use-throwing-unstructured-task
• doc:no-usage
• doc:use-any-apple-os-availability

Topics

• doc:dynamic-callable-requirements
• doc:add-preconcurrency-import
• doc:always-available-domain
• doc:trailing-closure-matching
• doc:actor-isolated-mutating-async
• doc:actor-isolated-call
• doc:sendable-closure-captures
• doc:compilation-caching
• doc:string-interpolation-conformance
• doc:region-isolation-cross-isolation-data-race
• doc:deprecated-declaration
• doc:implementation-only-deprecated
• doc:dynamic-exclusivity
• doc:embedded-restrictions
• doc:existential-type
• doc:explicit-sendable-annotations
• doc:preconcurrency-import
• doc:foreign-reference-type
• doc:return-type-implicit-copy
• doc:implicit-strong-capture
• doc:clang-declaration-import
• doc:inconsistent-import-access
• doc:isolated-conformances
• doc:error-in-future-swift-version
• doc:old-suppressed-associatedtypes
• doc:missing-module-on-known-paths
• doc:module-version-missing
• doc:module-not-testable
• doc:module-self-import
• doc:multiple-inheritance
• doc:nominal-types
• doc:oslog
• doc:option-obsoleted-by-module-selectors
• doc:exclusivity-violation
• doc:performance-hints
• doc:property-wrapper-requirements
• doc:conformance-isolation
• doc:protocol-type-non-conformance
• doc:result-builder-methods
• doc:spi-import-ignored
• doc:semantic-copies
• doc:sendable-metatypes
• doc:sending-closure-risks-data-race
• doc:sending-risks-data-race
• doc:strict-language-features
• doc:strict-memory-safety
• doc:temporary-pointers
• doc:unavailable-sendable-conformance
• doc:opaque-type-inference
• doc:region-isolation-unknown-pattern
• doc:unknown-warning-group
• doc:unnecessary-effect-marker
• doc:availability-unrecognized-name
• doc:mutable-global-variable
• doc:unsupported-scoped-import
• doc:untyped-throws
• doc:unused-import-access
• doc:no-use-throwing-unstructured-task
• doc:no-usage
• doc:use-any-apple-os-availability
• doc:existential-member-access-limitations