Commit Graph

499 Commits

Author SHA1 Message Date
Xavier Delaruelle
511eb58a9d doc: refine {restore,set}-on-unload in ctrl mode bhvs 2021-11-06 13:57:10 +01:00
Xavier Delaruelle
38bdaf8b6c doc: add add-new-config-option design doc 2021-10-28 16:02:27 +02:00
Xavier Delaruelle
17fd183a77 doc: add control-mode-behaviors design doc 2021-10-28 16:02:27 +02:00
Xavier Delaruelle
5342f4d809 doc: fix missing only-html tag in man pages 2021-10-26 14:45:56 +02:00
Xavier Delaruelle
47611c4098 doc: desc var filtering on source-sh/sh-to-mod man 2021-10-25 14:05:36 +02:00
Xavier Delaruelle
98ad3df8f8 doc: desc private env var filter on sh-to-mod design 2021-10-25 14:05:36 +02:00
Xavier Delaruelle
d793251ec8 doc: note to extend source-sh/sh-to-mod for other tools 2021-10-20 07:19:11 +02:00
Xavier Delaruelle
b4c0e0f80e doc: desc. state subcmd in man/changes 2021-10-19 07:06:46 +02:00
Xavier Delaruelle
9d74763799 doc: desc. getvariant --return-value option in man/changes 2021-10-17 20:13:16 +02:00
Xavier Delaruelle
3c6d876f14 doc: desc. getenv --return-value option in man/changes 2021-10-17 20:13:16 +02:00
Xavier Delaruelle
58162e1dd5 Warn if --redirect is used on unsupported shells
--redirect is only supported on sh, bash, ksh, zsh and fish shells. Emit
a warning message when used on another shells.
2021-10-17 20:10:36 +02:00
Xavier Delaruelle
422961ac88 doc: desc. --redirect/--no-redirect in man/changes 2021-10-17 20:10:36 +02:00
Xavier Delaruelle
eed719f02b doc: desc. MODULES_REDIRECT_OUTPUT in man/changes 2021-10-17 20:09:36 +02:00
Xavier Delaruelle
f8e5eac64a doc: desc. redirect_output config in man/changes 2021-10-17 20:09:36 +02:00
Xavier Delaruelle
42a4ec8e68 doc: desc open value variant in NEWS/changes 2021-10-17 20:09:24 +02:00
Xavier Delaruelle
fca921ad62 doc: desc optional variant value list in man pages 2021-10-17 20:07:35 +02:00
Xavier Delaruelle
b588c446f3 doc: allow variant definition with no accepted value list 2021-10-17 20:07:35 +02:00
Xavier Delaruelle
1bb0199eeb Release of version 5.0.1 2021-10-16 16:58:59 +02:00
Xavier Delaruelle
71f57555c6 doc: fix default value returned on getenv in man
Fix documentation of getenv modulefile command to describe that an empty
string is now returned when designated environment variable is not
defined and no default value to return is specified.
2021-10-13 07:25:36 +02:00
Xavier Delaruelle
f4f4f78aa4 doc: clarify module subcmd allowed in modulefile
Clarify the module sub-commands that are allowed to be used within a
modulefile.

Fixes #423
2021-10-11 22:08:22 +02:00
Xavier Delaruelle
cd32959b52 doc: desc. __MODULES_AUTOINIT_INPROGRESS in man/changes 2021-09-27 07:27:32 +02:00
Xavier Delaruelle
f508ec274f doc: fix missing space between list entries in variant doc 2021-09-21 06:53:17 +02:00
Xavier Delaruelle
b688be67d8 doc: extend *Log module commands* cookbook
Improve the *Log module commands* cookbook to rely on the `trace` Tcl
command to track every modulefile evaluation and module/ml procedure
calls.

Fixes #412.
2021-09-19 14:32:01 +02:00
Xavier Delaruelle
57e56ff78e doc: desc module reload on screen session in FAQ 2021-09-15 08:16:32 +02:00
Xavier Delaruelle
e17d5ac729 Release of version 5.0.0 2021-09-12 11:33:11 +02:00
Xavier Delaruelle
d2f523c4ca doc: describe first MIGRATING items for Modules 5.0 2021-09-10 07:06:58 +02:00
Xavier Delaruelle
a2541a838b doc: desc. new special chars for module name in change doc 2021-09-08 20:39:35 +02:00
Xavier Delaruelle
b064c38100 doc: add ref to changes doc on index 2021-09-08 07:11:03 +02:00
Xavier Delaruelle
d0eb01d6ca doc: desc. Modules 5 diffs in changes document 2021-09-08 06:58:06 +02:00
Xavier Delaruelle
ad05ff3701 doc: add config option section in changes doc 2021-09-06 22:10:09 +02:00
Xavier Delaruelle
f304280a4b doc: reorg changes document 2021-09-06 21:41:38 +02:00
Xavier Delaruelle
05f3c9cde0 doc/install: rename 'diff_v3_v4' doc into 'changes' 2021-09-06 06:55:34 +02:00
Xavier Delaruelle
b668e21e61 doc: apply file rst markup for initrc/modulespath 2021-09-05 16:05:57 +02:00
Xavier Delaruelle
c62a2ad306 doc: document initrc/modulespath files in module(1) 2021-09-05 16:05:57 +02:00
Xavier Delaruelle
4fd16e9208 doc: fix some rst markup in INSTALL/NEWS/module(1) 2021-09-05 16:05:57 +02:00
Xavier Delaruelle
cf616c25c2 doc: improve config steps explanation in INSTALL 2021-09-04 15:25:54 +02:00
Xavier Delaruelle
9adf880184 doc: update gcc example in README/index 2021-09-02 08:30:13 +02:00
Xavier Delaruelle
bb359f3ec7 doc: add 'Get started with Modules' section in index 2021-09-02 07:17:32 +02:00
Xavier Delaruelle
b32e5b8aaf doc: fix envvar/command markup in index 2021-09-02 07:16:21 +02:00
Xavier Delaruelle
bf4a30c61e doc: update MODULES_SILENT_SHELL_DEBUG in module(1) 2021-09-01 07:48:36 +02:00
Xavier Delaruelle
b68cb6e09f doc: desc. MODULES_QUARANTINE_SUPPORT in module(1) 2021-08-31 05:59:35 +02:00
Xavier Delaruelle
6090d3eda5 doc: desc. __MODULES_QUARANTINE_SET in module(1) 2021-08-31 05:59:35 +02:00
Xavier Delaruelle
63ca36960b doc: clarify unload sticky errors in design doc 2021-08-23 06:47:25 +02:00
Xavier Delaruelle
0f629c15b9 doc: same index template for mfcmd/mfvar than others 2021-08-22 14:46:50 +02:00
Xavier Delaruelle
f334210470 Enforce magic cookie in source and init/user/global rc
Enforce use of the module magic cookie (i.e., `#%Module`) at the start of
global or user rc files, `initrc` configuration file or any scriptfile
passed for evaluation to the `source` sub-command. These files are not
evaluated and an error is produced if the magic cookie is missing or if
the optional version number placed after the cookie string is higher than
the version of the `modulecmd.tcl` script in use.

Note that version 3.2 of Modules was already enforcing the magic cookie
for the user/global rc files.

This enforced back globally to ensure people understand, especially for
the source sub-command, that the script is made for module and it is not
a shell script. It will also help to protect module from automatically
evaluating files with expected file name but unrelated content.

This commit among things reverts 3fe71c0d.
2021-08-22 09:53:32 +02:00
Xavier Delaruelle
2c0323f85b doc: desc when --not-req option has been added 2021-08-20 06:58:34 +02:00
Xavier Delaruelle
97d3fa0308 doc: update desc. of unsetenv on unload in NEWS/man 2021-08-18 22:00:37 +02:00
Xavier Delaruelle
85546253c2 No error if variant unspecified on display mode
No error is raised when evaluating in `display` mode a modulefile without
a value specified for the variant it defines. This change helps to learn
all the variant a modulefile defines. As a result, the unspecified
variant is not instantiated in the ModuleVariant array variable.

Fixes #406.
2021-08-18 07:17:43 +02:00
Xavier Delaruelle
237755f9fb ts/doc: add try-load test/doc on 'module-info command' 2021-08-13 07:53:54 +02:00
Xavier Delaruelle
a4823b5691 doc: desc. new mode/cmd on 'module-info {mode,command}' 2021-08-13 07:53:54 +02:00