aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorF. Jason Park2024-01-05 07:20:34 -0800
committerF. Jason Park2024-01-07 15:11:26 -0800
commit50f430ebcd87b77207013f97e6e5d1b8fe93f990 (patch)
treed294497a2a37a760f546299f0398b4dc5602dba0 /doc/misc
parent37e87bc3eeb8e62e2900d73cf4dd9fc9e942d66d (diff)
downloademacs-50f430ebcd87b77207013f97e6e5d1b8fe93f990.tar.gz
emacs-50f430ebcd87b77207013f97e6e5d1b8fe93f990.zip
Clarify purpose of module aliases in ERC
* doc/misc/erc.texi: Mention that aliases should not be defined for new modules. * lisp/erc/erc-common.el (define-erc-module): Refactor slightly for readability. (erc-with-all-buffers-of-server): Redo doc string. * lisp/erc/erc-pcomplete.el: Declare `completion' module's feature and group as being `erc-pcomplete'. * test/lisp/erc/erc-tests.el (erc--find-group--real): Assert group lookup works for "normalized" module name `completion' of `erc-pcomplete-mode'.
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/erc.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi
index 52c7477c9dd..f877fb681fe 100644
--- a/doc/misc/erc.texi
+++ b/doc/misc/erc.texi
@@ -678,6 +678,14 @@ signals an error. Users defining personal modules in an init file
678should @code{(provide 'erc-my-module)} somewhere to placate ERC. 678should @code{(provide 'erc-my-module)} somewhere to placate ERC.
679Dynamically generating modules on the fly is not supported. 679Dynamically generating modules on the fly is not supported.
680 680
681Some older built-in modules have a second name along with a second
682minor-mode toggle, which is just a function alias for its primary
683counterpart. For practical reasons, ERC does not define a
684corresponding variable alias because contending with indirect
685variables complicates bookkeeping tasks, such as persisting module
686state across IRC sessions. New modules should definitely avoid
687defining aliases without a good reason.
688
681Some packages have been known to autoload a module's definition 689Some packages have been known to autoload a module's definition
682instead of its minor-mode command, which severs the link between the 690instead of its minor-mode command, which severs the link between the
683library and the module. This means that enabling the mode by invoking 691library and the module. This means that enabling the mode by invoking