Skip to content

Commit 1fc2f17

Browse files
juan-lunargcharles-lunarg
authored andcommitted
Document BUILD_WERROR
1 parent 9c1e2c9 commit 1fc2f17

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

BUILD.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,16 @@ cmake ... -D UPDATE_DEPS=ON -D BUILD_TESTS=ON ...
127127
```
128128
This will ensure googletest and detours is downloaded and the appropriate version is used.
129129

130+
### Warnings as errors off by default!
131+
132+
By default `BUILD_WERROR` is `OFF`. The idiom for open source projects is to NOT enable warnings as errors.
133+
134+
System/language package managers have to build on multiple different platforms and compilers.
135+
136+
By defaulting to `ON` we cause issues for package managers since there is no standard way to disable warnings.
137+
138+
Add `-D BUILD_WERROR=ON` to your workflow
139+
130140
### Build and Install Directory Locations
131141

132142
A common convention is to place the `build` directory in the top directory of

0 commit comments

Comments
 (0)