Skip to content

Commit f13dc43

Browse files
author
Robert McLay
committed
issue #385: Change docs to say that reset/restore do "module --force purge" before loading
1 parent a518859 commit f13dc43

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/source/010_user.rst

+11-8
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,17 @@ A user may wish to go back to an initial set of modules::
4040

4141
$ module reset
4242

43-
This will purge all currently loaded modules then load the list of
44-
modules specified by LMOD_SYSTEM_DEFAULT_MODULES. There is a related
43+
This will unload all currently loaded modules, including the sticky
44+
ones, then load the list of modules specified by
45+
LMOD_SYSTEM_DEFAULT_MODULES. There is a related
4546
command::
4647

4748
$ module restore
4849

49-
This command will also purge all currently loaded modules and then
50-
load the system default unless the user has a default collection.
51-
See :ref:`user_collections-label` for more details.
50+
This command will also unload all currently loaded modules, including
51+
the sticky ones, and then load the system default unless the user has
52+
a default collection. See :ref:`user_collections-label` for more
53+
details.
5254

5355
If a module is not available then an error message is produced::
5456

@@ -386,9 +388,10 @@ and only the desired modules will be loaded. If Lmod is setup
386388
correctly (see :ref:`startup_w_stdenv-label`) then the default
387389
collection will be the user's initial set of modules.
388390

389-
If a user doesn't have a default collection, the Lmod purges all
390-
currently loaded modules and loads the list of module specified by
391-
LMOD_SYSTEM_DEFAULT_MODULES just like the ``module reset`` command.
391+
If a user doesn't have a default collection, the Lmod purges ALL
392+
currently loaded modules, including the sticky ones, and loads the
393+
list of module specified by LMOD_SYSTEM_DEFAULT_MODULES just like the
394+
``module reset`` command.
392395

393396
Users can have as many collections as they like. They can save to a
394397
named collection with::

0 commit comments

Comments
 (0)