aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWarner Losh <imp@FreeBSD.org>2021-07-12 21:13:13 +0000
committerMitchell Horne <mhorne@FreeBSD.org>2022-12-05 16:42:54 +0000
commit684cedb10dfc68168bfa0745dc7a081b98ae4f16 (patch)
tree78ea1971070a0d36b20a286d3a84cf58be5b0622
parent552e24e4549a8fc272149e02bcd8210b64e2e967 (diff)
downloadsrc-684cedb10dfc68168bfa0745dc7a081b98ae4f16.tar.gz
src-684cedb10dfc68168bfa0745dc7a081b98ae4f16.zip
ddb(4): improve wording
Incorporate feedback overlooked in revew by wblock@ Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D4860 (cherry picked from commit dc5a0d6d6d0c4ad88d032762f036876fb64eb0d5)
-rw-r--r--share/man/man4/ddb.428
1 files changed, 13 insertions, 15 deletions
diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4
index 91b179e4e6fa..75e9df20d1f5 100644
--- a/share/man/man4/ddb.4
+++ b/share/man/man4/ddb.4
@@ -1542,36 +1542,34 @@ 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.