procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix some documentation formatting nits

Browse source 
* 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.
This commit is contained in:
Gemini Lasswell 2018-08-01 07:47:12 -07:00
parent 58be6cb6bb
commit 95b2ab3dcc
4 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/lispref/debugging.texi
View file

@ -402,8 +402,8 @@ assumptions are false if the debugger is running interpreted.
@cindex backtrace buffer
Debugger mode is derived from Backtrace mode, which is also used to
show backtraces by Edebug and ERT. (@pxref{Edebug} and @ref{Top,the
ERT manual,, ert, ERT: Emacs Lisp Regression Testing})
show backtraces by Edebug and ERT. (@pxref{Edebug}, and @ref{Top,the
ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.)
@cindex stack frame
The 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
move to it and type @key{RET}, to visit the source code. You can also
type @key{RET} while point is on any name of a function or variable
which is not underlined, to see help information for that symbol in a
help buffer, if any exists. The @code{xref-find-definitions} command,
help buffer, if any exists. The @code{xref-find-definitions} command,
bound to @key{M-.}, can also be used on any identifier in a backtrace
(@pxref{Looking Up Identifiers,,,emacs,Emacs manual}).
(@pxref{Looking Up Identifiers,,,emacs, The GNU Emacs Manual}).
In backtraces, the tails of long lists and the ends of long strings,
vectors 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
shows the function followed by a list of the values of the function's
arguments if they are all known; if they are still being computed, the
line consists of a list containing the function and its unevaluated
arguments. Long lists or deeply nested structures may be elided.
arguments. Long lists or deeply nested structures may be elided.
@smallexample
@group

2
doc/lispref/edebug.texi
View file

@ -442,7 +442,7 @@ Redisplay the most recently known expression result in the echo area
Display a backtrace, excluding Edebug's own functions for clarity
(@code{edebug-backtrace}).
@xref{Debugging,, Backtraces, elisp}, for a description of backtraces
@xref{Backtraces}, for a description of backtraces
and the commands which work on them.
If you would like to see Edebug's functions in the backtrace,

2
doc/misc/ert.texi
View file

@ -276,7 +276,7 @@ Pressing @kbd{r} re-runs the test near point on its own. Pressing
definition of the test near point (@kbd{@key{RET}} has the same effect
if point is on the name of the test). On a failed test, @kbd{b} shows
the backtrace of the failure. @xref{Debugging,, Backtraces, elisp,
the Emacs Lisp Reference Manual}, for more information about
GNU Emacs Lisp Reference Manual}, for more information about
backtraces.
@kindex l@r{, in ert results buffer}

12
etc/NEWS
View file

@ -471,7 +471,7 @@ and case-sensitivity together with search strings in the search ring.
+++
*** The Lisp Debugger is now based on 'backtrace-mode'.
Backtrace mode adds fontification and commands for changing the
appearance of backtrace frames. See the node "Backtraces" in the Elisp
appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
** Edebug
@ -484,9 +484,9 @@ using the new variables 'edebug-behavior-alist',
globally or for individual definitions.
+++
*** Edebug's backtrace buffer now uses 'backtrace-mode'. Backtrace
mode adds fontification, links and commands for changing the
appearance of backtrace frames. See the node "Backtraces" in the Elisp
*** Edebug's backtrace buffer now uses 'backtrace-mode'.
Backtrace mode adds fontification, links and commands for changing the
appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
The binding of 'd' in Edebug's keymap is now 'edebug-pop-to-backtrace'
@ -523,7 +523,7 @@ less verbose by removing non-essential information.
+++
*** ERT's backtrace buffer now uses 'backtrace-mode'.
Backtrace mode adds fontification and commands for changing the
appearance of backtrace frames. See the node "Backtraces" in the Elisp
appearance of backtrace frames. See the node "Backtraces" in the Elisp
manual for documentation of the new mode and its commands.
** Gamegrid
@ -702,7 +702,7 @@ used by the Language Server Protocol (LSP), is readily available.
** Backtrace mode improves viewing of Elisp backtraces.
Backtrace mode adds pretty printing, fontification and ellipsis
expansion to backtrace buffers produced by the Lisp debugger, Edebug
and ERT. See the node "Backtraces" in the Elisp manual for
and ERT. See the node "Backtraces" in the Elisp manual for
documentation of the new mode and its commands.