branch: externals/compat
commit 0a67a87216939614564747f2a2eb61eb4122464b
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update manual
---
compat.el | 10 ++++++----
compat.texi | 14 ++++++++------
2 files changed, 14 insertions(+), 10 deletions(-)
diff --git a/compat.el b/compat.el
index 93b404e7df..c163c65394 100644
--- a/compat.el
+++ b/compat.el
@@ -26,10 +26,12 @@
;; To allow for the usage of Emacs functions and macros that are
;; defined in newer versions of Emacs, compat.el provides definitions
-;; that are installed ONLY if necessary. These reimplementations of
-;; functions and macros are at least subsets of the actual
-;; implementations. Be sure to read the documentation string to make
-;; sure.
+;; that are installed ONLY if necessary. If Compat is installed on a
+;; recent version of Emacs, all of the definitions are disabled at
+;; compile time, such that no negative performance impact is incurred.
+;; These reimplementations of functions and macros are at least
+;; subsets of the actual implementations. Be sure to read the
+;; documentation string to make sure.
;;
;; Not every function provided in newer versions of Emacs is provided
;; here. Some depend on new features from the core, others cannot be
diff --git a/compat.texi b/compat.texi
index c5f38bf495..476b5a8047 100644
--- a/compat.texi
+++ b/compat.texi
@@ -135,12 +135,14 @@ the noerror flag should be specified.
(require 'compat nil 'noerror)
@end example
-This will load all implicit and explicit Compat definitions. Functions
-and macros where the calling convention or behavior has changed can be
-accessed explicitly via @code{compat-function} and
-@code{compat-call}. We call these definitions ``Explicit
-Definitions''. In contrast, ``Implicit Definitions'' can be called as
-usual.
+This will load all implicit and explicit Compat definitions. Note
+that if Compat is installed on a recent version of Emacs, all of the
+definitions are disabled at compile time, such that no negative
+performance impact is incurred. Functions and macros where the
+calling convention or behavior has changed can be accessed explicitly
+via @code{compat-function} and @code{compat-call}. We call these
+definitions ``Explicit Definitions''. In contrast, ``Implicit
+Definitions'' can be called as usual.
@example
(compat-call assoc KEY ALIST TESTFN) ;; Explicit
