diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/compile_werror.md | 5 | ||||
| -rw-r--r-- | docs/yaml/objects/compiler.yaml | 11 |
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/markdown/snippets/compile_werror.md b/docs/markdown/snippets/compile_werror.md new file mode 100644 index 000000000..e81abb855 --- /dev/null +++ b/docs/markdown/snippets/compile_werror.md @@ -0,0 +1,5 @@ +## Treat warnings as error in compiler checks + +Compiler check methods `compiler.compiles()`, `compiler.links()` and `compiler.run()` +now have a new `werror: true` keyword argument to treat compiler warnings as error. +This can be used to check if code compiles without warnings. diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml index 3ba9c44db..d5d7df569 100644 --- a/docs/yaml/objects/compiler.yaml +++ b/docs/yaml/objects/compiler.yaml @@ -127,6 +127,7 @@ methods: - compiler._dependencies - compiler._no_builtin_args - compiler._name + - compiler._werror - name: _header returns: void @@ -157,6 +158,16 @@ methods: When set to a [`feature`](Build-options.md#features) option, the feature will control if it is searched and whether to fail if not found. +- name: _werror + returns: void + description: You have found a bug if you can see this! + kwargs: + werror: + type: bool + default: false + description: When set to `true`, compiler warnings are treated as error. + since: 1.3.0 + # Star of the actual functions - name: version returns: str |