[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master dc85fff: Clarify -unload-feature in Coding Conventions

From: Lars Ingebrigtsen
Subject: master dc85fff: Clarify -unload-feature in Coding Conventions
Date: Fri, 16 Jul 2021 04:57:09 -0400 (EDT)

branch: master
commit dc85ffffc88c08742072573539f8bfae9dcbbccb
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Clarify -unload-feature in Coding Conventions
    * doc/lispref/tips.texi (Coding Conventions): Clarify when an
    unload function is useful (bug#21440).
 doc/lispref/tips.texi | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 54cafff..a35847a 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -168,11 +168,12 @@ follow the naming conventions for hooks.  @xref{Hooks}.
 @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.
 It is a bad idea to define aliases for the Emacs primitives.  Normally

reply via email to

[Prev in Thread] Current Thread [Next in Thread]