Refactor code to call from the module command line modulefile-specific
commands. These commands can only be called from the command line, not
when calling 'module' procedure from a modulefile, to avoid any
ambiguity.
When parsing command line arguments, check context to know if '-d' means
'--default' (avail command) or '--delim' (*-path commands).
Add the new commands to the existing shell completion scripts (bash,
tcsh, fish, zsh).
Document new commands in the module.1 man page.
Acknowledgment: this development has been made and funded within the
framework of the PRACE Fifth Implementation Phase (PRACE-5IP) project
(http://www.prace-ri.eu/). PRACE-5IP receives funding from the EU's
Horizon 2020 research and innovation programme (2014-2020) under grant
agreement no. 730913.
Paginate stderr output into paging command, using 'less' by default,
following the same fashion and behavior than 'git' command.
Pager is enabled by default in modulecmd script. New global variables
'g_use_pager', 'g_pager' and 'g_pager_opts' control default behavior of
module command.
Pager is enabled only if stderr stream is attached to a terminal.
Pager setup can then be superseeded by environment variables. If LESS
variable is set and paging command is set to 'less', default pager
options are cleared to use those defined in LESS variable.
If MODULES_PAGER variable is defined, its value superseeds paging
activation, command and options. If this variable is empty, paging is
disabled.
If PAGER variable is defined and MODULES_PAGER is unset, PAGER value
superseeds paging activation, command and options. If this variable is
empty, paging is disabled.
Default behavior and MODULES_PAGER or PAGER environment variables can be
superseeded by command-line options: --paginate to enable paging and
--no-pager to disable it.
When pager is enabled, a pipe file descripted is ignited to the paging
command and option for stderr stream. Once set, this file descriptor is
used by all report procedures to output message content, rather using
stderr.
modulecmd command-line parse has been revised not to output message
during argument treatment. Debug, warning and error messages are saved
to then be displayed once pager setup is achieved.
An 'initPager' procedure is introduced to configure then start paging.
A 'cleanupAndExit' is added to close pager before exiting if pager has
been started.
Change makefile to build doc with sphinx rather pod. Docs are now
pregenerated in dist-tarball, to avoid requiring documentation build
tool when installing from these dist-tarball.
Adapt travis conf & RPM spec file to the new documentation build
process.
Transform source documents from POD format to reStructuredText to then
benefit from Sphinx documentation framework and Read The Docs publishing
capabilities.
Modulefiles with part of their name starting with a '.' dot character
are considered as hidden modulefiles, like dot files on Unix-kind
filesystems. After introduction of the getModules/findModules procedures
hidden modulefiles where automatically discarded. So this commit
re-introduce the support to locate these dot modulefiles.
Add a 'fetch_hidden' argument to the findModules procedure to enable an
extra lookup on walked directories to gather the dot modulefiles. The
getModules procedures now looks at the passed mod and if named module
correspond to a dot modulefile findModules 'fetch_hidden' argument is
turned on. Since getPathToModule call to getModules for broad search
(with just passed mod root name), this procedure also makes the
'is hidden module' test to order getModules to do the hidden search.
A hidden modulefile does not appear in case of wild search, it is only
returned when search is about its exact name. When a symbolic version
targets a hidden modulefile, this modulefile will also be returned in
case search is about symbol exact name. A module alias targeting a
hidden modulefile is returned as any other aliases.
Add 067-hidden non-regression tests in 20-locate suite.
When searching for a module in a given modulepath directory, if a module
alias or a symbolic version matches searched module but the target of
this alias or symbol is not found in current modulepath directory,
search for this target restarting search from the first modulepath in
list to ensure modulepath priority.
Previously this kind of alias or symbol targeting a module in a
different modulepath were only found if this path was set after the
modulepath where the alias or symbol is defined.
Clarify alias and symbolic version modulepath resolution steps in
modulefile man page.
Instead of removing the whole line when no more module specified on it
during an 'initrm' command or during an 'initclear', keep the line with
'module load' to be able to reuse this line on next 'initadd' command.
Adapt non-regression tests in 050-rm and 060-2nd of 60-initx suite and
diff doc.
Report an 'unsupported option' warning message when C-version specific
command-line switches are passed rather than producing an 'invalid
option' error.
Adapt non-regression tests of 00-init/090-switches and
70-maint/060-apropos and diff doc.
Look the full argument list to find options or command switches, so
options may be passed after the command name and command switches may be
found before the command name. With this behavior commad-line argument
position constraint is aligned with C-version.
Adapt non-regression tests in 70-maint suite and diff doc.
Register alias and symbolic version deep resolution at definition time
through a new 'setModuleResolution' procedure called by 'module-version'
and 'module-alias' procedures. Make use of new global array
'g_moduleResolved' and its reverse structure 'g_resolvedHash' to keep
registered resolution at hand. Also introduce 'g_symbolHash' global
array to register and easily get the list of all symbols for a given
module.
As resolution is now computed at definition time, the 'getVersAliasList'
and 'resolveModuleVersionOrAlias' procedures can be greatly simplified
and just need to return the value of the 'g_symbolHash' or
'g_moduleResolved' arrays for the module name passed as argument. This
change saves lot of time especially on commands heavily relying on these
procedures like 'avail'.
The global arrays 'g_versionHash', 'g_moduleDefault' and 'g_aliasHash'
become useless with this change so they have been removed.
As a side effect of resolving alias and symbolic version at definition
time, resolution loop are not registered anymore and produce an error
message when spotted.
Adapt tests from 60-initx to match results produced by this module
flavor. Clarify differences with C-version on these module commands in
diff_with_c-version documentation.
Add 'module test' command to trigger when called execution of a
ModulesTest procedure in target modulefile following same kind of
mechanism than 'module help'.
If ModulesTest procedure is missing from modulefile, a 'Unable to find
ModulesTest proc' message is displayed but no error code is set. If
ModulesTest procedure returns 1 (true), test is considered successful and
message 'Test result: PASS' is displayed. If ModulesTest returns no or
any other value, test is considered failed and message 'Test result:
FAIL' is displayed. In this case, module command exit in error.
Adapt bash and tcsh completion scripts for the new command. Describe new
command and new mode in docs.
Adapt existing non-regression tests and relative test modulefiles for
new command and new mode in 00-init, 50-cmds and 70-maint suites. Add
085-test tests in 70-maint to check coherent behavior of new command.
Improve diff_with_c-version document to describe the features of the
Tcl-version that are not supported on the C-version.
Also state that the diff takes C version 3.2.10 against Tcl version
1.729 as a basis. Differences appearing past these versions will be
flagged with the release number of appearance.
