summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
diff options
context:
space:
mode:
authorMartin Duffy <martin.duffy@kitware.com>2022-04-21 15:29:05 -0400
committerBrad King <brad.king@kitware.com>2022-05-06 12:14:37 -0400
commit76a08cd25332b74627802df8817068219b89161d (patch)
treea349756534c11634ac1fc919793801c78fbec612 /Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
parentde802fc5a35780581948f7638f0f22c3974922dd (diff)
downloadcmake-76a08cd25332b74627802df8817068219b89161d.tar.gz
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/prop_tgt/COMPILE_WARNING_AS_ERROR.rst')
-rw-r--r--Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
new file mode 100644
index 0000000000..86a0f7f66c
--- /dev/null
+++ b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
@@ -0,0 +1,10 @@
+COMPILE_WARNING_AS_ERROR
+------------------------
+
+.. versionadded:: 3.24
+
+Specify whether to treat warnings on compile as errors.
+If enabled, adds a flag to treat warnings on compile as errors.
+
+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.