aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2019-12-31 09:36:54 +0100
committerdec05eba <dec05eba@protonmail.com>2020-07-06 07:39:58 +0200
commit7cc5348a8b7495b8b79ed1830223bd3acd3c8aee (patch)
tree705ee9f078712245c34e3a5232b58b637870085c /README.md
parentaf6ab529bead084b32057053b88606ca69f5db3f (diff)
Add error_on_warning option to allow turning compiler warnings to errors
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index d776c31..b6b562a 100644
--- a/README.md
+++ b/README.md
@@ -115,6 +115,7 @@ BOOST_COMPILE_DYNAMIC = "1"
include_dirs = ["include"]
ignore_dirs = ["examples"]
expose_include_dirs = ["include"]
+error_on_warning = "true"
[config.win32.static.debug]
lib = "windows/x86/static/debug"
@@ -192,6 +193,9 @@ Optional. A list of directories which should be specified as global include dire
Optional. A list of directories to ignore. This means that if the ignored directory contains source files, then they wont be included in the build
### expose_include_dirs
Optional. A list of directories which contains (header) files which should be exposed to dependencies as directories to include globally. This means that dependencies can include (header) files from the dependency without specifying path to the dependency
+### error_on_warning
+Optional. This option should be either "true" or "false" and specifies if compiler warnings for the project (and not its dependencies) should work warnings as errors.
+Default value is "false".
## config.*
Optional. The name is structured in the following way: config.platform.libraryType.optimizationLevel
where platform is any of the platforms specified under \[package] (or if package contains "any", then it can be any other platform). LibraryType is either "static" or "dynamic" - different configurations depending on if the package is included as a static or dynamic library by a dependant package. OptimizationLevel is either "debug" or "release", depending on which optimization level the "root" package was built with ("root" package is usually the project which is an executable)