GNU bug report logs - #21440
25.0.50; Manual: FEATURE-unload-hook in (info "(elisp) Coding Conventions")

Previous Next

Package: emacs;

Reported by: Michael Heerdegen <michael_heerdegen <at> web.de>

Date: Wed, 9 Sep 2015 11:44:02 UTC

Severity: minor

Found in version 25.0.50

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log


Message #23 received at 21440 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Michael Heerdegen <michael_heerdegen <at> web.de>, stefan <at> marxist.se,
 21440 <at> debbugs.gnu.org, michael.albinus <at> gmx.de
Subject: Re: bug#21440: 25.0.50; Manual: FEATURE-unload-hook in (info
 "(elisp) Coding Conventions")
Date: Mon, 12 Jul 2021 14:05:13 +0200
Eli Zaretskii <eliz <at> gnu.org> writes:

>> At least now (docstring of `unload-feature'):
>> 
>> | If a function `FEATURE-unload-function' is defined, this function
>> | calls it with no arguments, before doing anything else.  That function
>> | can do whatever is appropriate to undo the loading of the library.  If
>> | `FEATURE-unload-function' returns non-nil, that suppresses the
>> | standard unloading of the library.  Otherwise the standard unloading
>> | proceeds.
>> 
>> So it can now be controlled whether standard unloading stuff will still
>> be performed (last problem mentioned in my report -> solved).

Ah, right.

>> This questionable paragraph is sill in the manual however:
>> 
>>    • If loading the file adds functions to hooks, define a function
>>      ‘FEATURE-unload-function’, where FEATURE is the name of the feature
>>      the package provides, and make it undo any such changes.  Using
>>      ‘unload-feature’ to unload the file will run this function.  *Note
>>      Unloading::.
>> 
>> I guess it is a bit outdated and this had been automated long ago,
>> although partially heuristically.
>
> I don't understand why you say this is outdated.  What did I miss?
>
>> Instead it could say what typical non-standard changes need to be
>> handled in an unload-function.
>
> Isn't that what it says?

Well, it recommends writing an unload function, although this is rarely
necessary.  So it should say something about when it's necessary.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




This bug report was last modified 3 years and 308 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.