From: Eshel Yaron <me@eshelyaron.com>
Date: Sun, 8 Jan 2023 14:39:11 +0000 (+0200)
Subject: DOC: explain how to follow source locations in top-level messages
X-Git-Tag: V9.1.3^0
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=027f7e9a64a353db3438beab0a160dc8e644a481;p=dict.git

DOC: explain how to follow source locations in top-level messages
---

diff --git a/README.org b/README.org
index ccbb0ee..e94587a 100644
--- a/README.org
+++ b/README.org
@@ -1345,7 +1345,7 @@ C-s _ -> _ ; _ RET~.
 While prompting for a search term in the minibuffer, this command
 populates the "future history" with the Prolog terms at point, with
 the most nested term at point on top.  Typing ~M-n~ once in the
-minibuffer fills it the innermost term at point, typing ~M-n~ again
+minibuffer fills in the innermost term at point, typing ~M-n~ again
 cycles up the syntax tree at point filling the minibuffer with larger
 terms, up until the top-term at point.  For more information about
 minibuffer history commands, see [[info:emacs#Minibuffer History][Minibuffer History]] in the Emacs
@@ -1570,6 +1570,35 @@ provide completion for predicate names.  To complete a partial
 predicate name in the top-level prompt, use =C-M-i= (or =M-TAB=).  For
 more information see [[info:emacs#Symbol Completion][Symbol Completion in the Emacs manual]].
 
+** Following Error Messages
+:PROPERTIES:
+:CUSTOM_ID: top-level-compilation-shell-minor-mode
+:DESCRIPTION: Minor mode for visiting source locations in printed messages
+:ALT_TITLE: Follow Messages
+:END:
+
+Many standard SWI-Prolog facilities generate messages that refer to
+specific source code locations.  For example, loading a Prolog file
+that contains singleton variables into the top-level will produce
+warning messages pointing to the starting line of the clauses where
+the singleton variables occur.  If you enable
+~compilation-shell-minor-mode~ in the top-level buffer, Emacs recognizes
+the Prolog messages that refer to source locations and provides
+convenient commands for visiting such source locations from the
+top-level buffer.  For more information about
+~compilation-shell-minor-mode~, see [[info:emacs#Compilation Mode][Compilation Mode]] in the Emacs
+manual.
+
+To use ~compilation-shell-minor-mode~ automatically in all top-level
+buffers, you can arrange for it to be enabled as part of the
+~sweeprolog-top-level-mode~ hook, as follows:
+
+#+begin_src emacs-lisp
+  (add-hook 'sweeprolog-top-level-mode-hook
+            #'compilation-shell-minor-mode)
+
+#+end_src
+
 * Finding Prolog code
 :PROPERTIES:
 :CUSTOM_ID: finding-prolog-code