From nobody Mon Oct 27 16:39:10 2025 X-Original-To: dev-commits-src-main@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 4cwK331kwSz6F3Vn; Mon, 27 Oct 2025 16:39:11 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4cwK323rqYz3qVd; Mon, 27 Oct 2025 16:39:10 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1761583150; 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=ZwzEKyvTx/3zdGaPSZWFRdeChMQQsBsA3B/gdcawcpQ=; b=mdzpz1Hsrss3oWNkD+Vmu1mo8zFeuKJUzh98UIN/LiUXqLuny898Gvoqv9CHPJC65oIDvk YxblXWISVeJ0t2nHL8ZKhvXKxle7Iy1HfIoQ40dW7iNL8trjuVMEDuPFgoD6Hp1ChwcKY4 Nl1OuyEJCVL03k+0CTye6WxhaNZQ1XZkf+zUVbQQxoVk3m7Qie/6iSJgbpmz/ih/LprE8S R7uosoZjWN3YQl1ITixCyDEpL7pBLWcoa5+h3L6E2A6vRtnvhpZqnE/3VIOk+eyKyqFuxh QJss4F4m59a0U7r1Irr3wHMrbm88QIl6o4yKeBiy3dAfj1On656dOzunOwFT7A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1761583150; 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=ZwzEKyvTx/3zdGaPSZWFRdeChMQQsBsA3B/gdcawcpQ=; b=aHheduSUpe1XSsva3CMbjC3kKXtYI1OMBoFCODgaBNl8Pw9z1BHTb2hx38ss09jWhGtdDa F23k04jF5LHJyupYx4R7XS0ukPv4F7DV3O6d+z95sFIdMIJRQLTRpzR946YgaOz77kqAiu +k/+CFV21KHYgNotfFs/8MK53m+8RFu0rGYx/EuED/4+Oss6LSSFSNM/yaZMfaaVZMVvKZ AB4Jri5wE99K9EgIWPrjwNJqQI2+Eko5CirwoqNkkNzJewWtLAC9CDzJNPw6LugiJMUiIu hbt0DuOp5wboj9OqNLD8mbgTaSS8832skUKMyIdzomNV26DqkrsGAlKVH64PFw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1761583150; a=rsa-sha256; cv=none; b=DvrEjEjQr7wxm9f8WKSnx+M4SLrFNC4/XtFmINr5XEl4JPZTfKl7f+2TxwY9ov+/Wagizt pz1c3OTZRSyH5eZWphU4wv5wGzmdtIBWzxtq2xUkWzPMcrPkaCDyoTGhIYc/M0oIxKhefk LRe9D6DxjdHg9w3ilTXZ3xyvRIGaz0WuANLn6E/hHfOd9Wq2BP6g0ysauPqJOjtcqmBalj b4EE/hOjwsrYYTo6O95iXA071q0US2ayEkO5/zLig2Gwn1iL53HJoe4MZT5d8CSBjYh09O /ZxnVWOW70LeSTpyO7QE2plLS+PEAUxHwIrKQA4zlQCdtqudbwV7ge3Pg4UgAw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4cwK323JdWz1Qnp; Mon, 27 Oct 2025 16:39:10 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 59RGdADT019696; Mon, 27 Oct 2025 16:39:10 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 59RGdAnY019693; Mon, 27 Oct 2025 16:39:10 GMT (envelope-from git) Date: Mon, 27 Oct 2025 16:39:10 GMT Message-Id: <202510271639.59RGdAnY019693@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mark Johnston Subject: git: ef7b81340b8e - main - gdb: Improve doc strings List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: markj X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ef7b81340b8e0ad06584f364aa02105c03ca5f7c Auto-Submitted: auto-generated The branch main has been updated by markj: URL: https://cgit.FreeBSD.org/src/commit/?id=ef7b81340b8e0ad06584f364aa02105c03ca5f7c commit ef7b81340b8e0ad06584f364aa02105c03ca5f7c Author: Mark Johnston AuthorDate: 2025-10-27 16:28:20 +0000 Commit: Mark Johnston CommitDate: 2025-10-27 16:28:20 +0000 gdb: Improve doc strings These are printed by gdb when requesting help for the corresponding function or command, so phrase them such that they make sense in that context. MFC after: 1 week --- sys/tools/gdb/acttrace.py | 6 ++---- sys/tools/gdb/pcpu.py | 2 +- sys/tools/gdb/vnet.py | 2 +- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/sys/tools/gdb/acttrace.py b/sys/tools/gdb/acttrace.py index 147effbbddf1..fdd18a4833cd 100644 --- a/sys/tools/gdb/acttrace.py +++ b/sys/tools/gdb/acttrace.py @@ -13,10 +13,8 @@ from pcpu import * class acttrace(gdb.Command): """ - Register an acttrace command with gdb. - - When run, acttrace prints the stack trace of all threads that were on-CPU - at the time of the panic. + Print the stack trace of all threads that were on-CPU at the time of + the panic. """ def __init__(self): super(acttrace, self).__init__("acttrace", gdb.COMMAND_USER) diff --git a/sys/tools/gdb/pcpu.py b/sys/tools/gdb/pcpu.py index aadc4b2d42df..94c451e6eca5 100644 --- a/sys/tools/gdb/pcpu.py +++ b/sys/tools/gdb/pcpu.py @@ -9,7 +9,7 @@ from freebsd import * class pcpu(gdb.Function): """ - Register a function to lookup PCPU and DPCPU variables by name. + A function to look up PCPU and DPCPU fields by name. To look up the value of the PCPU field foo on CPU n, use $PCPU("foo", n). This works for DPCPU fields too. If the CPU ID is diff --git a/sys/tools/gdb/vnet.py b/sys/tools/gdb/vnet.py index 36b4d512a3eb..5f416b2a515a 100644 --- a/sys/tools/gdb/vnet.py +++ b/sys/tools/gdb/vnet.py @@ -10,7 +10,7 @@ from freebsd import * class vnet(gdb.Function): """ - Register a function to look up VNET variables by name. + A function to look up VNET variables by name. To look at the value of a VNET variable V_foo, print $V("foo"). The currently selected thread's VNET is used by default, but can be optionally