"module describe" does not respect "module use" additions

[VictorEijkhout]

Lmod Warning:  One or more modules in your foobar collection have changed: "xyz".
To see the contents of this collection execute:
  $ module describe foobar
To rebuild the collection, do a module reset, then load the modules you wish, then execute:

This does not take into account that this particular set of module uses a couple of

module use /some/extra/path

statements.

Can the describe statement be extended to track module use statements and list these?

[mrcawood]

@VictorEijkhout Thanks for raising this. The fix is implemented. module describe now shows the module use paths stored in a collection so you can see what to run before loading modules. Example of the new behavior:

After:

module use /some/extra/path
module load foo/2.0
module save foobar

module describe foobar produces:

Collection "foobar" contains:

  Module paths (run these first):
   module use /some/extra/path

  Modules:
   1) foo/2.0

Users can copy the module use commands and run them first when restoring the environment from the description.

The change is covered by the existing saverestore test (step 13) and a new describe_use regression test. If this looks right and you have no concerns, we’ll merge it with the next feature batch. If anything should be different, please say so.

[VictorEijkhout]

Cool.

For completeness, what does the "terse" output look like?

[mrcawood]

In terse mode, one command or module per line, no headers:

$ module -t describe foobar
module use ProjectDIR/rt/describe_use/mf/Extra
foo/2.0

Paths appear first, then modules, so it’s easy to script or copy-paste.