]> git.eshelyaron.com Git - emacs.git/commitdiff
Don't recommend using 'module-load' for loading modules.
authorPhilipp Stephani <phst@google.com>
Thu, 26 Dec 2019 10:08:56 +0000 (11:08 +0100)
committerPhilipp Stephani <phst@google.com>
Thu, 26 Dec 2019 10:08:56 +0000 (11:08 +0100)
'module-load' most likely doesn't do what users expect.  Users should
use 'load' and its wrappers, which do the right thing.

* doc/lispref/loading.texi (Dynamic Modules): Document
disadvantages of 'module-load' and recommend normal 'load' and
its wrappers instead.

* doc/lispref/internals.texi (Module Functions): Recommend
'load' over 'module-load'.

doc/lispref/internals.texi
doc/lispref/loading.texi

index bccdca65e4e1a8c0196c84d4741ba119b77d5e86..c7b9e7286b35af147822823a346eccdd6e327a42 100644 (file)
@@ -1423,8 +1423,8 @@ following simple Lisp wrapper:
 @end lisp
 
 The Lisp package which goes with your module could then load the
-module using the @code{module-load} primitive (@pxref{Dynamic
-Modules}) when the package is loaded into Emacs.
+module using the @code{load} primitive (@pxref{Dynamic Modules}) when
+the package is loaded into Emacs.
 
 @node Module Values
 @subsection Conversion Between Lisp and Module Values
index 3261e6d188837e64f16b7fde4a4f8dfe06e4c514..3ba5fea4ca6e7dc47f5af5b0c2896f048a18d70e 100644 (file)
@@ -1217,6 +1217,12 @@ during the initialization.  If the initialization succeeds,
 @code{module-load} returns @code{t}.  Note that @var{file} must
 already have the proper file-name extension, as this function doesn't
 try looking for files with known extensions, unlike @code{load}.
+
+Unlike @code{load}, @code{module-load} doesn't record the module in
+@code{load-history}, doesn't print any messages, and doesn't protect
+against recursive loads.  Most users should therefore use @code{load},
+@code{load-file}, @code{load-library}, or @code{require} instead of
+@code{module-load}.
 @end defun
 
 Loadable modules in Emacs are enabled by using the