git: dc5a0d6d6d0c - main - ddb(4): improve wording

Warner Losh imp at FreeBSD.org
Mon Jul 12 21:14:17 UTC 2021


The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=dc5a0d6d6d0c4ad88d032762f036876fb64eb0d5

commit dc5a0d6d6d0c4ad88d032762f036876fb64eb0d5
Author:     Warner Losh <imp at FreeBSD.org>
AuthorDate: 2021-07-12 21:13:13 +0000
Commit:     Warner Losh <imp at FreeBSD.org>
CommitDate: 2021-07-12 21:13:13 +0000

    ddb(4): improve wording
    
    Incorporate feedback overlooked in revew by wblock@
    
    Sponsored by:           Netflix
    Differential Revision:  https://reviews.freebsd.org/D4860
---
 share/man/man4/ddb.4 | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4
index 4f1614d8e006..bc46051c37ed 100644
--- a/share/man/man4/ddb.4
+++ b/share/man/man4/ddb.4
@@ -1538,41 +1538,39 @@ Embedded systems often use JTAG for debugging, but rarely use it in
 combination with
 .Nm .
 .Pp
-For serial consoles, you can enter the debugger by sending a BREAK
-condition on the serial line if
+Serial consoles can break to the debugger by sending a BREAK
+condition on the serial line.
+This requires a kernel built with
 .Cd options BREAK_TO_DEBUGGER
 is specified in the kernel.
 Most terminal emulation programs can send a break sequence with a
-special key sequence or via a menu item.
-However, in some setups, sending the break can be difficult to arrange
-or happens spuriously, so if the kernel contains
+special key sequence or menu selection.
+Sending the break can be difficult or even happen spuriously in some setups.
+An alternative method is to build a kernel with
 .Cd options ALT_BREAK_TO_DEBUGGER
 then the sequence of CR TILDE CTRL-B enters the debugger;
-CR TILDE CTRL-P causes a panic instead of entering the
-debugger; and
+CR TILDE CTRL-P causes a panic; and
 CR TILDE CTRL-R causes an immediate reboot.
-In all the above sequences, CR is a Carriage Return and is usually
-sent by hitting the Enter or Return key.
+In all these sequences, CR represents Carriage Return and is usually
+sent by pressing the Enter or Return key.
 TILDE is the ASCII tilde character (~).
-CTRL-x is Control x created by hitting the control key and then x
+CTRL-x is Control x, send by pressing the Control key, then x, then releasing both.
 and then releasing both.
 .Pp
-The break to enter the debugger behavior may be enabled at run-time
-by setting the
+The break-to-debugger behavior can be enabled by setting
 .Xr sysctl 8
 .Va debug.kdb.break_to_debugger
 to 1.
-The alternate sequence to enter the debugger behavior may be enabled
-at run-time by setting the
+The alt-break-to-debugger behavior can be enabled by setting
 .Xr sysctl 8
 .Va debug.kdb.alt_break_to_debugger
 to 1.
-The debugger may be entered by setting the
+The debugger can be entered by setting
 .Xr sysctl 8
 .Va debug.kdb.enter
 to 1.
 .Pp
-Output may be interrupted, paused, and resumed with the control
+Output can be interrupted, paused, and resumed with the control
 characters CTRL-C, CTRL-S, and CTRL-Q.
 Because these control characters are received as in-band data from the
 console, there is an input buffer, and once that buffer fills


More information about the dev-commits-src-main mailing list