[Emacs-diffs] emacs-26 5a5ad99d: Improve documentation of debugging Lisp syntax error

[Eli Zaretskii]

branch: emacs-26
commit 5a5ad99d2f5abc431e269e4f591fdabad9d59e70
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Improve documentation of debugging Lisp syntax error
    
    * doc/lispref/debugging.texi (Syntax Errors, Excess Open)
    (Excess Close): Name the commands invoked by the key
    sequences.  Add cross-references to appropriate sections of
    the Emacs manual.  (Bug#21385)
    
    (cherry picked from commit faafd467a374c9398ee4668cdc173611d35693ed)
---
 doc/lispref/debugging.texi | 45 ++++++++++++++++++++++++++-------------------
 1 file changed, 26 insertions(+), 19 deletions(-)

diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 2576fbe..575ec75 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -796,9 +796,10 @@ parenthesis or missing open parenthesis, but does not say 
where the
 missing parenthesis belongs.  How, then, to find what to change?
 
   If the problem is not simply an imbalance of parentheses, a useful
-technique is to try @kbd{C-M-e} at the beginning of each defun, and see
-if it goes to the place where that defun appears to end.  If it does
-not, there is a problem in that defun.
+technique is to try @kbd{C-M-e} (@code{end-of-defun}, @pxref{Moving by
+Defuns,,,emacs, The GNU Emacs Manual}) at the beginning of each defun,
+and see if it goes to the place where that defun appears to end.  If
+it does not, there is a problem in that defun.
 
 @cindex unbalanced parentheses
 @cindex parenthesis mismatch, debugging
@@ -818,29 +819,32 @@ find the mismatch.)
 
   The first step is to find the defun that is unbalanced.  If there is
 an excess open parenthesis, the way to do this is to go to the end of
-the file and type @kbd{C-u C-M-u}.  This will move you to the
-beginning of the first defun that is unbalanced.
+the file and type @kbd{C-u C-M-u} (@code{backward-up-list},
+@pxref{Moving by Parens,,,emacs, The GNU Emacs Manual}).  This will
+move you to the beginning of the first defun that is unbalanced.
 
   The next step is to determine precisely what is wrong.  There is no
 way to be sure of this except by studying the program, but often the
 existing indentation is a clue to where the parentheses should have
 been.  The easiest way to use this clue is to reindent with @kbd{C-M-q}
-and see what moves.  @strong{But don't do this yet!}  Keep reading,
-first.
+(@code{indent-pp-sexp}, @pxref{Multi-line Indent,,,emacs, The GNU
+Emacs Manual}) and see what moves.  @strong{But don't do this yet!}
+Keep reading, first.
 
   Before you do this, make sure the defun has enough close parentheses.
 Otherwise, @kbd{C-M-q} will get an error, or will reindent all the rest
 of the file until the end.  So move to the end of the defun and insert a
-close parenthesis there.  Don't use @kbd{C-M-e} to move there, since
-that too will fail to work until the defun is balanced.
+close parenthesis there.  Don't use @kbd{C-M-e} (@code{end-of-defun}) to
+move there, since that too will fail to work until the defun is balanced.
 
   Now you can go to the beginning of the defun and type @kbd{C-M-q}.
 Usually all the lines from a certain point to the end of the function
 will shift to the right.  There is probably a missing close parenthesis,
 or a superfluous open parenthesis, near that point.  (However, don't
 assume this is true; study the code to make sure.)  Once you have found
-the discrepancy, undo the @kbd{C-M-q} with @kbd{C-_}, since the old
-indentation is probably appropriate to the intended parentheses.
+the discrepancy, undo the @kbd{C-M-q} with @kbd{C-_} (@code{undo}),
+since the old indentation is probably appropriate to the intended
+parentheses.
 
   After you think you have fixed the problem, use @kbd{C-M-q} again.  If
 the old indentation actually fit the intended nesting of parentheses,
@@ -852,21 +856,24 @@ anything.
 @cindex excess close parentheses
 
   To deal with an excess close parenthesis, first go to the beginning
-of the file, then type @kbd{C-u -1 C-M-u} to find the end of the first
-unbalanced defun.
+of the file, then type @kbd{C-u -1 C-M-u} (@code{backward-up-list}
+with an argument of @minus{}1) to find the end of the first unbalanced
+defun.
 
   Then find the actual matching close parenthesis by typing @kbd{C-M-f}
+(@code{forward-sexp}, @pxref{Expressions,,,emacs, The GNU Emacs Manual})
 at the beginning of that defun.  This will leave you somewhere short of
 the place where the defun ought to end.  It is possible that you will
 find a spurious close parenthesis in that vicinity.
 
   If you don't see a problem at that point, the next thing to do is to
-type @kbd{C-M-q} at the beginning of the defun.  A range of lines will
-probably shift left; if so, the missing open parenthesis or spurious
-close parenthesis is probably near the first of those lines.  (However,
-don't assume this is true; study the code to make sure.)  Once you have
-found the discrepancy, undo the @kbd{C-M-q} with @kbd{C-_}, since the
-old indentation is probably appropriate to the intended parentheses.
+type @kbd{C-M-q} (@code{indent-pp-sexp}) at the beginning of the defun.
+A range of lines will probably shift left; if so, the missing open
+parenthesis or spurious close parenthesis is probably near the first of
+those lines.  (However, don't assume this is true; study the code to
+make sure.)  Once you have found the discrepancy, undo the @kbd{C-M-q}
+with @kbd{C-_} (@code{undo}), since the old indentation is probably
+appropriate to the intended parentheses.
 
   After you think you have fixed the problem, use @kbd{C-M-q} again.  If
 the old indentation actually fits the intended nesting of parentheses,