aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md10
-rw-r--r--docs/markdown/snippets/native_compiler_not_required.md19
2 files changed, 24 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 3b07b5f..3e4cd44 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -75,12 +75,16 @@ specified is not found, Meson will halt. Since *0.47.0* the value of a
[`feature`](Build-options.md#features) option can also be passed.
- `native` if set to `true`, the language will be used to compile for the build
- machine, if `false`, for the host machine. If omitted, the language may be
- used for either. Since *0.54.0*. The default may change to `false` in a future
- meson version.
+ machine, if `false`, for the host machine. Since *0.54.0*.
Returns `true` if all languages specified were found and `false` otherwise.
+If `native` is omitted, the languages may be used for either build or host
+machine, but are never required for the build machine. (i.e. it is equivalent
+to `add_languages(*langs*, native: false, required: *required*) and
+add_languages(*langs*, native: true, required: false)`. This default behaviour
+may change to `native: false` in a future meson version.
+
### add_project_arguments()
``` meson
diff --git a/docs/markdown/snippets/native_compiler_not_required.md b/docs/markdown/snippets/native_compiler_not_required.md
index 0847b2b..331b3c7 100644
--- a/docs/markdown/snippets/native_compiler_not_required.md
+++ b/docs/markdown/snippets/native_compiler_not_required.md
@@ -1,5 +1,20 @@
## Native (build machine) compilers not always required
`add_languages()` gained a `native:` keyword, indicating if a native or cross
-compiler is to be used. Currently, for backwards compatibility, if the keyword
-is absent, that means both are used.
+compiler is to be used.
+
+For the benefit of existing simple build definitions which don't contain any
+`native: true` targets, without breaking backwards compatibility for build
+definitions which assume that the native compiler is available after
+`add_languages()`, if the `native:` keyword is absent the languages may be used
+for either the build or host machine, but are never required for the build
+machine.
+
+This changes the behaviour of the following meson fragment (when cross-compiling
+but a native compiler is not available) from reporting an error at
+`add_language` to reporting an error at `executable`.
+
+```
+add_language('c')
+executable('main', 'main.c', native: true)
+```