mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
This is mostly just cleanup: 1. Removes `diagnostic-descriptions.md` since it isn't used any more 2. Adds the group name to all the old notes files 3. Removes trailing whitespace 4. Adds "See Also" sections for notes that have links
2.6 KiB
2.6 KiB
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:always-available-domain
- doc:trailing-closure-matching
- doc:compilation-caching
- doc:string-interpolation-conformance
- doc:deprecated-declaration
- doc:implementation-only-deprecated
- doc:embedded-restrictions
- doc:preconcurrency-import
- doc:clang-declaration-import
- doc:isolated-conformances
- doc:error-in-future-swift-version
- doc:module-version-missing
- doc:result-builder-methods
- doc:strict-language-features
- doc:strict-memory-safety
- doc:unknown-warning-group
Topics
- doc:dynamic-callable-requirements
- doc:always-available-domain
- doc:trailing-closure-matching
- doc:actor-isolated-call
- doc:sendable-closure-captures
- doc:compilation-caching
- doc:string-interpolation-conformance
- doc:deprecated-declaration
- doc:implementation-only-deprecated
- doc:embedded-restrictions
- doc:preconcurrency-import
- doc:clang-declaration-import
- doc:isolated-conformances
- doc:error-in-future-swift-version
- doc:missing-module-on-known-paths
- doc:module-version-missing
- doc:module-not-testable
- doc:multiple-inheritance
- doc:nominal-types
- doc:exclusivity-violation
- doc:performance-hints
- doc:property-wrapper-requirements
- doc:conformance-isolation
- doc:protocol-type-non-conformance
- doc:result-builder-methods
- 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:opaque-type-inference
- doc:unknown-warning-group
- doc:availability-unrecognized-name
- doc:mutable-global-variable
- doc:existential-member-access-limitations