summaryrefslogtreecommitdiff
path: root/docs/yaml/functions/subdir_done.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/yaml/functions/subdir_done.yaml')
-rw-r--r--docs/yaml/functions/subdir_done.yaml23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/yaml/functions/subdir_done.yaml b/docs/yaml/functions/subdir_done.yaml
new file mode 100644
index 000000000..ef878cc8c
--- /dev/null
+++ b/docs/yaml/functions/subdir_done.yaml
@@ -0,0 +1,23 @@
+name: subdir_done
+returns: void
+description: |
+ Stops further interpretation of the Meson script file from the point
+ of the invocation. All steps executed up to this point are valid and
+ will be executed by Meson. This means that all targets defined before
+ the call of [[subdir_done]] will be build.
+
+ If the current script was called by `subdir` the execution returns to
+ the calling directory and continues as if the script had reached the
+ end. If the current script is the top level script Meson configures
+ the project as defined up to this point.
+
+example: |
+ ```meson
+ project('example exit', 'cpp')
+ executable('exe1', 'exe1.cpp')
+ subdir_done()
+ executable('exe2', 'exe2.cpp')
+ ```
+
+ The executable `exe1` will be build, while the executable `exe2` is not
+ build.