summaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorMark Bolhuis <mark@bolhuis.dev>2022-09-05 22:14:40 +0100
committerXavier Claessens <xclaesse@gmail.com>2022-09-06 18:08:39 -0400
commit25f838fd3328273733976b16775142a58e3db275 (patch)
tree594f0cfc7fa465b4307c15e702aacff603e3b49e /docs/markdown
parenta4d54422077a6fb7fe7af072e0563b58e602d4ae (diff)
downloadmeson-25f838fd3328273733976b16775142a58e3db275.tar.gz
modules/wayland: Support --include-core-only
wayland-scanner can generate header files that only include wayland-client-core.h using a flag. Add a core_only option to scan_xml to support this use case.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Wayland-module.md3
-rw-r--r--docs/markdown/snippets/wayland_scan_xml_core_only_arg.md5
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/markdown/Wayland-module.md b/docs/markdown/Wayland-module.md
index 345c4e347..353bb6b7d 100644
--- a/docs/markdown/Wayland-module.md
+++ b/docs/markdown/Wayland-module.md
@@ -50,6 +50,7 @@ generated = wl_mod.scan_xml(
client : true,
server : true,
public : false,
+ core_only : false,
)
```
This function accepts one or more arguments of either string or file type.
@@ -61,6 +62,8 @@ It takes the following keyword arguments:
generated. The default is true.
- `server` Optional arg that specifies if server side header file is
generated. The default is false.
+- `core_only` Optional arg that specifies that generated headers only include
+ wayland-client-core.h instead of wayland-client.h. Since *0.64.0*
**Returns**: a list of [[@custom_tgt]] in the order source, client side header,
server side header. Generated header files have the name
diff --git a/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md b/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md
new file mode 100644
index 000000000..59f4e1b27
--- /dev/null
+++ b/docs/markdown/snippets/wayland_scan_xml_core_only_arg.md
@@ -0,0 +1,5 @@
+## Added core_only arg to wayland.scan_xml.
+
+The `scan_xml` function from the wayland module now has an optional bool
+argument `core_only`, so that headers generated by wayland-scanner now
+only include `wayland-client-core.h` instead of `wayland-client.h`.