Back to Swift

Diagnostic groups

userdocs/diagnostics/diagnostic-groups.md

latest3.1 KB
Original Source

Diagnostic groups

<!-- This file is auto-generated via `swift swift/utils/generate-doc-index.swift` -->

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:

sh
-Werror DeprecatedDeclaration

Or upgrade all warnings except deprecated declaration to errors:

sh
-warnings-as-errors -Wwarning DeprecatedDeclaration

Groups with warnings

Topics