summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorGreg Becker <becker33@llnl.gov>2021-03-21 05:14:13 -0500
committerGitHub <noreply@github.com>2021-03-21 10:14:13 +0000
commitf4b56620e56d5f527d3ff85d799f8c55583ee4c2 (patch)
treee241e238f62212e48ff33a14a0e7eb49ed5e59e2 /lib
parentdf8dcef9632552dfde43d7426d2d4b23e64085bf (diff)
downloadspack-f4b56620e56d5f527d3ff85d799f8c55583ee4c2.tar.gz
spack-f4b56620e56d5f527d3ff85d799f8c55583ee4c2.tar.bz2
spack-f4b56620e56d5f527d3ff85d799f8c55583ee4c2.tar.xz
spack-f4b56620e56d5f527d3ff85d799f8c55583ee4c2.zip
Document cli syntax for environment scopes (#20344)
Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/configuration.rst16
-rw-r--r--lib/spack/docs/environments.rst6
2 files changed, 18 insertions, 4 deletions
diff --git a/lib/spack/docs/configuration.rst b/lib/spack/docs/configuration.rst
index 0671beb080..10b442ab74 100644
--- a/lib/spack/docs/configuration.rst
+++ b/lib/spack/docs/configuration.rst
@@ -78,6 +78,13 @@ are six configuration scopes. From lowest to highest:
If multiple scopes are listed on the command line, they are ordered
from lowest to highest precedence.
+#. **environment**: When using Spack :ref:`environments`, Spack reads
+ additional configuration from the environment file. See
+ :ref:`environment-configuration` for further details on these
+ scopes. Environment scopes can be referenced from the command line
+ as ``env:name`` (to reference environment ``foo``, use
+ ``env:foo``).
+
#. **command line**: Build settings specified on the command line take
precedence over all other scopes.
@@ -192,10 +199,11 @@ with MPICH. You can create different configuration scopes for use with
Platform-specific Scopes
------------------------
-For each scope above, there can also be platform-specific settings.
-For example, on most platforms, GCC is the preferred compiler.
-However, on macOS (darwin), Clang often works for more packages,
-and is set as the default compiler. This configuration is set in
+For each scope above (excluding environment scopes), there can also be
+platform-specific settings. For example, on most platforms, GCC is
+the preferred compiler. However, on macOS (darwin), Clang often works
+for more packages, and is set as the default compiler. This
+configuration is set in
``$(prefix)/etc/spack/defaults/darwin/packages.yaml``. It will take
precedence over settings in the ``defaults`` scope, but can still be
overridden by settings in ``system``, ``system/darwin``, ``site``,
diff --git a/lib/spack/docs/environments.rst b/lib/spack/docs/environments.rst
index 064cfad336..1a52ac8328 100644
--- a/lib/spack/docs/environments.rst
+++ b/lib/spack/docs/environments.rst
@@ -399,6 +399,12 @@ There are two ways to include configuration information in a Spack Environment:
#. Included in the ``spack.yaml`` file from another file.
+Many Spack commands also affect configuration information in files
+automatically. Those commands take a ``--scope`` argument, and the
+environment can be specified by ``env:NAME`` (to affect environment
+``foo``, set ``--scope env:foo``). These commands will automatically
+manipulate configuration inline in the ``spack.yaml`` file.
+
"""""""""""""""""""""
Inline configurations
"""""""""""""""""""""