zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

setup-env: allow users to skip module function setup (#24236)

Browse Source 
* setup-env: allow users to skip module function setup

* Add documentation on SPACK_SKIP_MODULES
This commit is contained in:
Adam J. Stewart 2021-06-11 14:19:24 -05:00 committed by GitHub
parent 4a8785d371
commit 11f370e7be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/spack/docs/getting_started.rst
View File

@ -70,7 +70,13 @@ Sourcing these files will put the ``spack`` command in your ``PATH``, set
up your ``MODULEPATH`` to use Spack's packages, and add other useful up your ``MODULEPATH`` to use Spack's packages, and add other useful
shell integration for :ref:`certain commands <packaging-shell-support>`, shell integration for :ref:`certain commands <packaging-shell-support>`,
:ref:`environments <environments>`, and :ref:`modules <modules>`. For :ref:`environments <environments>`, and :ref:`modules <modules>`. For
``bash``, it also sets up tab completion. ``bash`` and ``zsh``, it also sets up tab completion.
In order to know which directory to add to your ``MODULEPATH``, these scripts
query the ``spack`` command. On shared filesystems, this can be a bit slow,
especially if you log in frequently. If you don't use modules, or want to set
``MODULEPATH`` manually instead, you can set the ``SPACK_SKIP_MODULES``
environment variable to skip this step and speed up sourcing the file.
If you do not want to use Spack's shell support, you can always just run If you do not want to use Spack's shell support, you can always just run
the ``spack`` command directly from ``spack/bin/spack``. the ``spack`` command directly from ``spack/bin/spack``.
@ -1166,7 +1172,7 @@ the key that we just created:
60D2685DAB647AD4DB54125961E09BB6F2A0ADCB 60D2685DAB647AD4DB54125961E09BB6F2A0ADCB
uid [ultimate] dinosaur (GPG created for Spack) <dinosaur@thedinosaurthings.com> uid [ultimate] dinosaur (GPG created for Spack) <dinosaur@thedinosaurthings.com>
Note that the name "dinosaur" can be seen under the uid, which is the unique Note that the name "dinosaur" can be seen under the uid, which is the unique
id. We might need this reference if we want to export or otherwise reference the key. id. We might need this reference if we want to export or otherwise reference the key.
@ -1205,7 +1211,7 @@ If you want to include the private key, then just add `--secret`:
$ spack gpg export --secret dinosaur.priv dinosaur $ spack gpg export --secret dinosaur.priv dinosaur
This will write the private key to the file `dinosaur.priv`. This will write the private key to the file `dinosaur.priv`.
.. warning:: .. warning::

2
share/spack/setup-env.fish
View File

@ -703,7 +703,7 @@ set -xg _sp_shell "fish"
# Check whether we need environment-variables (module) <= `use` is not available # Check whether we need environment-variables (module) <= `use` is not available
# #
set -l need_module "no" set -l need_module "no"
if not functions -q use; and not functions -q module if test -z "$SPACK_SKIP_MODULES"; and not functions -q use; and not functions -q module
set need_module "yes" set need_module "yes"
end end

2
share/spack/setup-env.sh
View File

@ -307,7 +307,7 @@ _spack_fn_exists() {
} }
need_module="no" need_module="no"
if ! _spack_fn_exists use && ! _spack_fn_exists module; then if [ -z "${SPACK_SKIP_MODULES+x}" ] && ! _spack_fn_exists use && ! _spack_fn_exists module; then
need_module="yes" need_module="yes"
fi; fi;