summaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorTristan Partin <tristan@partin.io>2024-04-24 19:51:35 -0500
committerDylan Baker <dylan@pnwbakers.com>2024-05-01 11:20:27 -0700
commita0ff14551266c87919f5b4b1469b7be0ef0a052e (patch)
tree0313a2d220f02957d48bd83f3094de43b1413485 /docs/markdown
parentf1f24816a912bacbb32931bfbd034be36138e3e4 (diff)
downloadmeson-a0ff14551266c87919f5b4b1469b7be0ef0a052e.tar.gz
Add required kwarg to compiler.{compiles,links,run}
This is a similar commit to the one that added required to all the compiler.has* functions.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/snippets/requires_kwarg_on_more_compiler_methods.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/markdown/snippets/requires_kwarg_on_more_compiler_methods.md b/docs/markdown/snippets/requires_kwarg_on_more_compiler_methods.md
new file mode 100644
index 000000000..693313c31
--- /dev/null
+++ b/docs/markdown/snippets/requires_kwarg_on_more_compiler_methods.md
@@ -0,0 +1,21 @@
+## Required kwarg on more `compiler` methods
+
+The following `compiler` methods now support the `required` keyword argument:
+
+- `compiler.compiles()`
+- `compiler.links()`
+- `compiler.runs()`
+
+```meson
+cc.compiles(valid, name: 'valid', required : true)
+cc.links(valid, name: 'valid', required : true)
+cc.run(valid, name: 'valid', required : true)
+
+assert(not cc.compiles(valid, name: 'valid', required : opt))
+assert(not cc.links(valid, name: 'valid', required : opt))
+res = cc.run(valid, name: 'valid', required : opt)
+assert(res.compiled())
+assert(res.returncode() == 0)
+assert(res.stdout() == '')
+assert(res.stderr() == '')
+```