Fix midnight-mode documentation
authorStefan Kangas <stefankangas@gmail.com>
Sat, 21 Sep 2024 00:19:53 +0000 (02:19 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Sat, 21 Sep 2024 00:22:43 +0000 (02:22 +0200)
* lisp/midnight.el (Commentary): Document that 'midnight-mode' should be
enabled using the function, instead of by merely loading the library.
In Emacs 31, doing the latter will no longer work.  (Bug#73291)

lisp/midnight.el

index bfa99d6a7a807a39f5d758b1f12ae0d0bcfd166f..3578d702f0718be04329c61f0b9c984dfb5b2f4d 100644 (file)
@@ -1,6 +1,6 @@
 ;;; midnight.el --- run something every midnight, e.g., kill old buffers  -*- lexical-binding:t -*-
 
-;; Copyright (C) 1998, 2001-2024 Free Software Foundation, Inc.
+;; Copyright (C) 1998-2024 Free Software Foundation, Inc.
 
 ;; Author: Sam Steingold <sds@gnu.org>
 ;; Created: 1998-05-18
@@ -23,7 +23,7 @@
 
 ;;; Commentary:
 
-;; To use the file, put (require 'midnight) into your .emacs.  Then, at
+;; To use the file, put (midnight-mode) into your .emacs.  Then, at
 ;; midnight, Emacs will run the normal hook `midnight-hook'.  You can
 ;; put whatever you like there, say, `calendar'; by default there is
 ;; only one function there - `clean-buffer-list'.  It will kill the