Xavier Delaruelle
fcfc0ead96
doc: desc. SGR mechanism for tags in design doc
2020-12-18 18:58:53 +01:00
Xavier Delaruelle
4051cbc01c
doc: desc. MODULES_TAG_ABBREV in module(1) man
2020-12-18 18:58:37 +01:00
Xavier Delaruelle
f9e83b52c6
doc: desc. tag abbrev in module tags design
2020-12-18 18:58:37 +01:00
Xavier Delaruelle
87180618d3
doc: desc. MODULES_TAG_ABBREV in diff doc
2020-12-18 18:58:37 +01:00
Xavier Delaruelle
4e6319be9d
Raise error when reserved tag name is set
...
Raise an error when a reserved tag name is defined with module-tag.
Reserved names are currently: loaded, auto-loaded, forbidden,
nearly-forbidden and hidden.
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
f39987d965
doc: desc. inherited tag from module-{hide,forbid}
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
310e92531e
doc: desc. module-tag in modulefile(4)
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
aaef422d69
doc: desc MODULES_LMTAG in module(1) man
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
6ffc724791
doc: desc. MODULES_TAG on diff doc
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
c09e83b0c4
doc: desc. module-tag in diff doc
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
40ceac528e
doc: desc module-info tags in modulefile(4) man
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
f841266dfc
doc: desc. module-info tags in diff doc
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
fe1a46be99
doc: add initial module-tag design notes
2020-12-18 18:58:26 +01:00
Xavier Delaruelle
d73b22fef8
doc: fix code-block syntax issue in hide-and-forbid-modules
...
An argument value was missing for a code-block in the
hide-and-forbid-modules cookbook recipe. Set value to none, as this
block cannot be highlighted as Tcl code.
2020-12-05 17:34:59 +01:00
Xavier Delaruelle
c3432ac87f
doc: fix missing space in test-modulefiles rcp
...
Thanks to Aurélien Degrémont for spotting this issue.
2020-11-17 10:09:37 +01:00
Colin Marquardt
e22aaa98f9
doc: add proper ReST references in test-modulefiles rcp
2020-11-17 06:34:48 +01:00
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
