aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/External-commands.md9
-rw-r--r--docs/markdown/Reference-manual.md18
-rw-r--r--docs/markdown/Release-notes-for-0.52.0.md11
-rw-r--r--docs/markdown/Videos.md3
-rw-r--r--docs/markdown/Wrap-dependency-system-manual.md8
-rw-r--r--docs/markdown/snippets/blocks.md3
-rw-r--r--docs/markdown/snippets/check-disabler.md5
-rw-r--r--docs/markdown/snippets/depth.md7
-rw-r--r--docs/markdown/snippets/env_dict.md8
9 files changed, 57 insertions, 15 deletions
diff --git a/docs/markdown/External-commands.md b/docs/markdown/External-commands.md
index 4c8c8e4..cafd280 100644
--- a/docs/markdown/External-commands.md
+++ b/docs/markdown/External-commands.md
@@ -16,7 +16,14 @@ output = r.stdout().strip()
errortxt = r.stderr().strip()
```
-Additionally, since 0.50.0, you can pass the command [`environment`](Reference-manual.html#environment-object) object:
+Since 0.52.0, you can pass the command environment as a dictionary:
+
+```meson
+run_command('command', 'arg1', 'arg2', env: {'FOO': 'bar'})
+```
+
+Since 0.50.0, you can also pass the command
+[`environment`](Reference-manual.html#environment-object) object:
```meson
env = environment()
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index f296e43..6009d30 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -104,7 +104,10 @@ Add a custom test setup that can be used to run the tests with a
custom setup, for example under Valgrind. The keyword arguments are
the following:
-- `env` an [environment object](#environment-object) to use a custom environment
+- `env` environment variables to set, such as `['NAME1=value1',
+ 'NAME2=value2']`, or an [`environment()`
+ object](#environment-object) which allows more sophisticated
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
- `exe_wrapper` a list containing the wrapper command or script followed by the arguments to it
- `gdb` if `true`, the tests are also run under `gdb`
- `timeout_multiplier` a number to multiply the test timeout with
@@ -491,12 +494,16 @@ Print the argument string and halts the build process.
### environment()
``` meson
- environment_object environment()
+ environment_object environment(...)
```
Returns an empty [environment variable
object](#environment-object). Added in 0.35.0.
+Since *0.52.0* takes an optional dictionary as first argument. If
+provided, each key/value pair is added into the `environment_object`
+as if `set()` method was called for each of them.
+
### executable()
``` meson
@@ -1256,7 +1263,10 @@ This function supports the following keyword arguments:
be checked, and the configuration will fail if it is non-zero. The default is
`false`.
Since 0.47.0
- - `env` an [environment object](#environment-object) to use a custom environment
+ - `env` environment variables to set, such as `['NAME1=value1',
+ 'NAME2=value2']`, or an [`environment()`
+ object](#environment-object) which allows more sophisticated
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
Since 0.50.0
See also [External commands](External-commands.md).
@@ -1489,7 +1499,7 @@ Keyword arguments are the following:
- `env` environment variables to set, such as `['NAME1=value1',
'NAME2=value2']`, or an [`environment()`
object](#environment-object) which allows more sophisticated
- environment juggling
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
- `is_parallel` when false, specifies that no other test must be
running at the same time as this test
diff --git a/docs/markdown/Release-notes-for-0.52.0.md b/docs/markdown/Release-notes-for-0.52.0.md
index de317df..f5bbcc3 100644
--- a/docs/markdown/Release-notes-for-0.52.0.md
+++ b/docs/markdown/Release-notes-for-0.52.0.md
@@ -3,13 +3,4 @@ title: Release 0.52.0
short-description: Release notes for 0.52.0
...
-# New features
-
-## Allow checking if a variable is a disabler
-
-Added the function `is_disabler(var)`. Returns true if a variable is a disabler
-and false otherwise.
-
-## Add blocks dependency
-
-Add `dependency('blocks')` to use the Clang blocks extension.
+# Notable changes in this version
diff --git a/docs/markdown/Videos.md b/docs/markdown/Videos.md
index 65fccfe..f2e37a7 100644
--- a/docs/markdown/Videos.md
+++ b/docs/markdown/Videos.md
@@ -4,6 +4,9 @@ short-description: Videos about Meson
# Videos
+ - [Behind the Scenes of a C++ Build
+ System](https://www.youtube.com/watch?v=34KzT2yvQuM) CppCon 2019
+
- [Compiling Multi-Million Line C++ Code Bases Effortlessly with the
Meson Build system](https://www.youtube.com/watch?v=SCZLnopmYBM),
CppCon 2018
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md
index 619492a..22ba589 100644
--- a/docs/markdown/Wrap-dependency-system-manual.md
+++ b/docs/markdown/Wrap-dependency-system-manual.md
@@ -143,6 +143,14 @@ automatically by adding the following *(since 0.48.0)*:
clone-recursive = true
```
+Setting the clone depth is supported using the `depth` directive *(since 0.52.0)*.
+Note that git always allow shallowly cloning branches, but in order to clone commit ids
+shallowly, the server must support `uploadpack.allowReachableSHA1InWant=true`.
+
+```ini
+depth = 1
+```
+
## Using wrapped projects
Wraps provide a convenient way of obtaining a project into your subproject directory.
diff --git a/docs/markdown/snippets/blocks.md b/docs/markdown/snippets/blocks.md
new file mode 100644
index 0000000..917ee54
--- /dev/null
+++ b/docs/markdown/snippets/blocks.md
@@ -0,0 +1,3 @@
+## Add blocks dependency
+
+Add `dependency('blocks')` to use the Clang blocks extension.
diff --git a/docs/markdown/snippets/check-disabler.md b/docs/markdown/snippets/check-disabler.md
new file mode 100644
index 0000000..9670792
--- /dev/null
+++ b/docs/markdown/snippets/check-disabler.md
@@ -0,0 +1,5 @@
+## Allow checking if a variable is a disabler
+
+Added the function `is_disabler(var)`. Returns true if a variable is a disabler
+and false otherwise.
+
diff --git a/docs/markdown/snippets/depth.md b/docs/markdown/snippets/depth.md
new file mode 100644
index 0000000..bdb032c
--- /dev/null
+++ b/docs/markdown/snippets/depth.md
@@ -0,0 +1,7 @@
+## Add `depth` option to `wrap-git`
+
+To allow shallow cloning, an option `depth` has been added to `wrap-git`.
+This applies recursively to submodules when `clone-recursive` is set to `true`.
+
+Note that the git server may have to be configured to support shallow cloning
+not only for branches but also for tags.
diff --git a/docs/markdown/snippets/env_dict.md b/docs/markdown/snippets/env_dict.md
new file mode 100644
index 0000000..5949806
--- /dev/null
+++ b/docs/markdown/snippets/env_dict.md
@@ -0,0 +1,8 @@
+## Support taking environment values from a dictionary
+
+`environment()` now accepts a dictionary as first argument. If
+provided, each key/value pair is added into the `environment_object`
+as if `set()` method was called for each of them.
+
+On the various functions that take an `env:` keyword argument, you may
+now give a dictionary.