procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document '--module-assertions'

Browse source 
* 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.
This commit is contained in:
Eli Zaretskii 2017-08-29 19:39:15 +03:00
parent 67e565fad5
commit 1454ad6f06
3 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/emacs/cmdargs.texi
View file

@ -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

5
doc/lispref/loading.texi
View file

@ -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}.

12
etc/NEWS
View file

@ -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