doc: no auto path resolution on {prepend,append,remove}-path

Fixes #597

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

Author: xdelaruelle

NEWS.rst

@@ -27,6 +27,9 @@ Modules 5.6.1 (not yet released)
   conflict with *MSVC x86 toolchain* ``ml.exe``. (fix issue #589)
 * Doc: add :ref:`maintainer-guide`.
 * Doc: website is now located at https://envmodules.io.
+* Doc: precise that no automatic path resolution is performed on
+  :mfcmd:`prepend-path`, :mfcmd:`append-path` or :mfcmd:`remove-path`
+  modulefile commands. (fix issue #597)
 
 .. _Furo: https://github.com/pradyunsg/furo
 

doc/source/modulefile.rst

@@ -1182,6 +1182,13 @@ the *modulefile* is being loaded.
  If *value* corresponds to the concatenation of multiple elements separated by
  colon, or *delimiter*, character, each element is treated separately.
 
+ The provided *value* is used as-is. If any path resolution is required, it
+ must be performed within the *modulefile* itself. Use caution when including
+ characters with special meanings in the shell context (such as ``~``), as the
+ shell may expand these paths automatically. This can prevent the
+ corresponding entries from being properly removed when the *modulefile* is
+ unloaded.
+
  If the *variable* is :envvar:`MODULEPATH` and :mconfig:`require_via`
  configuration option is activated, the *modulefile* is considered a
  dependency by the loaded modulefiles stored in the added modulepaths.