aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGemini Lasswell2018-08-01 07:47:12 -0700
committerGemini Lasswell2018-08-03 08:54:08 -0700
commit95b2ab3dccdc756614b4c8f45a7b206d61753705 (patch)
treef3fd4b5256aa6c6786d0ac4f80fb1d87dcc2e401
parent58be6cb6bbb2cc7b1c35c0fc30b6f4f9b111eb77 (diff)
downloademacs-95b2ab3dccdc756614b4c8f45a7b206d61753705.tar.gz
emacs-95b2ab3dccdc756614b4c8f45a7b206d61753705.zip
Fix some documentation formatting nits
* doc/misc/ert.texi (Running Tests Interactively): Correct Elisp manual titile in xref. * doc/lispref/edebug.texi (Edebug Misc): Use single argument form of xref. * doc/lispref/debugging.texi (Backtraces): Add comma and period after xref braces. (Backtraces): Correct Emacs manual title. (Internals of Debugger): Add a space before period.
-rw-r--r--doc/lispref/debugging.texi10
-rw-r--r--doc/lispref/edebug.texi2
-rw-r--r--doc/misc/ert.texi2
-rw-r--r--etc/NEWS12
4 files changed, 13 insertions, 13 deletions
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 841b16eaf95..9b3ba6cf7ee 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -402,8 +402,8 @@ assumptions are false if the debugger is running interpreted.
402@cindex backtrace buffer 402@cindex backtrace buffer
403 403
404Debugger mode is derived from Backtrace mode, which is also used to 404Debugger mode is derived from Backtrace mode, which is also used to
405show backtraces by Edebug and ERT. (@pxref{Edebug} and @ref{Top,the 405show backtraces by Edebug and ERT. (@pxref{Edebug}, and @ref{Top,the
406ERT manual,, ert, ERT: Emacs Lisp Regression Testing}) 406ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.)
407 407
408@cindex stack frame 408@cindex stack frame
409The backtrace buffer shows you the functions that are executing and 409The backtrace buffer shows you the functions that are executing and
@@ -423,9 +423,9 @@ source code is located. You can click with the mouse on that name, or
423move to it and type @key{RET}, to visit the source code. You can also 423move to it and type @key{RET}, to visit the source code. You can also
424type @key{RET} while point is on any name of a function or variable 424type @key{RET} while point is on any name of a function or variable
425which is not underlined, to see help information for that symbol in a 425which is not underlined, to see help information for that symbol in a
426help buffer, if any exists. The @code{xref-find-definitions} command, 426help buffer, if any exists. The @code{xref-find-definitions} command,
427bound to @key{M-.}, can also be used on any identifier in a backtrace 427bound to @key{M-.}, can also be used on any identifier in a backtrace
428(@pxref{Looking Up Identifiers,,,emacs,Emacs manual}). 428(@pxref{Looking Up Identifiers,,,emacs, The GNU Emacs Manual}).
429 429
430In backtraces, the tails of long lists and the ends of long strings, 430In backtraces, the tails of long lists and the ends of long strings,
431vectors or structures, as well as objects which are deeply nested, 431vectors or structures, as well as objects which are deeply nested,
@@ -690,7 +690,7 @@ Each line of the backtrace represents one function call. The line
690shows the function followed by a list of the values of the function's 690shows the function followed by a list of the values of the function's
691arguments if they are all known; if they are still being computed, the 691arguments if they are all known; if they are still being computed, the
692line consists of a list containing the function and its unevaluated 692line consists of a list containing the function and its unevaluated
693arguments. Long lists or deeply nested structures may be elided. 693arguments. Long lists or deeply nested structures may be elided.
694 694
695@smallexample 695@smallexample
696@group 696@group
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi
index 59c9a68c54b..54200b99903 100644
--- a/doc/lispref/edebug.texi
+++ b/doc/lispref/edebug.texi
@@ -442,7 +442,7 @@ Redisplay the most recently known expression result in the echo area
442Display a backtrace, excluding Edebug's own functions for clarity 442Display a backtrace, excluding Edebug's own functions for clarity
443(@code{edebug-backtrace}). 443(@code{edebug-backtrace}).
444 444
445@xref{Debugging,, Backtraces, elisp}, for a description of backtraces 445@xref{Backtraces}, for a description of backtraces
446and the commands which work on them. 446and the commands which work on them.
447 447
448If you would like to see Edebug's functions in the backtrace, 448If you would like to see Edebug's functions in the backtrace,
diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi
index e2aeeb1353a..6a34f5c5722 100644
--- a/doc/misc/ert.texi
+++ b/doc/misc/ert.texi
@@ -276,7 +276,7 @@ Pressing @kbd{r} re-runs the test near point on its own. Pressing
276definition of the test near point (@kbd{@key{RET}} has the same effect 276definition of the test near point (@kbd{@key{RET}} has the same effect
277if point is on the name of the test). On a failed test, @kbd{b} shows 277if point is on the name of the test). On a failed test, @kbd{b} shows
278the backtrace of the failure. @xref{Debugging,, Backtraces, elisp, 278the backtrace of the failure. @xref{Debugging,, Backtraces, elisp,
279the Emacs Lisp Reference Manual}, for more information about 279GNU Emacs Lisp Reference Manual}, for more information about
280backtraces. 280backtraces.
281 281
282@kindex l@r{, in ert results buffer} 282@kindex l@r{, in ert results buffer}
diff --git a/etc/NEWS b/etc/NEWS
index 53b77656278..9c78bd5a05d 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -471,7 +471,7 @@ and case-sensitivity together with search strings in the search ring.
471+++ 471+++
472*** The Lisp Debugger is now based on 'backtrace-mode'. 472*** The Lisp Debugger is now based on 'backtrace-mode'.
473Backtrace mode adds fontification and commands for changing the 473Backtrace mode adds fontification and commands for changing the
474appearance of backtrace frames. See the node "Backtraces" in the Elisp 474appearance of backtrace frames. See the node "Backtraces" in the Elisp
475manual for documentation of the new mode and its commands. 475manual for documentation of the new mode and its commands.
476 476
477** Edebug 477** Edebug
@@ -484,9 +484,9 @@ using the new variables 'edebug-behavior-alist',
484globally or for individual definitions. 484globally or for individual definitions.
485 485
486+++ 486+++
487*** Edebug's backtrace buffer now uses 'backtrace-mode'. Backtrace 487*** Edebug's backtrace buffer now uses 'backtrace-mode'.
488mode adds fontification, links and commands for changing the 488Backtrace mode adds fontification, links and commands for changing the
489appearance of backtrace frames. See the node "Backtraces" in the Elisp 489appearance of backtrace frames. See the node "Backtraces" in the Elisp
490manual for documentation of the new mode and its commands. 490manual for documentation of the new mode and its commands.
491 491
492The binding of 'd' in Edebug's keymap is now 'edebug-pop-to-backtrace' 492The binding of 'd' in Edebug's keymap is now 'edebug-pop-to-backtrace'
@@ -523,7 +523,7 @@ less verbose by removing non-essential information.
523+++ 523+++
524*** ERT's backtrace buffer now uses 'backtrace-mode'. 524*** ERT's backtrace buffer now uses 'backtrace-mode'.
525Backtrace mode adds fontification and commands for changing the 525Backtrace mode adds fontification and commands for changing the
526appearance of backtrace frames. See the node "Backtraces" in the Elisp 526appearance of backtrace frames. See the node "Backtraces" in the Elisp
527manual for documentation of the new mode and its commands. 527manual for documentation of the new mode and its commands.
528 528
529** Gamegrid 529** Gamegrid
@@ -702,7 +702,7 @@ used by the Language Server Protocol (LSP), is readily available.
702** Backtrace mode improves viewing of Elisp backtraces. 702** Backtrace mode improves viewing of Elisp backtraces.
703Backtrace mode adds pretty printing, fontification and ellipsis 703Backtrace mode adds pretty printing, fontification and ellipsis
704expansion to backtrace buffers produced by the Lisp debugger, Edebug 704expansion to backtrace buffers produced by the Lisp debugger, Edebug
705and ERT. See the node "Backtraces" in the Elisp manual for 705and ERT. See the node "Backtraces" in the Elisp manual for
706documentation of the new mode and its commands. 706documentation of the new mode and its commands.
707 707
708 708