From nobody Mon Dec 5 16:47:37 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4NQqGd5DrQz4k7w0; Mon, 5 Dec 2022 16:47:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4NQqGd4kZ7z41h9; Mon, 5 Dec 2022 16:47:37 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670258857; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1y96flsi5hM3c2SZ6wB7EFDzVcEL31PbRkt8JcBdZOA=; b=NJKzJmtDmls1UypUYLVcMBBu67Ai6kHwJO9WTQ1GtDrMrafBNbkuXC6zm3JEeXi7z2QnuW G848puevfN6jkejsIPhY2mxrB8u2Pog9UJrpfru9nMflflIXY2/PBgwtflrx7HwcFnzNAa xneBT8bgtuOh6PaHnfWB07TioHVDW+KdF7VGs+S1YvUhTFYrb1ZwKijSj18pP4Z7fgDPIr LfofbjMQaoixGCMVsTYzRJRFzS9B8YihVG2AGIEnYFuJsg99hUZdC5RoRCZBccBiY3k/57 jNwhP+1gLjyugmN7IvBdiIyR+EIPXREjthuGGV37kI9HoRkNg4cLB9cm32BQpA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670258857; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1y96flsi5hM3c2SZ6wB7EFDzVcEL31PbRkt8JcBdZOA=; b=DgVTZl1sb6KKFceY3lLjsG3PqIz4yWPhz8GWRvD9g+7bRTT/4wMiCC6d6KrmM2gYcHHIRK hp+LEzEX9lDOhggvUJmf3XvEYUYMmQpDWi7eWmFIR7MLF8cj57N16OEefZ+aBrj5h4BVQC WAtKCmR5imytqpIAd8joVPab+NNNdU6U6qttV5hsjFTkUPwhPrppZie2O0QMIVeo78AsDs NiFkRZb3xJGt0K5dmKerBsK+ta6Ip3T3/1CyoDixx3ga4V2W1GloGLcoCHxK/ByDm/cF/E xybf3wEy1RHlrdb4ud8qXU6PPuBxMulOvCq7a+x7td1jDH1MmPWLQz3R12tdcQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1670258857; a=rsa-sha256; cv=none; b=HEKk9D4ZhfcF+SRBW5MR+oRgMohrLPJRyHgf5Ly/nLslfGlKP8ueEkf9adXcWN78vq6yuZ Nf6UoLw6uzQhXn2QIaVqZlEHbTFflfdHi5Uf3oi6vhnvV2XKNmm7spNmOWVj1NvjXrM3Qv bkI1yO3DY4pm69b40xXrZGMdKFyvzGBlO2ZNQCC/kCxUC8PePhHAepwV6SmNHX126q1y5J ozltjTk3Gfl8KrQJ2izqRTirSfVg5nEsWqFTwQMxiB1ycLaPFe+Ek+IXtAgsZAyxq1Avkf VYKstYe3umVJIO4edSP0i0Hrwm88mmDJaTvYIeVwThFaWXY5yjM5HqQS+0vTNw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4NQqGd3M1Wz14TT; Mon, 5 Dec 2022 16:47:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 2B5Glb9o053918; Mon, 5 Dec 2022 16:47:37 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2B5GlbjV053917; Mon, 5 Dec 2022 16:47:37 GMT (envelope-from git) Date: Mon, 5 Dec 2022 16:47:37 GMT Message-Id: <202212051647.2B5GlbjV053917@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mitchell Horne Subject: git: 684cedb10dfc - stable/13 - ddb(4): improve wording List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mhorne X-Git-Repository: src X-Git-Refname: refs/heads/stable/13 X-Git-Reftype: branch X-Git-Commit: 684cedb10dfc68168bfa0745dc7a081b98ae4f16 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=684cedb10dfc68168bfa0745dc7a081b98ae4f16 commit 684cedb10dfc68168bfa0745dc7a081b98ae4f16 Author: Warner Losh AuthorDate: 2021-07-12 21:13:13 +0000 Commit: Mitchell Horne CommitDate: 2022-12-05 16:42:54 +0000 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) --- share/man/man4/ddb.4 | 28 +++++++++++++--------------- 1 file 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.