From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 25 Apr 2024 09:39:36 +0000 (+0300)
Subject: ; * etc/PROBLEMS: Document crashes due to tree-sitter ABI (bug#70438).
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b010fc026d5ff84815f00440162e343c4db8851e;p=emacs.git

; * etc/PROBLEMS: Document crashes due to tree-sitter ABI (bug#70438).

(cherry picked from commit 1cc6322e61275ad8b5056eb7dd43af6fe459aa0b)
---

diff --git a/etc/PROBLEMS b/etc/PROBLEMS
index b17a10bd4ee..27761dddf04 100644
--- a/etc/PROBLEMS
+++ b/etc/PROBLEMS
@@ -216,6 +216,28 @@ arguments you intend to pass to Emacs):
 
   $ SNAP=1 SNAP_NAME=1 SNAP_REVISION=1 emacs ...
 
+** Emacs built with tree-sitter crashes when some *-ts-mode is turned on.
+
+The crash is in many cases an abort due to run-time detection of stack
+smashing, and it happens when one of the *-ts-mode modes is turned on
+in a buffer.
+
+The reason is that the tree-sitter library changed its Application
+Binary Interface (ABI) between version 0.22.2 and 0.22.4, but did not
+increment the ABI version number.  Therefore, Emacs compiled with
+tree-sitter versions before the change will try to use the shared
+library after the change, and crash due to incompatibilities in the
+ABI.
+
+Until and unless the tree-sitter developers release a library with an
+updated ABI version, the solution is to rebuild Emacs with the actual
+library with which it will be used.  If you cannot rebuild Emacs,
+downgrade your tree-sitter library to version 0.22.2 or older.
+
+The relevant tree-sitter issue is here:
+
+  https://github.com/tree-sitter/tree-sitter/issues/3296
+
 ** Emacs crashes when you try to view a file with complex characters.
 
 One possible reason for this could be a bug in the libotf or the