summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAxel Huebl <axel.huebl@plasma.ninja>2023-01-17 01:06:00 -0800
committerGitHub <noreply@github.com>2023-01-17 10:06:00 +0100
commit39ffef83631463e4e0c546d57a8602199ef13aa2 (patch)
tree2fdb661ac57a8b810a402ce71e0036e240239ecd
parentf0672bbaf8446b24e3487c61c67522a3848dfd0a (diff)
downloadspack-39ffef83631463e4e0c546d57a8602199ef13aa2.tar.gz
spack-39ffef83631463e4e0c546d57a8602199ef13aa2.tar.bz2
spack-39ffef83631463e4e0c546d57a8602199ef13aa2.tar.xz
spack-39ffef83631463e4e0c546d57a8602199ef13aa2.zip
Doc: config.yaml mention $env (#34905)
Add one more note on the $env variable in `config.yaml`.
-rw-r--r--etc/spack/defaults/config.yaml5
1 files changed, 5 insertions, 0 deletions
diff --git a/etc/spack/defaults/config.yaml b/etc/spack/defaults/config.yaml
index f42a6525e2..535187a739 100644
--- a/etc/spack/defaults/config.yaml
+++ b/etc/spack/defaults/config.yaml
@@ -54,6 +54,11 @@ config:
# are that it precludes its use as a system package and its ability to be
# pip installable.
#
+ # In Spack environment files, chaining onto existing system Spack
+ # installations, the $env variable can be used to download, cache and build
+ # into user-writable paths that are relative to the currently active
+ # environment.
+ #
# In any case, if the username is not already in the path, Spack will append
# the value of `$user` in an attempt to avoid potential conflicts between
# users in shared temporary spaces.