Commit Graph

360 Commits

Author SHA1 Message Date
Xavier Delaruelle
7738fa97b3 doc: desc. mcookie_version_check in INSTALL/diff 2021-01-25 06:08:21 +01:00
Xavier Delaruelle
54e4b3bee6 doc: desc. key section in module(1) man 2021-01-17 20:59:06 +01:00
Xavier Delaruelle
d10b8322bc doc: update 'key' description in module tag design doc 2021-01-17 14:29:17 +01:00
Xavier Delaruelle
a18a44d50e doc: desc. module tags in MIGRATING 2021-01-12 07:05:36 +01:00
Xavier Delaruelle
f48a341023 doc: define sphinx roles/css to colorize parsed-literal 2021-01-09 08:20:17 +01:00
Xavier Delaruelle
b9b43e354d doc: markup config/subcmd/mfcmd in cookbook/design 2021-01-07 07:18:23 +01:00
Xavier Delaruelle
41dc171384 doc: desc. when opt were added to sub-cmd and mf cmd 2021-01-06 08:13:12 +01:00
Xavier Delaruelle
0c7b29af26 doc: desc. -a option on list subcmd in module(1) 2021-01-06 07:54:17 +01:00
Xavier Delaruelle
d5280cc0eb doc: reorg index table of content 2021-01-05 21:59:29 +01:00
Xavier Delaruelle
6e4a856898 doc: markup mconfig refs 2021-01-05 21:29:19 +01:00
Xavier Delaruelle
7a806cda74 doc: desc. when config opts were introduced in module(1) 2021-01-04 08:37:57 +01:00
Xavier Delaruelle
0b3ac595fe doc: desc. module config. option with :mconfig: directive 2021-01-04 08:37:57 +01:00
Xavier Delaruelle
6cd2a46e42 doc: desc. inst. option with :instopt: directive
Add the :instopt: sphinx directive to describe installation option.
2021-01-03 21:50:59 +01:00
Xavier Delaruelle
83c6cfa15a doc: override wide tables in RTD theme 2021-01-03 18:47:44 +01:00
Xavier Delaruelle
e1fbc22105 doc: desc. -f option on purge subcmd in module(1) man 2021-01-03 18:17:01 +01:00
Xavier Delaruelle
a929ef50d1 doc: desc. hidden-loaded in 'Hiding modulefiles' section 2021-01-03 18:17:01 +01:00
Xavier Delaruelle
ed7757382d New year (2021) copyright mention update 2021-01-03 18:17:01 +01:00
Xavier Delaruelle
164864fbac doc: add 'Sticky modules' section in module(1)
And add reference to this new section everytime the sticky module
concept is mentionned in module(1) and modulefile(4).
2021-01-03 18:17:01 +01:00
Xavier Delaruelle
bdb26402f0 doc: add 'Module tags' section in module(1)
And add reference to this new section everytime the module tag concept
is mentionned in module(1) and modulefile(4).
2021-01-03 18:17:01 +01:00
Xavier Delaruelle
bbe0d8e371 doc: desc. special module tags in modulefile(4) man 2021-01-03 18:17:01 +01:00
Xavier Delaruelle
f001c63a35 Unload dependent module on purge if forced
When performing a `purge` sub-command with the `--force` option set,
unload modules that are depended by other modules that cannot unload.
This way `purge --force` behaves like `unload --force`.
2021-01-03 18:17:01 +01:00
Xavier Delaruelle
377a03c189 doc: add *Sticky modules* design notes 2021-01-03 18:17:01 +01:00
Xavier Delaruelle
432e0b5d6b Report already loaded/unloaded mod if verbosity>=verbose2
Report when trying to load a module which is already loaded or when
trying to unload a module which is not loaded in case the verbosity
level currently set is equal to or higher than *verbose2*.

Closes #187
2021-01-03 18:16:46 +01:00
Xavier Delaruelle
b2621d2911 doc: update sticky module desc. in tag design 2021-01-03 18:16:46 +01:00
Xavier Delaruelle
ca7b23dbd9 doc: use tables to desc. new cmds/switches in diff doc 2020-12-28 10:07:08 +01:00
Xavier Delaruelle
d7d03c79e8 doc: desc. verbose2 verbosity level in man/INSTALL/diff 2020-12-18 18:59:23 +01:00
Xavier Delaruelle
3510d3d248 doc: precise debug2/-DD were added in v4.6 in module(1) man 2020-12-18 18:59:23 +01:00
Xavier Delaruelle
f8de7f7cb7 doc: desc hidden-loaded in module/modulefile man pages 2020-12-18 18:59:11 +01:00
Xavier Delaruelle
778dac700a doc: add hidden-loaded example on hide/forbid recipe 2020-12-18 18:59:11 +01:00
Xavier Delaruelle
4202d472d4 doc: update hidden once loaded module design 2020-12-18 18:59:10 +01:00
Xavier Delaruelle
6a1c82f3b2 doc: desc. MODULES_TAG_COLOR_NAME in module(1) man 2020-12-18 18:58:53 +01:00
Xavier Delaruelle
cdaac0a964 doc: desc. MODULES_TAG_COLOR_NAME in diff doc 2020-12-18 18:58:53 +01:00
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