Commit Graph

312 Commits

Author SHA1 Message Date
Xavier Delaruelle
e508673b9f doc: desc. 'loaded' sym in module(1) man 2020-11-15 10:04:09 +01:00
Xavier Delaruelle
303c63f602 doc: desc. --not-req in modulefile(4) man 2020-11-15 10:03:54 +01:00
Xavier Delaruelle
98eddca9f6 doc: desc. implicit_requirement in module(1) man 2020-11-15 10:03:54 +01:00
Xavier Delaruelle
36aa8b003a doc: desc. --not-req in diff doc 2020-11-15 10:03:54 +01:00
Xavier Delaruelle
5596bf729d doc: desc. MODULES_IMPLICIT_REQUIREMENT in diff 2020-11-15 10:03:42 +01:00
Xavier Delaruelle
774afeb51c doc: desc. shells_with_ksh_fpath in module(1) 2020-11-15 10:03:42 +01:00
Xavier Delaruelle
71aa5c7575 doc: desc. MODULES_SHELLS_WITH_KSH_FPATH in diff doc 2020-11-15 10:03:42 +01:00
Xavier Delaruelle
630df2009e doc: MODULES_LMALTNAME used on list to report syms 2020-11-15 10:03:31 +01:00
Xavier Delaruelle
c081ad5856 doc: desc alt name prefixes used in MODULES_LMALTNAME 2020-11-15 10:03:31 +01:00
Xavier Delaruelle
4f99282692 doc: update new-features-without-breaking-old-module recipe
Describe use of new ModuleTool and ModuleToolVersion Tcl variables as
well as versioncmp modulefile command.
2020-11-15 10:03:31 +01:00
Xavier Delaruelle
e6b204f99a doc: desc. new versioncmp command in modulefile(4) 2020-11-15 08:45:47 +01:00
Xavier Delaruelle
55323a48a0 doc: desc. ModuleTool and ModuleToolVersion in modulefile(4) 2020-11-15 08:45:47 +01:00
Xavier Delaruelle
b7b1037b45 doc: add new 'mfvar' sphinx directive/role 2020-11-15 08:45:47 +01:00
Xavier Delaruelle
202d362d67 doc: desc. versioncmp new elements in diff doc 2020-11-15 08:45:47 +01:00
Xavier Delaruelle
d44a4b7f51 doc: add 'hide-and-forbid-modules' cookbook recipe 2020-11-14 15:23:09 +01:00
Xavier Delaruelle
0c2a2e8d9b doc: remove duplicate envvar desc. section 2020-11-05 21:02:47 +01:00
Xavier Delaruelle
1310bb707a doc: desc. shell special chars escaping in diff doc
Shell special characters like backticks are escaped when used in values
starting Modules 4.

Fixes #365
2020-10-19 20:50:00 +02:00
Xavier Delaruelle
eee8e8772c doc: fix typo on 4.5 and 4.6 envvar desc. 2020-10-19 20:23:13 +02:00
Xavier Delaruelle
384ddc50bd doc: rework module-{hide,forbid} option description 2020-10-06 20:28:50 +02:00
Xavier Delaruelle
3536977677 doc: fix typos in diff doc for 4.6 new mf cmds 2020-10-03 16:43:28 +02:00
Xavier Delaruelle
20405b7b83 doc: add 'new-features-without-breaking-old-module' recipe 2020-10-01 21:14:27 +02:00
Xavier Delaruelle
0ea7915c3a doc: clarify hide-forbid design regarding retained rule 2020-09-29 22:08:12 +02:00
Xavier Delaruelle
12305efe17 doc: desc. trace in INSTALL/module(1) 2020-09-06 15:31:30 +02:00
Xavier Delaruelle
830e2ca5a7 doc: desc. debug2 verbosity mode in diff/man/NEWS/INSTALL 2020-09-05 21:39:27 +02:00
Xavier Delaruelle
89386f8916 doc: desc. nearly-forbidden feature and opts in design notes 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
9f0e64badd doc: desc. --nearly-message option in modulefile(4) man 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
733aedd0eb doc: desc. nearly_forbidden_days config in man/diff docs 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
148a1c90e6 doc: desc. --message in module-forbid design notes 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
fb703b5b82 doc: desc --message module-forbid option in NEWS/modulefile(4) 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
588cb0a594 doc: update desc. of module-forbid in design notes 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
5b7bf39c58 doc: update desc. of module-forbid in man pages. 2020-08-28 07:18:25 +02:00
Xavier Delaruelle
9bd661d6af doc: desc. --hard in hide-or-forbid design doc 2020-08-18 15:41:50 +02:00
Xavier Delaruelle
65da551e61 doc: desc auto sym hidden properties in modulefile(4) 2020-08-18 13:46:28 +02:00
Xavier Delaruelle
114618ab59 Auto-symbols cannot be set hidden
Hidden statements can only target declared symbolic versions and not
those automatically defined (@default and @latest). Thus when a declared
`default` or `latest` symbol is set hidden, an auto-symbol is
automatically defnied instead (targeting highest module version
available).
2020-08-18 11:59:57 +02:00
Xavier Delaruelle
ab85429a42 doc: desc --hard option in NEWS/MIGRATING/man 2020-08-18 11:59:57 +02:00
Xavier Delaruelle
b2c0db9188 doc: specify date time format in hide/forbid design notes 2020-08-15 18:29:26 +02:00
Xavier Delaruelle
6a8320cf85 Raise error rather warn when --not-{user,group} used on Win
Raise an error rather report a warning when the --not-user or
--not-group options to the module-hide or module-forbid commands are
used on Windows platform.

Issue is clearly localized this way when trying to load impacted
modules. Also as such error leads to skip remaining part of modulerc,
staff will fix it right away.
2020-08-15 18:29:26 +02:00
Xavier Delaruelle
ebfb28c0ac doc: desc. --before/--after in modulefile(4) man 2020-08-15 18:29:26 +02:00
Xavier Delaruelle
84b58ac041 doc: desc module-forbid in module(1)/modulefile(4) 2020-08-15 10:12:53 +02:00
Xavier Delaruelle
7c85e39c46 doc: clarify mod@1.0,2.0 load selection in forbid context 2020-08-14 09:41:30 +02:00
Xavier Delaruelle
3dd5fcf487 Ignore --not-user/--not-group options on Windows platform
Ignore any `--not-user` or `--not-group` option set on `module-hide` or
`module-forbid` commands on Windows platform. Emit a warning message to
indicate these options are not supported.
2020-08-13 21:43:57 +02:00
Xavier Delaruelle
b3941083e7 Reword '--allow-group' option into '--not-group'
Reword module-hide option `--allow-group' into `--not-group` to get a
generic term to designate that command does not apply to specified
groups. Such generic term could be reused on other future modulefile
commands, making this concept easier to understand as it applies with
the same meaning on several commands.
2020-08-11 07:05:46 +02:00
Xavier Delaruelle
8eececdc42 Reword '--allow-user' option into '--not-user'
Reword module-hide option `--allow-user' into `--not-user` to get a
generic term to designate that command does not apply to specified
users. Such generic term could be reused on other future modulefile
commands, making this concept easier to understand as it applies with
the same meaning on several commands.
2020-08-11 07:05:46 +02:00
Xavier Delaruelle
4cc42c88e4 doc: desc. --allow-group in modulefile(4) man and NEWS 2020-08-11 07:05:46 +02:00
Xavier Delaruelle
9cd50a45a1 doc: desc. --allow-user opt in modulefile(4) man and NEWS 2020-08-11 07:05:46 +02:00
Xavier Delaruelle
73d80a6b77 doc: desc. module-hide in modulefile(4) man 2020-08-11 07:05:46 +02:00
Xavier Delaruelle
10230d5898 doc: desc. --all/-a option in module(1) man 2020-08-11 07:05:46 +02:00
Xavier Delaruelle
de4e2316c2 Remove -a/--all option for is-avail sub-cmd
As it seems more consistent that any `is-avail mod` command returning
true should lead to a ``load mod`` command effectively loading a module,
-a/--all option does not apply to is-avail sub-command.
2020-08-11 07:02:18 +02:00
Xavier Delaruelle
fa5584797d doc: desc. module-hide/module-forbid/--all in diff doc 2020-08-11 07:02:18 +02:00
Xavier Delaruelle
fc8872e1d9 doc: add hide-or-forbid-modulefile design doc 2020-08-10 09:00:56 +02:00