From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 8 Jun 2018 15:06:34 +0000 (+0300)
Subject: Clarify subtle issues with 'eq' in byte-compiled code
X-Git-Tag: emacs-26.1.90~380
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ef35d405b1;p=emacs.git

Clarify subtle issues with 'eq' in byte-compiled code

* doc/lispref/objects.texi (Equality Predicates): Explain why
byte-compiled code might compare literal objects with identical
contents as 'eq'.  (Bug#31688)
---

diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi
index af740625adb..c7e751cbd8c 100644
--- a/doc/lispref/objects.texi
+++ b/doc/lispref/objects.texi
@@ -2144,6 +2144,21 @@ Symbols}.
      @result{} nil
 @end group
 @end example
+
+@noindent
+@cindex identical-contents objects, and byte-compiler
+@cindex objects with identical contents, and byte-compiler
+The Emacs Lisp byte compiler may collapse identical literal objects,
+such as literal strings, into references to the same object, with the
+effect that the byte-compiled code will compare such objects as
+@code{eq}, while the interpreted version of the same code will not.
+Therefore, your code should never rely on objects with the same
+literal contents being either @code{eq} or not @code{eq}, it should
+instead use functions that compare object contents such as
+@code{equal}, described below.  Similarly, your code should not modify
+literal objects (e.g., put text properties on literal strings), since
+doing that might affect other literal objects of the same contents, if
+the byte compiler collapses them.
 @end defun
 
 @defun equal object1 object2