diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Gnome-module.md | 1 | ||||
| -rw-r--r-- | docs/markdown/snippets/gir_fatal_warnings.md | 5 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index 0d1f269..ced8a40 100644 --- a/docs/markdown/Gnome-module.md +++ b/docs/markdown/Gnome-module.md @@ -97,6 +97,7 @@ There are several keyword arguments. Many of these map directly to the * `link_with`: list of libraries to link with * `symbol_prefix`: the symbol prefix for the gir object, e.g. `gtk`, (*Since 0.43.0*) an ordered list of multiple prefixes is allowed +* `fatal_warnings`: *Since 0.55.0* turn scanner warnings into fatal errors. Returns an array of two elements which are: `[gir_target, typelib_target]` diff --git a/docs/markdown/snippets/gir_fatal_warnings.md b/docs/markdown/snippets/gir_fatal_warnings.md new file mode 100644 index 0000000..951e98e --- /dev/null +++ b/docs/markdown/snippets/gir_fatal_warnings.md @@ -0,0 +1,5 @@ +## Fatal warnings in `gnome.generate_gir()` + +`gnome.generate_gir()` now has `fatal_warnings` keyword argument to abort when +a warning is produced. This is useful for example in CI environment where it's +important to catch potential issues. |