Skip to content

Commit 79e8064

Browse files
committed
doc: warn about MSVC x86 toolchain cmd name conflict
Fixes #589 Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 2fbb824 commit 79e8064

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

INSTALL-win.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,9 @@ a modulepath and contains few modulefile examples::
107107
Documentation of the :ref:`module(1)`, :ref:`ml(1)` and :ref:`envml(1)`
108108
commands and :ref:`modulefile(5)` syntax can be found in the ``doc`` directory
109109
in installation directory.
110+
111+
.. warning:: If both Modules and the *MSVC x86 toolchain* are installed and
112+
Modules has been initialized in the current shell session, the command
113+
``ml`` will refer to the Modules version rather than the *MSVC assembler*.
114+
To invoke the *MSVC assembler* while Modules is active, you must call it
115+
explicitly as ``ml.exe``.

NEWS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Modules 5.6.1 (not yet released)
2323
Docs.
2424
* Doc: describe how to call modulefile command from a hook procedure in
2525
:ref:`module(1)` man page. (fix issue #590)
26+
* Doc: add warning in :ref:`INSTALL-win` to mention :command:`ml` command name
27+
conflict with *MSVC x86 toolchain* ``ml.exe``. (fix issue #589)
2628

2729
.. _Furo: https://github.com/pradyunsg/furo
2830

0 commit comments

Comments
 (0)