Commit Graph

372 Commits

Author SHA1 Message Date
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
Rob Hurt
265b41f80b doc: clarify about lang-specific modules in index
I think it would be worth adding a clarification about Perl (and other
language) modules vs. the environment modules described here, because
the use of the term "modules" for both can be confusing to new users.

Also fixed some typos and formatting.
2020-07-29 16:58:42 +02:00
Xavier Delaruelle
5c85dbf627 doc: use versioned magic cookie in recent examples
Fixes #349.
2020-07-24 22:10:25 +02:00
Xavier Delaruelle
76e4d10d16 doc: desc. module-info usergroups/username in modulefile(4) 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
16368cfc32 doc: reorder module-info sub-cmd desc. in modulefile(4) 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
eb4e830590 doc: desc. module-info username/usergroups in diff doc 2020-07-16 21:53:51 +02:00
Xavier Delaruelle
44c9147ee8 Apply inclusive terminology in code and docs
Use inclusive terminology [1] to eliminate 'master' and 'slave' terms as
much as possible from code and documentation. 'master' has been changed
into 'main' and 'slave' into 'subordinate' or 'sub'.

After this change, some references to the 'master' and 'slave' word can
still be found in repository:
* `slaves` sub-command of `interp` Tcl command
* `--slave` option of `update-alternatives tool in RPM spec file
* `master_doc` attribute of Sphinx `conf.py` file
* git 'master' branch need to be renamed and tools referring it need to
  be updated accordingly (configure, script/mpub, script/mrel)

[1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=49decddd39e5f6132ccd7d9fdc3d7c470b0061bb
2020-07-16 21:31:30 +02:00
Xavier Delaruelle
a44f1fd195 doc: use brighter variation of red svg logo
Built from CMYK EPS file.
2020-06-27 08:27:40 +02:00
Xavier Delaruelle
b0d2fe921c doc: fix html theme on RTD
To avoid RTD to override html_theme_options when html_theme is set to
'default'.
2020-06-24 08:03:58 +02:00
Xavier Delaruelle
fd7ba8de87 doc: include logo in doc portal 2020-06-24 07:50:09 +02:00
Xavier Delaruelle
d15b7c6494 doc: add source-script-in-modulefile recipe 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
fcc2a32686 doc: desc. source-sh/MODULES_LMSOURCESH in man/diff 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
98846cd6b1 doc: desc. env recording in source-sh design doc 2020-06-01 21:03:12 +02:00
Xavier Delaruelle
227f325ea7 doc: desc. -T/--trace in man/diff/INSTALL docs 2020-06-01 21:02:32 +02:00
Xavier Delaruelle
31fadd19a8 doc: desc. sh-to-mod in module(1) and diff docs 2020-06-01 20:59:50 +02:00
Xavier Delaruelle
2351c9a863 doc: add source-shell-script-in-modulefile design doc 2020-06-01 20:59:50 +02:00
Xavier Delaruelle
69d149e314 doc: desc. default/latest auto symbols in man pages 2020-04-07 15:11:12 +02:00
Xavier Delaruelle
24be4294ee doc: refine default/latest vers spec design 2020-04-07 07:21:27 +02:00
Xavier Delaruelle
bb2c0960ba doc: clarify hidden module location in modulefile.4 2020-03-29 08:20:49 +02:00
Xavier Delaruelle
dddc4789c1 doc: update deflatest design for default/latest modfile 2020-03-26 12:19:25 +01:00
Xavier Delaruelle
6d3a27b786 doc: add ref to 4.0 closed issues in diff doc 2020-03-09 08:19:50 +01:00
Xavier Delaruelle
01e2f4add1 Add support for NO_COLOR env variable
Add support for the NO_COLOR environment variable
(https://no-color.org/) which when set (regardess of its value) prevents
the addition of ANSI color.

When set, NO_COLOR prevails over CLICOLOR and CLICOLOR_FORCE environment
variables. MODULES_COLOR overrides these tree variables.

Fixes #310
2020-02-24 06:53:12 +01:00
Xavier Delaruelle
755841fae5 doc: clarify some statements in compiler-etc-depend recipe 2020-02-21 22:41:46 +01:00