Merge branch 'backport-3.24-doc-warning-as-error' into doc-warning-as-error

This commit is contained in:
Brad King
2022-08-15 11:06:59 -04:00

View File

@@ -6,5 +6,28 @@ COMPILE_WARNING_AS_ERROR
Specify whether to treat warnings on compile as errors.
If enabled, adds a flag to treat warnings on compile as errors.
This property is not implemented for all compilers. It is silently ignored
if there is no implementation for the compiler being used. The currently
implemented :variable:`compiler IDs <CMAKE_<LANG>_COMPILER_ID>` are:
* ``GNU``
* ``Clang``
* ``AppleClang``
* ``Fujitsu``
* ``FujitsuClang``
* ``IBMClang``
* ``Intel``
* ``IntelLLVM``
* ``LCC``
* ``MSVC``
* ``NVHPC``
* ``NVIDIA`` (CUDA)
* ``QCC``
* ``SunPro``
* ``TI``
* ``VisualAge``
* ``XL``
* ``XLClang``
This property is initialized by the value of the variable
:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is created.