doc: desc. --mode option support in lmod compat docs

Signed-off-by: Xavier Delaruelle <[email protected]>

Author: xdelaruelle

doc/source/design/lmod-tcl-modulefile-compat.rst

@@ -9,9 +9,9 @@ Lmod Tcl modulefile compatibility
   - No evaluation error
   - Be as close as possible to the behavior of Lmod
 
-- As of Modules v5.0, the following Tcl modulefile command of Lmod are not
-  supported. This document is about how supporting these command in Modules
-  v5.1.
+- Starting with Modules v5.1, the following Tcl modulefile commands from Lmod
+  are now supported. This document describes their implementation and behavior
+  in Modules v5.1 and later.
 
   - ``add-property``
   - ``remove-property``
@@ -382,4 +382,27 @@ Lmod Tcl modulefile compatibility
 - These commands are intended for use only within modulerc evaluation context
   (not within modulefile)
 
+
+``--mode`` option
+-----------------
+
+Lmod introduced on version ``8.7.60`` the ``--mode`` option (short name
+``-m`` or ``-mode``) for the following modulefile commands:
+
+* ``setenv``
+* ``unsetenv``
+* ``prepend-path``
+* ``append-path``
+* ``remove-path``
+* ``pushenv``
+* ``module load``
+* ``module load-any``
+* ``module try-load``
+* ``module unload``
+
+See :ref:`mode-select` design documentation to learn about this option.
+
+This ``--mode`` option is not supported currently on Modules and an error is
+raised when it is used in modulefiles.
+
 .. vim:set tabstop=2 shiftwidth=2 expandtab autoindent:

doc/source/modulefile.rst

@@ -2187,8 +2187,9 @@ Compatibility with Lmod Tcl modulefile
 
 The :file:`modulecmd.tcl` program supports Tcl modulefile or modulerc written
 for Lmod, the alternative :command:`module` implementation developed in Lua.
-Such modulefiles can be evaluated by Modules without raising error.
-Differences between the two implementations are listed below.
+Except for the specific cases listed below, such modulefiles can be evaluated
+by Modules without producing errors. Key differences between the two
+implementations are outlined below.
 
 The ``remove-property`` and ``extensions`` modulefile commands are evaluated
 as a *no-operation* command. No error is obtained if these commands are used
@@ -2197,6 +2198,12 @@ in modulefiles but no change occurs.
 The :mfcmd:`break` command does not accept any argument. A ``msg`` argument
 can be set on Lmod to provide a customized break error message.
 
+The :mfcmd:`setenv`, :mfcmd:`unsetenv`, :mfcmd:`prepend-path`,
+:mfcmd:`append-path`, :mfcmd:`remove-path`, :mfcmd:`pushenv` and ``module``
+:mfcmd:`load<module>`, :mfcmd:`load-any<module>`, :mfcmd:`try-load<module>`
+and :mfcmd:`unload<module>` modulefile commands do not support the ``--mode``
+option. An error is raised if this option is used.
+
 Use of :mfcmd:`reportError` command aborts modulefile evaluation on Lmod. This
 command only reports an error message on Modules.