summaryrefslogtreecommitdiff
path: root/docs/website
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-06-16 17:02:25 +0100
committerEmmanuele Bassi <ebassi@gmail.com>2022-02-12 11:09:52 +0000
commit8ec097772459d67d5a7e888f5096f3f04a422ba1 (patch)
tree97b6dcf29ef21e7e5133571f6f6a8600127c118a /docs/website
parente736f4d48ca93ff90f172190a33a87901a40e630 (diff)
downloadgobject-introspection-8ec097772459d67d5a7e888f5096f3f04a422ba1.tar.gz
scanner: Add strict mode
To avoid introducing additional strictness onto unsuspecting libraries, we introduce a new mode: "strict". The strict mode is opt-in, and used to signal potential issues with the public API once exposed by language bindings, even when it's fully introspectable.
Diffstat (limited to 'docs/website')
-rw-r--r--docs/website/tools/g-ir-scanner.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/website/tools/g-ir-scanner.rst b/docs/website/tools/g-ir-scanner.rst
index e8df7457..47bbc2ff 100644
--- a/docs/website/tools/g-ir-scanner.rst
+++ b/docs/website/tools/g-ir-scanner.rst
@@ -42,6 +42,10 @@ OPTIONS
--warn-error
Make warnings be fatal errors.
+--strict
+ Display warnings for introspectable API that may present issues when
+ consumed by known language bindings.
+
--format=FORMAT
This parameters decides which the resulting format will be used. The
default value is gir.