Xavier Delaruelle
a015be2d26
doc: add variant info to module-info in modulefile(4)
2021-07-11 13:47:50 +02:00
Xavier Delaruelle
f77cde3eeb
doc: desc. MODULES_VARIANT_SHORTCUT in module(1)
2021-07-11 13:47:50 +02:00
Xavier Delaruelle
54a510e373
doc: desc. MODULES_LMVARIANT in module(1)
2021-07-11 13:47:50 +02:00
Xavier Delaruelle
fe55bf40ae
doc: desc. no implicit req if module not found by try-load
2021-07-06 07:51:41 +02:00
Xavier Delaruelle
592d1c7833
doc: desc. getenv on display eval mode in modulefile(4)
2021-07-06 07:51:41 +02:00
Xavier Delaruelle
d9c68cb126
doc: desc. ModuleVariant in modulefile(4)
2021-07-06 07:51:41 +02:00
Xavier Delaruelle
5f3e153fdb
doc: mention getenv introduction release
2021-07-06 07:51:41 +02:00
Xavier Delaruelle
19d36b93df
doc: desc. getvariant in modulefile(4)
2021-07-06 07:51:41 +02:00
Xavier Delaruelle
0114f34dd8
doc: use catch to get v3 module load behavior in modfile
...
Add description to the diff doc to get the behavior of Modules v3 back
when using `module load` command in modulefile. To pursue evaluation
even when the `module load` fails, enclose it within a `catch` Tcl
command.
Fixes #197 .
2021-07-04 20:34:57 +02:00
Xavier Delaruelle
1a2de0570c
doc: fix options on subcmd aliases in module(1)
2021-07-04 20:34:57 +02:00
Xavier Delaruelle
297cc4d04e
doc: desc try-load in module(1) man
2021-07-04 20:34:57 +02:00
Xavier Delaruelle
aa04862eea
doc: desc. try-load in diff doc
2021-06-30 21:55:57 +02:00
Xavier Delaruelle
8c246fac60
doc: refine desc of variant_shortcut in design
2021-06-28 22:09:15 +02:00
Xavier Delaruelle
fa44c979c1
doc: update boolean variant specs
2021-06-22 06:17:58 +02:00
Xavier Delaruelle
390390ceee
doc: desc. is-dfl-specifically-asked in variant design
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
ccfa9ce992
doc: desc. forbidden version variant in design doc
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
37fcacf76e
doc: desc variant in requirement spec in design doc
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
3be071b70c
doc: desc module-info {name,specified} & variant in design doc
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
6837b39353
doc: module-info tags/loaded & variant in design doc
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
6763c518e8
doc: fix module-info specified desc. when unloading variant
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
3ae9a1697b
doc/ts: no variant on module-info {alias,symbols,version}
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
df573bee7a
doc/ts: no variant on module-{alias,virtual,version}
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
7aec88bf66
doc/ts: depre mod relying on default variant
...
When an optional requirement is loaded by not specifying its variant
value to rely on default, the Dependent Reload mechanism will miss to
detect the dependent module to reload, as variant is not specified on
command line thus it does not match the requirement specification prior
load.
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
6cdf2a7031
doc: desc. use of variant on search contexts
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
dbe2861a14
doc: desc sticky/hide/tag in variant design
2021-06-21 20:43:48 +02:00
Xavier Delaruelle
ca6a8bd6a3
doc: variant ignored on avail/whatis
2021-06-21 20:43:47 +02:00
Xavier Delaruelle
096eb3ab01
doc: tags on variant do not appear on avail
2021-06-21 20:43:47 +02:00
Xavier Delaruelle
5d7031bb84
doc: desc already loaded mod in variant design
2021-06-21 20:43:33 +02:00
Xavier Delaruelle
d3c3f4afa4
doc: desc variant cmp when restoring coll in variant design
2021-06-21 20:43:33 +02:00
Xavier Delaruelle
ae3423dc73
doc: desc. variant cmp in design doc
2021-06-21 20:43:31 +02:00
Xavier Delaruelle
97942f4398
doc: remove ref to does*ModuleMatchesName ref in doc
2021-06-21 20:43:31 +02:00
Xavier Delaruelle
a4b9c749b0
doc: define sphinx roles/css to colorize variant
2021-06-21 20:43:12 +02:00
Xavier Delaruelle
0f1d8acad3
doc: desc. getvariant in variant design doc
2021-06-21 20:43:11 +02:00
Xavier Delaruelle
9d901e07ef
doc: remove --multivalued opt from variant cmd
...
Ability to specify multiple values for a variant does not seem to be
needed in the first version of the mechanism.
2021-06-21 20:43:11 +02:00
Xavier Delaruelle
6f4629e1e7
doc: desc variant report on info msgs in design doc
2021-06-21 20:43:11 +02:00
Xavier Delaruelle
0d21518e9b
doc: desc. recording collection in variant design
2021-06-21 20:43:11 +02:00
Xavier Delaruelle
92d3a89e3b
doc: desc is-default-set persistency in variant design
2021-06-21 20:43:11 +02:00
Xavier Delaruelle
a4c08b3c34
doc: desc. variant reporting in design docs
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
e893e8f686
install/doc: add va color key
...
Add the `va` color key in default light and dark color palettes to
graphically enhance the report of variant value.
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
1c5bbd6c90
install/doc: add variant element on list_*output configs
...
Add the element `variant` in the allow list of the list_output and
list_terse_output configuration options. Set this new element in the
default value list of the list_output configuration option.
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
c45e49cb3b
doc: desc. variant changes in diff doc
2021-06-21 20:43:10 +02:00
Xavier Delaruelle
25742541b8
doc: desc. setenv diff between Modules 3.2 and 4+
...
Describe the difference between Modules 3.2 and 4+ when it comes to the
arguments passed to the setenv modulefile command.
Fixes #402 .
2021-06-20 21:42:26 +02:00
Xavier Delaruelle
919662c3c2
doc: desc setup with shell-specific scripts in cookbook
...
Update the *Source script in modulefile* cookbook recipe to add it a
*Usage with shell-specific scripts* section that demonstrate how to use
modulefiles with `source-sh` commands when software provide a specific
initialization script for each shell it supports.
Take this opportunity to improve the readability of this recipe by
coloring/highlighting shell session examples.
Fixes #399 .
2021-05-30 15:16:33 +02:00
Xavier Delaruelle
1217877b80
doc: desc. when new concepts were added in module(1)
2021-05-11 19:43:26 +02:00
Xavier Delaruelle
a04ec85549
doc: desc use of version range in version list in manpages
2021-05-11 19:43:26 +02:00
Xavier Delaruelle
39ed4b71be
doc: update design doc now vers range allowed in list
2021-05-11 19:43:26 +02:00
Xavier Delaruelle
30d12859ea
doc: add *Variants* design document
2021-05-09 21:19:51 +02:00
Xavier Delaruelle
2ea84fd5e6
doc: desc. edit/MODULES_EDITOR in module(1)
2021-04-25 22:22:01 +02:00
Xavier Delaruelle
3b36ee5c38
doc: desc. edit/editor in diff doc
2021-04-24 13:36:51 +02:00
Xavier Delaruelle
d9c3883b71
Release of version 4.7.1
2021-04-06 06:39:50 +02:00