Skip to content
Snippets Groups Projects
Unverified Commit d6d095a8 authored by TZ's avatar TZ Committed by GitHub
Browse files

Docs: "spack env" is in the meantime called "spack build-env" (#15233)

parent b37d7b8e
No related branches found
No related tags found
No related merge requests found
...@@ -2913,7 +2913,7 @@ discover its dependencies. ...@@ -2913,7 +2913,7 @@ discover its dependencies.
If you want to see the environment that a package will build with, or If you want to see the environment that a package will build with, or
if you want to run commands in that environment to test them out, you if you want to run commands in that environment to test them out, you
can use the :ref:`cmd-spack-env` command, documented can use the :ref:`cmd-spack-build-env` command, documented
below. below.
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
...@@ -4332,31 +4332,31 @@ directory, install directory, package directory) and others change to ...@@ -4332,31 +4332,31 @@ directory, install directory, package directory) and others change to
core spack locations. For example, ``spack cd --module-dir`` will take you to core spack locations. For example, ``spack cd --module-dir`` will take you to
the main python source directory of your spack install. the main python source directory of your spack install.
.. _cmd-spack-env: .. _cmd-spack-build-env:
^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
``spack env`` ``spack build-env``
^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
``spack env`` functions much like the standard unix ``env`` command, ``spack build-env`` functions much like the standard unix ``build-env``
but it takes a spec as an argument. You can use it to see the command, but it takes a spec as an argument. You can use it to see the
environment variables that will be set when a particular build runs, environment variables that will be set when a particular build runs,
for example: for example:
.. code-block:: console .. code-block:: console
$ spack env mpileaks@1.1%intel $ spack build-env mpileaks@1.1%intel
This will display the entire environment that will be set when the This will display the entire environment that will be set when the
``mpileaks@1.1%intel`` build runs. ``mpileaks@1.1%intel`` build runs.
To run commands in a package's build environment, you can simply To run commands in a package's build environment, you can simply
provide them after the spec argument to ``spack env``: provide them after the spec argument to ``spack build-env``:
.. code-block:: console .. code-block:: console
$ spack cd mpileaks@1.1%intel $ spack cd mpileaks@1.1%intel
$ spack env mpileaks@1.1%intel ./configure $ spack build-env mpileaks@1.1%intel ./configure
This will cd to the build directory and then run ``configure`` in the This will cd to the build directory and then run ``configure`` in the
package's build environment. package's build environment.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment