Document '--module-assertions'

* doc/emacs/cmdargs.texi (Initial Options): Document the
'--module-assertions' command-line option.
* doc/lispref/loading.texi (Dynamic Modules): Add a
cross-reference to the description of '--module-assertions'.

* etc/NEWS: Update the NEWS entry for --module-assertions.

diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi
index 0b1a400b3644eef2de67461ed46ad9fb678dcb51..a1807ad9ddf18a6d20ebdf14a61a18791493d7ea 100644 (file)
--- a/doc/emacs/cmdargs.texi
+++ b/doc/emacs/cmdargs.texi
@@ -365,6 +365,14 @@ own@footnote{This option has no effect on MS-Windows.}.
 Enable the Emacs Lisp debugger for errors in the init file.
 @xref{Error Debugging,, Entering the Debugger on an Error, elisp, The
 GNU Emacs Lisp Reference Manual}.
+
+@item --module-assertions
+@opindex --module-assertions
+@cindex module verification
+Enable expensive correctness checks when dealing with dynamically
+loadable modules.  This is intended for module authors that wish to
+verify that their module conforms to the module API requirements.  The
+option makes Emacs abort if a module-related assertion triggers.
 @end table
 
 @node Command Example

diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi
index 80dcb4889830c83375ba4178a80ae290d9e92a93..0ab8f89a3faea50638894c58bd01b3a69edf0200 100644 (file)
--- a/doc/lispref/loading.texi
+++ b/doc/lispref/loading.texi
@@ -1184,3 +1184,8 @@ object.
 
 Loadable modules in Emacs are enabled by using the
 @kbd{--with-modules} option at configure time.
+
+If you write your own dynamic modules, you may wish to verify their
+conformance to the Emacs dynamic module API.  Invoking Emacs with the
+@kbd{--module-assertions} option will help you in this matter.
+@xref{Initial Options,,,emacs, The GNU Emacs Manual}.

diff --git a/etc/NEWS b/etc/NEWS
index 9930a3bc2c5479a32979870fbe7b275c31accf97..d2016e1352cafdd3df46763d59bf62d02adba89b 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -87,11 +87,13 @@ modern init systems such as systemd, which manage many of the traditional
 aspects of daemon behavior themselves.  '--bg-daemon' is now an alias
 for '--daemon'.
 
-** New option '--module-assertions'.  If the user supplies this
-option, Emacs will perform expensive correctness checks when dealing
-with dynamic modules.  This is intended for module authors that wish
-to verify that their module conforms to the module requirements.  The
-option makes Emacs abort if a module-related assertion triggers.
++++
+** New option '--module-assertions'.
+When given this option, Emacs will perform expensive correctness
+checks when dealing with dynamic modules.  This is intended for module
+authors that wish to verify that their module conforms to the module
+requirements.  The option makes Emacs abort if a module-related
+assertion triggers.
 
 +++
 ** Emacs now supports 24-bit colors on capable text terminals