summaryrefslogtreecommitdiff
path: root/doc/concepts
diff options
context:
space:
mode:
authorOliver Reiche <oliver.reiche@huawei.com>2022-09-26 10:52:39 +0200
committerOliver Reiche <oliver.reiche@huawei.com>2022-10-05 15:13:54 +0200
commit82f7268b2f7098442911a4b68d480a4791bd9e8f (patch)
tree3bfc2e65b79f204d1b677e8b92d8077294670842 /doc/concepts
parent5a4afcee7961bba616ac7e77e8e5ee13ed49c3f9 (diff)
downloadjustbuild-82f7268b2f7098442911a4b68d480a4791bd9e8f.tar.gz
Doc: Describe usage of 'env' expression
Diffstat (limited to 'doc/concepts')
-rw-r--r--doc/concepts/expressions.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/concepts/expressions.org b/doc/concepts/expressions.org
index 2dff612a..d5d3340c 100644
--- a/doc/concepts/expressions.org
+++ b/doc/concepts/expressions.org
@@ -83,6 +83,16 @@ Finally, the ~"body"~ is evaluated in the final environemnt (after
evaluating all binding entries) and the result of evaluating the
~"body"~ is the value for the whole ~"let*"~ expression.
+***** Environment Map: ~"env"~
+
+Creates a map from selected environment variables.
+
+The key ~"vars"~ (default ~[]~) has to be a list of literal strings referring to
+the variable names that should be included in the produced map. This field is
+not evaluated. This expression is only for convenience and does not give new
+expression power. It is equivalent but lot shorter to multiple ~singleton_map~
+expressions combined with ~map_union~.
+
***** Conditionals
****** Binary conditional: ~"if"~