Hello All,
Following this discussion, I would like to let you know that I have added a
"Configuration options" summary table in the INSTALL document:
https://modules.readthedocs.io/en/latest/INSTALL.html#configuration-options
The description of configuration options, installation options and
environment variables have also been enhanced to report the relations
between each items.
Regards,
Xavier
Le sam. 15 janv. 2022 à 05:21, Xavier Delaruelle <
xav...@gm...> a écrit :
> Hi Paul,
>
> The configuration option should be looked at rather its corresponding
> superseding environment variable. Module configuration option has default
> value and can then be superseded by setting a MODULE_* environment
> variable. Configuration option handling can be controlled with "module
> config" command. By default it lists all known configuration options:
>
> $ module config
> Modules Release 5.0.1+221-g754913fe (2022-01-10)
>
> - Config. name ---------.- Value (set by if default overridden)
> ---------------
> advanced_version_spec 1
> auto_handling 1 (env-var)
> avail_indepth 1
> ...
>
> When using the default value set when Modules is built (through the
> ./configure script), module config will just report this value:
>
> $ module config mcookie_check
> Modules Release 5.0.1+221-g754913fe (2022-01-10)
>
> - Config. name ---------.- Value (set by if default overridden)
> ---------------
> mcookie_check always
>
> You can also use this command to set a specific value to the config option
> (it will set the corresponding MODULES_* environment variable):
>
> $ module config mcookie_check eval
>
> When the default value is superseded, a '(env-var)' mention appear:
>
> $ module config mcookie_check
> Modules Release 5.0.1+221-g754913fe (2022-01-10)
>
> - Config. name ---------.- Value (set by if default overridden)
> ---------------
> mcookie_check eval (env-var)
>
> The initrc file, evaluated when the module command initializes in user's
> shell session, can host "module config" commands. This is the good location
> to define your site-specific configuration. See the configuration section
> of the installation guide:
>
> https://modules.readthedocs.io/en/latest/INSTALL.html#configuration
>
> I will look at better explaining the default value of configuration option
> in the documentation.
>
> Best regards,
> Xavier
>
>
>
> Le ven. 14 janv. 2022 à 17:37, Paul Markfort <pau...@gm...> a
> écrit :
>
>> Note:
>> module config --dump-state
>>
>> only lists the environment variables that are set. Unless there is
>> another command that does this, maybe add a "module config -dump-state-all"
>> that lists all the environment variables that could be set and the current
>> assumed values (or better, or additionally, a -dump-state-unset to only
>> list those that are not set).
>>
>>
>> On 2022-01-14 10:23 AM, Paul Markfort wrote:
>> > Great to see this improvement.
>> >
>> > Do you have a reference on how to change the assumed default values for
>> any of the MODULES_* environment variables (the value assumed if the
>> environment variable is not set) in the siteconfig.tcl file? In
>> particular, I would want to have MODULES_MCOOKIE_CHECK assumed to be eval
>> (for the site, not in the distribution); but, there are others that might
>> be worthwhile to have a site default for as well.
>> >
>> > Is there a module command that can list all these environment variables
>> and what the current (assumed or set) setting is for each? Perhaps that
>> command (if it exists) should be listed on the documentation pages just
>> below the ENVIRONMENT heading somehow.
>> >
>> >
>> > Also, in the documentation of the environment variables, the default
>> assumed values for many of them is not listed. May I recommend that the
>> default value be listed right after the variable either like this:
>> > MODULES_MCOOKIE_CHECK default_value: always
>> >
>> > or:
>> > MODULES_MCOOKIE_CHECK
>> > default_value: always
>> >
>> >
>> > On 2022-01-14 12:41 AM, Xavier Delaruelle wrote:
>> >> Hello All,
>> >>
>> >> Modules 5.1 work is ongoing. A new configuration option,
>> mcookie_check, is
>> >> introduced to skip the verification of each file in modulepath
>> directories
>> >> to determine if they are modulefiles or not. When this option is set to
>> >> `eval`, file checks only occur when an attempt is made to evaluate
>> these
>> >> files, not when listing available modules. So if you fully control what
>> >> files are saved under the modulepath directories you could get a nice
>> speed
>> >> improvement, especially for commands like 'module avail':
>> >>
>> >>
>> https://modules.readthedocs.io/en/latest/MIGRATING.html#reducing-number-of-i-o-operations
>> >>
>> >> A full cookbook recipe is also available to describe the features of
>> >> Modules that help to reduce the I/O load of walking through the
>> available
>> >> modulefiles:
>> >>
>> >>
>> https://modules.readthedocs.io/en/latest/cookbook/reduce-io-load.html#reduce-io-load
>> >>
>> >> Regards,
>> >> Xavier
>> >>
>> >>
>> >>
>> >> _______________________________________________
>> >> Modules-interest mailing list
>> >> Mod...@li...
>> >> https://lists.sourceforge.net/lists/listinfo/modules-interest
>> >>
>> >
>>
>> --
>> --------------------------------------------------------
>> The views and opinions expressed above are strictly
>> those of the author(s). The content of this message has
>> not been reviewed nor approved by any entity whatsoever.
>> --------------------------------------------------------
>> Paul FM Info: http://paulfm.com/~paulfm/
>> --------------------------------------------------------
>>
>>
>> _______________________________________________
>> Modules-interest mailing list
>> Mod...@li...
>> https://lists.sourceforge.net/lists/listinfo/modules-interest
>>
>
|