Skip to content

Commit

Permalink
doc: desc. multi elts in MODULERCFILE in INSTALL/man/changes
Browse files Browse the repository at this point in the history
  • Loading branch information
xdelaruelle committed Jul 11, 2023
1 parent 93806b8 commit 6a18598
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ achieve a specific setup, some additional steps may be required:
6. Prior running the module sub-command specified as argument, the
:file:`modulecmd.tcl` script evaluates the global run-command files. These
files are either the :file:`rc` file in the directory designated by the
:instopt:`--etcdir` option, the file designated in the
:instopt:`--etcdir` option, the file(s) designated in the
:envvar:`MODULERCFILE` environment variable or the user-specific RC file
located in :file:`$HOME/.modulerc`. The RC files are modulefiles (limited
to a subset of the :ref:`modulefile Tcl
Expand Down
5 changes: 5 additions & 0 deletions doc/source/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1115,3 +1115,8 @@ The following Modules configuration option has been introduced on Modules 5.
Starting Modules 5.3, these configuration options accept value prefixed by
``+`` or ``-`` which means value should respectively be appended to or
subtracted from current configuration option value.

:mconfig:`rcfile`

Starting Modules 5.4, this configuration option accepts more than one global
rc file location. A colon character separates each of these locations.
14 changes: 9 additions & 5 deletions doc/source/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,10 @@ user and *modulefile* specific setups. These files are interpreted as
Upon invocation of :file:`modulecmd.tcl` module run-command files are sourced
in the following order:

1. Global RC file as specified by :envvar:`MODULERCFILE` variable or
|file etcdir_rc|. If :envvar:`MODULERCFILE` points to a directory, the
:file:`modulerc` file in this directory is used as global RC file.
1. Global RC file(s) as specified by :envvar:`MODULERCFILE` variable or
|file etcdir_rc|. If a path element in :envvar:`MODULERCFILE` points to a
directory, the :file:`modulerc` file in this directory is used as a global
RC file.

2. User specific module RC file :file:`$HOME/.modulerc`

Expand Down Expand Up @@ -1200,7 +1201,7 @@ Module Sub-Commands

.. mconfig:: rcfile

Global run-command file location.
Location of global run-command file(s).

This configuration option is unset by default. The :envvar:`MODULERCFILE`
environment variable is defined by :subcmd:`config` sub-command when
Expand Down Expand Up @@ -3701,9 +3702,12 @@ ENVIRONMENT

.. envvar:: MODULERCFILE

The location of a global run-command file containing *modulefile* specific
The location of a global run-command file(s) containing *modulefile* specific
setup. See `Modulecmd startup`_ section for detailed information.

Several global run-command files may be defined in this environment variable
by separating each of them by colon character.

This environment variable value supersedes the default value set in the
:mconfig:`rcfile` configuration option. It can be defined with the
:subcmd:`config` sub-command.
Expand Down

0 comments on commit 6a18598

Please sign in to comment.