envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-14 00:42:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: desc --message module-forbid option in NEWS/modulefile(4)

Browse Source
This commit is contained in:
Xavier Delaruelle
2020-08-23 14:32:09 +02:00
parent ae9570137f
commit fb703b5b82
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
NEWS.rst
View File

@@ -140,6 +140,9 @@ Modules 4.6.0 (not yet released)
:mfcmd:`module-forbid` modulefile commands to ignore hiding or forbidding
definition respectively after and before a specified date time. Accepted
date time format is ``YYYY-MM-DD[THH:MM]``.
* Add ``--message`` option to :mfcmd:`module-forbid` modulefile command to
supplement the error message obtained when trying to evaluate a forbidden
module.
.. _GNU configuration recommendations: https://www.gnu.org/prep/standards/html_node/Configuration.html

5
doc/source/modulefile.rst
View File

@@ -240,7 +240,7 @@ the *modulefile* is being loaded.
* another *modulefile* alias
.. mfcmd:: module-forbid [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] modulefile...
.. mfcmd:: module-forbid [--after datetime] [--before datetime] [--not-user {user...}] [--not-group {group...}] [--message {text message}] modulefile...
Forbid use of *modulefile*. An error is obtained when trying to evaluate a
forbidden module. This command should be placed in one of the
@@ -260,6 +260,9 @@ the *modulefile* is being loaded.
specified. When both options are set, forbidding is not applied if a match is
found for ``--not-user`` or ``--not-group``.
Error message returned when trying to evaluate a forbidden module can be
supplemented with the *text message* set through ``--message`` option.
If a :mfcmd:`module-forbid` command applies to a *modulefile* also targeted
by a :mfcmd:`module-hide --hard<module-hide>` command, this module is
unveiled when precisely named to return an access error.