Skip to content

Commit 44ce814

Browse files
committed
Normalize reference to Environment Modules
Simplify/normalize "Tcl/C environment modules", "Tcl-only environment modules" and "modern Tcl-only environment modules" into "Environment Modules". Fix character case ("Environment Modules" instead of "environment modules") when refering to the modules tool. Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
1 parent 39f8615 commit 44ce814

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -492,10 +492,10 @@ A list of supported modules tools can be obtained using `eb --avail-modules-tool
492492

493493
Currently, the following modules tools are supported:
494494

495-
* `Lmod` *(default)*: Lmod, an modern alternative to environment modules, written in Lua (`lmod`)
496-
* `EnvironmentModules`: modern Tcl-only version of environment modules (4.x) (`modulecmd.tcl`)
497-
* `EnvironmentModulesC`: Tcl/C version of environment modules, usually version 3.2.10 (`modulecmd`)
498-
* `EnvironmentModulesTcl`: (ancient) Tcl-only version of environment modules (`modulecmd.tcl`)
495+
* `Lmod` *(default)*: Lmod, an modern alternative to Environment Modules, written in Lua (`lmod`)
496+
* `EnvironmentModules`: modern Tcl-only version of Environment Modules (4.x) (`modulecmd.tcl`)
497+
* `EnvironmentModulesC`: Tcl/C version of Environment Modules, usually version 3.2.10 (`modulecmd`)
498+
* `EnvironmentModulesTcl`: (ancient) Tcl-only version of Environment Modules (`modulecmd.tcl`)
499499

500500
You can determine which modules tool you are using by checking the
501501
output of `type -f module` (in a `bash` shell), or `alias module` (in a `tcsh` shell).
@@ -548,7 +548,7 @@ Possible values are:
548548
!!! note
549549
Lmod is able to deal with having module files in place in both Tcl and Lua syntax. When a module file in Lua
550550
syntax (i.e., with a `.lua` file name extension) is available, a Tcl module file with the same name will be
551-
ignored. The Tcl-based environment modules tool will simply ignore module files in Lua syntax, since they do not
551+
ignored. Environment Modules tool will simply ignore module files in Lua syntax, since they do not
552552
contain the header string that is included in Tcl module files.
553553

554554
!!! note

docs/cray-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ see <https://github.com/eth-cscs/production/tree/master/jenkins-builds>.
6464
### Modules tool
6565

6666
* Sisu: self-installed Lmod 5.8
67-
* Piz Daint, Dora, Swan, Santis, Brisi: system-provided environment modules 3.2.10
67+
* Piz Daint, Dora, Swan, Santis, Brisi: system-provided Environment Modules 3.2.10
6868

69-
Example for environment modules 3.2.10:
69+
Example for Environment Modules 3.2.10:
7070

7171
``` shell
7272
source /opt/modules/3.2.10.3/init/bash

docs/installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The only strict requirements are:
2222
* Python >= 3.6 is required for EasyBuild 5.0;
2323
* no third-party Python packages are strictly required (the Python standard library is sufficient);
2424
* for some *specific* EasyBuild features additional Python packages are required however, see [Optional Python packages][optional_python_packages];
25-
* a **modules tool**: Tcl(/C) environment modules or Lmod
25+
* a **modules tool**: Environment Modules or Lmod
2626
* the actual modules tool *must* be available via `$PATH`, see [Required modules tool][required_modules_tool]
2727
* a C/C++ compiler (e.g., `gcc` and `g++`)
2828
* only required to build and install GCC with, or as a dependency for the Intel compilers, for example
@@ -324,14 +324,14 @@ Hence, a modules tool must be available to consume module files with.
324324

325325
Supported module tools:
326326

327-
* [Tcl/C environment-modules](https://modules.sourceforge.net/) (version >= 4.3.0)
327+
* [Environment Modules](https://modules.sourceforge.net/) (version >= 4.3.0)
328328
* [Lmod](https://lmod.sourceforge.net) (version >= 8.0.0)
329329

330330
!!! note
331331
The path to the actual modules tool binary/script used *must* be included in `$PATH`,
332332
to make it readily available to EasyBuild.
333333

334-
* for Tcl/C environment modules: `modulecmd`
334+
* for Environment Modules: `modulecmd.tcl`
335335
* for Lmod: `lmod`
336336

337337
The path where the modules tool binary/script is located can be determined via the definition of
@@ -341,20 +341,20 @@ Supported module tools:
341341
For Lmod, EasyBuild will try to fall back to finding the `lmod` binary via the `$LMOD_CMD`
342342
environment variable, in case `lmod` is not available in `$PATH`.
343343

344-
For modern Tcl-only environment modules (version >= 4.0.0), EasyBuild will try to fall back to finding the
344+
For Environment Modules (version >= 4.0.0), EasyBuild will try to fall back to finding the
345345
`modulecmd.tcl` binary via the `$MODULES_CMD` environment variable, in case `modulecmd.tcl` is not available
346346
in `$PATH`.
347347

348348

349349
Additional notes:
350350

351-
* Tcl(/C) environment-modules requires [Tcl](https://www.tcl-lang.org/) to be
352-
installed (with header files and development libraries)
351+
* Environment Modules requires [Tcl](https://www.tcl-lang.org/) to be installed
352+
(with header files and development libraries)
353353
* Lmod requires [Lua](https://www.lua.org/) and a couple of non-standard Lua libraries
354354
(`lua-posix`, `lua-filesystem`) to be available
355355
* Tcl (`tclsh`) must also be available for Lmod to support module files in `Tcl` syntax
356-
* a guide to installing Tcl/C environment modules without having root
357-
permissions is available at [Installing environment modules without root permissions][installing_env_mod].
356+
* a guide to installing Environment Modules without having root
357+
permissions is available at [Installing Environment Modules without root permissions][installing_env_mod].
358358
* a guide to installing Lmod without having root permissions is available at
359359
[Installing Lmod without root permissions][installing_lmod].
360360

0 commit comments

Comments
 (0)