Browse Source

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 <[email protected]>
Merge-request: !7561
Craig Scott 3 years ago
parent
commit
e6038c0199
1 changed files with 25 additions and 0 deletions
  1. 25 0
      Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst

+ 25 - 0
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.