summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorMartin Duffy <martin.duffy@kitware.com>2022-04-21 19:29:05 (GMT)
committerBrad King <brad.king@kitware.com>2022-05-06 16:14:37 (GMT)
commit76a08cd25332b74627802df8817068219b89161d (patch)
treea349756534c11634ac1fc919793801c78fbec612 /Help/variable
parentde802fc5a35780581948f7638f0f22c3974922dd (diff)
downloadCMake-76a08cd25332b74627802df8817068219b89161d.zip
CMake-76a08cd25332b74627802df8817068219b89161d.tar.gz
CMake-76a08cd25332b74627802df8817068219b89161d.tar.bz2
COMPILE_WARNING_AS_ERROR: Add options to treat warnings as errors
Add `COMPILE_WARNING_AS_ERROR` target property and supporting `CMAKE_COMPILE_WARNING_AS_ERROR` variable. `COMPILE_WARNING_AS_ERROR` is initialized by `CMAKE_COMPILE_WARNING_AS_ERROR`. It is a boolean variable. If it is true, it expands to a different flag depending on the compiler such that any warnings at compile will be treated as errors. Supports compiler ids that I could find a relevant flag for.
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_COMPILE_WARNING_AS_ERROR.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_COMPILE_WARNING_AS_ERROR.rst b/Help/variable/CMAKE_COMPILE_WARNING_AS_ERROR.rst
new file mode 100644
index 0000000..56dc6a6
--- /dev/null
+++ b/Help/variable/CMAKE_COMPILE_WARNING_AS_ERROR.rst
@@ -0,0 +1,9 @@
+CMAKE_COMPILE_WARNING_AS_ERROR
+------------------------------
+
+.. versionadded:: 3.24
+
+Specify whether to treat warnings on compile as errors.
+
+This variable is used to initialize the
+:prop_tgt:`COMPILE_WARNING_AS_ERROR` property on all the targets.