From 1454ad6f068f1d94070943b6784bc127a3119055 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Tue, 29 Aug 2017 19:39:15 +0300 Subject: [PATCH] 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. --- doc/emacs/cmdargs.texi | 8 ++++++++ doc/lispref/loading.texi | 5 +++++ etc/NEWS | 12 +++++++----- 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index 0b1a400b364..a1807ad9ddf 100644 --- 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 80dcb488983..0ab8f89a3fa 100644 --- 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 9930a3bc2c5..d2016e1352c 100644 --- 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 -- 2.39.2