summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-08-16 10:57:18 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-08-16 10:57:31 (GMT)
commite6038c019942a07fd07443712ab4c79d79cddcf3 (patch)
tree1f8b4f998057e7aeaf76f1282b5563f720647e93
parent732cad4952e404e86758e0ecba197135c3ae777b (diff)
parent680fe820c60f84cc0b11dd3b0cbaefc111040f03 (diff)
downloadCMake-e6038c019942a07fd07443712ab4c79d79cddcf3.zip
CMake-e6038c019942a07fd07443712ab4c79d79cddcf3.tar.gz
CMake-e6038c019942a07fd07443712ab4c79d79cddcf3.tar.bz2
Merge topic 'doc-warning-as-error' into release-3.24
680fe820c6 Help: A missing cross-reference to --compile-no-warning-as-error 7ad89f8fb1 Help: List compiler IDs supported by COMPILE_WARNING_AS_ERROR Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7561
-rw-r--r--Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
index 86a0f7f..19323cb 100644
--- a/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
+++ b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
@@ -5,6 +5,31 @@ 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.
+If the ``--compile-no-warning-as-error`` option is given on the
+:manual:`cmake(1)` command line, this property is ignored.
+
+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.