[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/compat d3142f3f04 2/3: Elaborate the "Usage" section of
From: |
ELPA Syncer |
Subject: |
[elpa] externals/compat d3142f3f04 2/3: Elaborate the "Usage" section of the manual |
Date: |
Wed, 24 Aug 2022 12:57:40 -0400 (EDT) |
branch: externals/compat
commit d3142f3f04425e27eceb9ce2a68c14ae9f14c331
Author: Philip Kaludercic <philipk@posteo.net>
Commit: Philip Kaludercic <philipk@posteo.net>
Elaborate the "Usage" section of the manual
---
compat.texi | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/compat.texi b/compat.texi
index 37437b0750..9d14a08379 100644
--- a/compat.texi
+++ b/compat.texi
@@ -126,13 +126,17 @@ as a dependency in the header:
;; Package-Requires: ((emacs "24.3") (compat "28.1.2.0"))
@end example
+There is no need to depend on @code{emacs} 24.3 specifically. One can
+choose to any newer version, if features not provided by Compat
+necessitate it.
-and later on a
+In any file where compatibility forms are used, a
@example
(require 'compat)
@end example
+should be added early on.
This will load all non-prefixed definitions (functions and macros with a
leading `compat-`). To load these, an additional
@@ -141,7 +145,6 @@ leading `compat-`). To load these, an additional
(require 'compat-XY) ; e.g. 26
@end example
-
will be necessary, to load compatibility code for Emacs version XY@.
It is recommended to subscribe to the