[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
emacs-29 7c417b2ae55 03/10: Correct the Eshell documentation about how t
From: |
Jim Porter |
Subject: |
emacs-29 7c417b2ae55 03/10: Correct the Eshell documentation about how to write new modules |
Date: |
Thu, 13 Jul 2023 22:25:20 -0400 (EDT) |
branch: emacs-29
commit 7c417b2ae555c8b07c4eb440a2c798826842c636
Author: Jim Porter <jporterbugs@gmail.com>
Commit: Jim Porter <jporterbugs@gmail.com>
Correct the Eshell documentation about how to write new modules
* doc/misc/eshell.texi (Writing a module): Fix the documentation.
'eshell-defgroup' doesn't exist anymore.
Do not merge to master. This is a backport of 77f13edab0f.
---
doc/misc/eshell.texi | 30 +++++++++++++++++-------------
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi
index 44eb438cfd9..cff7c594d96 100644
--- a/doc/misc/eshell.texi
+++ b/doc/misc/eshell.texi
@@ -2045,23 +2045,27 @@ This section is not yet written.
@node Writing a module
@section Writing a module
-An Eshell module is defined the same as any other library but one requirement:
the
-module must define a Customize@footnote{@xref{Customization, , ,
-elisp, The Emacs Lisp Reference Manual}.}
-group using @code{eshell-defgroup} (in place of @code{defgroup}) with
-@code{eshell-module} as the parent group.@footnote{If the module has
-no user-customizable options, then there is no need to define it as an
-Eshell module.} You also need to load the following as shown:
+An Eshell module is defined the same as any other library but with two
+additional requirements: first, the module's source file should be
+named @file{em-@var{name}.el}; second, the module must define an
+autoloaded Customize group (@pxref{Customization, , , elisp, The Emacs
+Lisp Reference Manual}) with @code{eshell-module} as the parent group.
+In order to properly autoload this group, you should wrap its
+definition with @code{progn} as follows:
@example
-(eval-when-compile
- (require 'cl-lib)
- (require 'esh-mode)
- (require 'eshell))
-
-(require 'esh-util)
+;;;###autoload
+(progn
+(defgroup eshell-my-module nil
+ "My module lets you do very cool things in Eshell."
+ :tag "My module"
+ :group 'eshell-module))
@end example
+Even if you don't have any Customize options in your module, you
+should still define the group so that Eshell can include your module
+in the Customize interface for @code{eshell-modules-list}.
+
@node Bugs and ideas
@chapter Bugs and ideas
@cindex reporting bugs and ideas
- emacs-29 updated (7ac947f34c7 -> 6a360b08405), Jim Porter, 2023/07/13
- emacs-29 4e204b56186 01/10: ; * doc/misc/eshell.texi (Bugs and ideas): Remove implemented feature., Jim Porter, 2023/07/13
- emacs-29 6c3fe42bde1 02/10: Restructure Eshell extension modules documentation, Jim Porter, 2023/07/13
- emacs-29 6a360b08405 10/10: ; * doc/misc/eshell.texi (Variables): Add missing index for $INSIDE_EMACS, Jim Porter, 2023/07/13
- emacs-29 7640835ae03 07/10: ; * doc/misc/eshell.texi: Fix last change., Jim Porter, 2023/07/13
- emacs-29 3a703545798 08/10: Add documentation about remote access in Eshell, Jim Porter, 2023/07/13
- emacs-29 951671b0e10 04/10: Document optional Eshell modules, Jim Porter, 2023/07/13
- emacs-29 e79306fb467 06/10: ; * doc/misc/eshell.texi: Fix typos and clean up unclear wording., Jim Porter, 2023/07/13
- emacs-29 f529bf52eb5 09/10: ; * doc/misc/eshell.texi (Invocation): Whitespace cleanup., Jim Porter, 2023/07/13
- emacs-29 9f6d79dd967 05/10: Document some missing Eshell commands, Jim Porter, 2023/07/13
- emacs-29 7c417b2ae55 03/10: Correct the Eshell documentation about how to write new modules,
Jim Porter <=