doc: mention rc files are not for module config

cea-hpc · Apr 9, 2022 · 35e2ade · 35e2ade
1 parent 0eeb35c
commit 35e2ade
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/INSTALL.rst b/INSTALL.rst
@@ -259,6 +259,9 @@ achieve a specific setup, some additional steps may be required:
    aliases, virtual modules or module properties such as tags, forbidding
    rules, etc.
 
+   .. note:: Run-command files are intended to set parameters for
+      modulefiles, not to configure the :command:`module` command itself.
+
 To learn more about siteconfig and run-command files, see the
 :ref:`Modulecmd startup` section in :ref:`module(1)` reference manual. You may
 also look at the available :ref:`setup recipes<cookbook>` to get concrete

diff --git a/doc/source/module.rst b/doc/source/module.rst
@@ -165,6 +165,9 @@ error does not abort the whole :command:`module` evaluation. If the
 :mconfig:`mcookie_version_check` configuration is disabled the version number
 set is not checked.
 
+.. note:: Run-command files are intended to set parameters for modulefiles,
+   not to configure the :command:`module` command itself.
+
 Command line switches
 ^^^^^^^^^^^^^^^^^^^^^