Update compilation-options.md for #831

Adds `ENABLE_WARNINGS` to the build docs
uber · Apr 28, 2024 · 6c59dc4 · 6c59dc4
1 parent c6c6850
commit 6c59dc4
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/website/docs/core-library/compilation-options.md b/website/docs/core-library/compilation-options.md
@@ -101,10 +101,15 @@ Used for [renaming the public API](./usage#function-renaming).
 
 If enabled, CMake will print which CTest test case corresponds to which input file.
 
+## ENABLE_WARNINGS
+
+Whether to enable all compiler warnings. (i.e. [`-Wall`](https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#index-Wall))
+
 ## WARNINGS_AS_ERRORS
 
 Whether to treat compiler warnings as errors. While a useful tool for ensuring software quality, this should not be enabled
-for production builds as compiler warnings can change unexpectedly between versions.
+for production builds as compiler warnings can change unexpectedly between versions. This is intended to be used with
+`ENABLE_WARNINGS` on.
 
 ## WRAP_VALGRIND