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

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

Author: xdelaruelle

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

@@ -405,4 +405,23 @@ 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.
 
+
+``--respect`` option
+--------------------
+
+Lmod has the ``--respect`` option (short name ``-r`` or ``-respect``) for the
+following modulefile commands:
+
+* ``setenv``
+* ``unsetenv``
+
+This option on ``setenv`` does not change the environment variable value, if
+this variable is already defined. On ``unsetenv``, environment variable is not
+unset if its current value does not equal the one specified on ``unsetenv``
+command.
+
+This ``--respect`` 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

@@ -1570,8 +1570,8 @@ the *modulefile* is being loaded.
 
  Unsets environment *variable*. When a *modulefile* is unloaded, no operation
  is performed unless if an optional *value* is defined, in which case
- *variable* is to *value*. The :mfcmd:`unsetenv` command changes the process'
- environment like :mfcmd:`setenv`.
+ *variable* is set to *value*. The :mfcmd:`unsetenv` command changes the
+ process' environment like :mfcmd:`setenv`.
 
  If the ``--noop-on-unload`` option is set, no operation is performed when
  *modulefile* is unloaded. If the ``--unset-on-unload`` option is set,
@@ -2204,6 +2204,9 @@ The :mfcmd:`setenv`, :mfcmd:`unsetenv`, :mfcmd:`prepend-path`,
 and :mfcmd:`unload<module>` modulefile commands do not support the ``--mode``
 option. An error is raised if this option is used.
 
+The :mfcmd:`setenv` and :mfcmd:`unsetenv` modulefile commands do not support
+the ``--respect`` 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.