aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/compiler_prefix_property_array.md18
-rw-r--r--docs/yaml/objects/compiler.yaml12
2 files changed, 25 insertions, 5 deletions
diff --git a/docs/markdown/snippets/compiler_prefix_property_array.md b/docs/markdown/snippets/compiler_prefix_property_array.md
new file mode 100644
index 0000000..75b7156
--- /dev/null
+++ b/docs/markdown/snippets/compiler_prefix_property_array.md
@@ -0,0 +1,18 @@
+## Compiler check functions `prefix` kwargs accepts arrays
+
+The `prefix` kwarg that most compiler check functions support
+now accepts an array in addition to a string. The elements of the
+array will be concatenated separated by a newline.
+
+This makes it more readable to write checks that need multiple headers
+to be included:
+
+```meson
+cc.check_header('GL/wglew.h', prefix : ['#include <windows.h>', '#include <GL/glew.h>'])
+```
+
+instead of
+
+```meson
+cc.check_header('GL/wglew.h', prefix : '#include <windows.h>\n#include <GL/glew.h>'])
+```
diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml
index e10e8fe..01283cd 100644
--- a/docs/yaml/objects/compiler.yaml
+++ b/docs/yaml/objects/compiler.yaml
@@ -78,13 +78,15 @@ methods:
description: You have found a bug if you can see this!
kwargs:
prefix:
- type: str
+ type: str | list[str]
description: |
Used to add `#include`s and other things that are required
- for the symbol to be declared. System definitions should be
- passed via compiler args (eg: `_GNU_SOURCE` is often required for
- some symbols to be exposed on Linux, and it should be passed via
- `args` keyword argument).
+ for the symbol to be declared. Since 1.0.0 an array is accepted
+ too. When an array is passed, the items are concatenated together
+ separated by a newline.
+ System definitions should be passed via compiler args
+ (eg: `_GNU_SOURCE` is often required for some symbols to be exposed
+ on Linux, and it should be passed via `args` keyword argument).
- name: _no_builtin_args
returns: void