summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCharles Brunet <charles.brunet@optelgroup.com>2023-10-10 12:09:15 -0400
committerJussi Pakkanen <jpakkane@gmail.com>2024-02-23 21:11:56 +0200
commit138e0fe9841b44a6d0402b66bbd0c10966cfe87b (patch)
tree6ef0d07b225a96880daed110ed94ff951d43c4c5 /docs
parentdb8246b3fc52994eac2cccd1416e64e36c3369e2 (diff)
downloadmeson-138e0fe9841b44a6d0402b66bbd0c10966cfe87b.tar.gz
env.unset method
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/environment_unset.md4
-rw-r--r--docs/yaml/objects/env.yaml7
2 files changed, 11 insertions, 0 deletions
diff --git a/docs/markdown/snippets/environment_unset.md b/docs/markdown/snippets/environment_unset.md
new file mode 100644
index 000000000..887bc0d47
--- /dev/null
+++ b/docs/markdown/snippets/environment_unset.md
@@ -0,0 +1,4 @@
+## New `unset()` method on `environment` objects
+
+[[@env]] now has an [[env.unset]] method to ensure an existing environment
+is *not* defined.
diff --git a/docs/yaml/objects/env.yaml b/docs/yaml/objects/env.yaml
index d784c68b8..714da4fe4 100644
--- a/docs/yaml/objects/env.yaml
+++ b/docs/yaml/objects/env.yaml
@@ -82,3 +82,10 @@ methods:
description: The values to set
kwargs_inherit: env.append
+
+- name: unset
+ returns: void
+ since: 1.4.0
+ description: |
+ Unset the specified environment variable. If this variable does not exist,
+ nothing happens.