]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify -unload-feature in Coding Conventions
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 16 Jul 2021 08:56:21 +0000 (10:56 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 16 Jul 2021 08:56:21 +0000 (10:56 +0200)
* doc/lispref/tips.texi (Coding Conventions): Clarify when an
unload function is useful (bug#21440).

doc/lispref/tips.texi

index 54cafffab38087a8fec6597123fcb52ded9769cf..a35847a74db1c535bb8563753eeefa5a56f6a864 100644 (file)
@@ -168,11 +168,12 @@ follow the naming conventions for hooks.  @xref{Hooks}.
 
 @item
 @cindex unloading packages, preparing for
-If loading the file adds functions to hooks, define a function
-@code{@var{feature}-unload-function}, where @var{feature} is the name
-of the feature the package provides, and make it undo any such
-changes.  Using @code{unload-feature} to unload the file will run this
-function.  @xref{Unloading}.
+@code{unload-feature} will normally undo normal changes done by
+loading a feature (like adding adds functions to hooks).  However, if
+loading @var{feature} does something more complex, define a function
+@code{@var{feature}-unload-function}, and make it undo any such
+changes.  @code{unload-feature} will run this function.
+@xref{Unloading}.
 
 @item
 It is a bad idea to define aliases for the Emacs primitives.  Normally