From nobody Mon Oct 23 20:11:28 2023 X-Original-To: dev-commits-doc-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 4SDmYD66qnz4yRd5 for ; Mon, 23 Oct 2023 20:11:28 +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 4SDmYD5b0Gz3P8Y; Mon, 23 Oct 2023 20:11:28 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1698091888; 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=RVwH7csTXwCssTCfMLG/Xi+1syOYyoM99bfkhtXkRcs=; b=lWWgjKgw1JqrP6W796Ivur60EDFUURWkJ01HQ+/tcV4pZVq97xKYPRUoeZNcDVaaLOUZts aUEDja6sdXkl+735MX7Jwy9VkTnYELuFj/ErZfz64u3RjCWWsPr6r3V8SJfWIjEhB+KrRd q0WfK4DZzpXZWIjmvrRRfmJ5vdaXsH3LI15HFOxHOiom3arqQm3XobZJBOiamOuy//7/Q3 LAnzYn2m5CiFB88bUHcigBuGaEMYpkhl8VUADBrAaYbAX60FFP3JnqxRZ9SU+r9mteQumV 2ws8H0cNbDvuyo/rz6LLRZ50pbAD0vOgb8wF9/VhdT2ZPYxmqG51/o7Ap33/GA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1698091888; a=rsa-sha256; cv=none; b=emHral6koUbODCS3l/nfuUNUjyznGXeApNiruSIBm1Sw2dDLthQ/TBRrqrrAjfFApxQq7U jB2Ak6NuK7n2urH8Sp3M0hhT7YchJYy1W5UC20p0x5+ij1hDPVX9KRWXK+Tqr0l8Li4eM5 EeXPTTr8r6qLivr+rQIiiDhNt0eHKNyxe7WfRXMKwu1zU6Ovn8VMQhULtwlIeEdNlnRExv fSQLIaL/3cHX6xvza+uN2hdLi8PHlddKtDyO1kY+s/odoNZdeD9WkDWunwYVlEZmFX2pBK pFylLk5i8x2KJJLPbcTL672kmjdLGJ981e9Jx5kJ6L5aRjZxoUunh1kvw0PURA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1698091888; 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=RVwH7csTXwCssTCfMLG/Xi+1syOYyoM99bfkhtXkRcs=; b=McFuuKO9dbJ5kBXQ+pTNRXT9Lbzq6cOPBkR/LAfK9pMw3SEG8gBB6GKGX+qJT0AcuVpCTZ PklWbXRdcpSYJPv8V/Dvsnj40NdfluZOO5Kd2xZLng4Yh3SkejmMUeR7B9SK/hijVQ/4EG BMnG02GjVv/vvEoC86ZWBk4ZjkWx+sa+U/L6UESDA8fy61mQpqxvxU16JOCjVwlfl/B/Y/ C6vvP1U2F+unI4Hwdn8z4gK7LIHG8DI/jEv5fNBCotAIRxFPy0qWMyKaymXczY2wBjz2DV W4frXDvQxigGfJLZc6QclQ3WLRHGBqL/Ur6moSgVtmLHKXMUdua+COAmvJAnPA== 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 4SDmYD4dlfztbd; Mon, 23 Oct 2023 20:11:28 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 39NKBSUA045201; Mon, 23 Oct 2023 20:11:28 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 39NKBScW045198; Mon, 23 Oct 2023 20:11:28 GMT (envelope-from git) Date: Mon, 23 Oct 2023 20:11:28 GMT Message-Id: <202310232011.39NKBScW045198@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mitchell Horne Subject: git: 477e130608 - main - developers-handbook: tweak introduction to lldb List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-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: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 477e130608b6cb79c689a0bbe4da4afb73401299 Auto-Submitted: auto-generated The branch main has been updated by mhorne: URL: https://cgit.FreeBSD.org/doc/commit/?id=477e130608b6cb79c689a0bbe4da4afb73401299 commit 477e130608b6cb79c689a0bbe4da4afb73401299 Author: Mitchell Horne AuthorDate: 2023-10-23 20:10:46 +0000 Commit: Mitchell Horne CommitDate: 2023-10-23 20:11:15 +0000 developers-handbook: tweak introduction to lldb All supported versions of FreeBSD ship with lldb, so we no longer need to mention FreeBSD version specifics. While here, make some small tweaks to this text. Reviewed by: carlavilla, emaste Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D42333 --- .../content/en/books/developers-handbook/tools/_index.adoc | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/documentation/content/en/books/developers-handbook/tools/_index.adoc b/documentation/content/en/books/developers-handbook/tools/_index.adoc index 038ee19d39..0aa087ceb0 100644 --- a/documentation/content/en/books/developers-handbook/tools/_index.adoc +++ b/documentation/content/en/books/developers-handbook/tools/_index.adoc @@ -679,28 +679,25 @@ to the file. Once you have done this, you can type `info` and then select [.guim Using a debugger allows running the program under more controlled circumstances. Typically, it is possible to step through the program a line at a time, inspect the value of variables, change them, tell the debugger to run up to a certain point and then stop, and so on. It is also possible to attach to a program that is already running, or load a core file to investigate why the program crashed. -It is even possible to debug the kernel, though that is a little trickier than the user applications we will be discussing in this section. This section is intended to be a quick introduction to using debuggers and does not cover specialized topics such as debugging the kernel. For more information about that, refer to crossref:kerneldebug[kerneldebug,Kernel Debugging]. -The standard debugger supplied with FreeBSD {rel121-current} is called `lldb` (LLVM debugger). +The standard debugger supplied with FreeBSD is called `lldb` (LLVM debugger). As it is part of the standard installation for that release, there is no need to do anything special to use it. It has good command help, accessible via the `help` command, as well as https://lldb.llvm.org/[a web tutorial and documentation]. [NOTE] ==== -The `lldb` command is available for FreeBSD {rel113-current} extref:{handbook}ports/[from ports or packages, ports-using] as package:devel/llvm[]. -This will install the default version of lldb (currently 9.0). +The `lldb` command is also available extref:{handbook}ports/[from ports or packages, ports-using] as package:devel/llvm[]. ==== The other debugger available with FreeBSD is called `gdb` (GNU debugger). -Unlike lldb, it is not installed by default on FreeBSD {rel121-current}; +Unlike lldb, it is not installed by default on FreeBSD; to use it, extref:{handbook}#ports-using/[install] package:devel/gdb[] from ports or packages. -The version installed by default on FreeBSD {rel113-current} is old; instead, install package:devel/gdb[] there as well. -It has quite good on-line help, as well as a set of info pages. +It has excellent on-line help, as well as a set of info pages. -Which one to use is largely a matter of taste. +The two debuggers have a similar feature set, so which one to use is largely a matter of taste. If familiar with one only, use that one. People familiar with neither or both but wanting to use one from inside Emacs will need to use `gdb` as `lldb` is unsupported by Emacs. Otherwise, try both and see which one you prefer.