From nobody Mon Jul 17 16:49:40 2023
X-Original-To: dev-commits-src-branches@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 4R4Sjc6NPbz4n4Qw;
Mon, 17 Jul 2023 16:49:40 +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 4R4Sjc1h3xz4JHK;
Mon, 17 Jul 2023 16:49:40 +0000 (UTC)
(envelope-from git@FreeBSD.org)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim;
t=1689612580;
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=upBNkolmLu36qTqJJvn+WZmkXlfpiSM8A3o/uG9VHwY=;
b=Dmf+UrSuqcjhWbMQ0s9yzauBKrtTZaI268RZZgXxnF62iRlnYjiCdQx6JXYLxAVzy7YVLe
l+HTEdfyxEx8MVdLFFgwzA6qVlEoixpWOwTOFXvhsDr4H1jjQ8COGooVtH5RmjGn5m92w3
1jnRi93QDhUyZ1cJV+/PMvhR9fFN4VntB6wYTrlU9uSUQb6gNpo4v1b5u0dekqFI06p7qE
gK56heUapluQadfDiWR0LtYJ9eb9jvcWDOQmD8FtCrA+JXRNLxgrGz8rvTHkDqDEXJy9CG
QnZ+PIhvzmNzXsU08EW49qQHUEdpLjr1AM/P7umxMfupLxh5lry9jTwSG68zwA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org;
s=dkim; t=1689612580;
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=upBNkolmLu36qTqJJvn+WZmkXlfpiSM8A3o/uG9VHwY=;
b=wlfcaQjvOlmugmAykY1HzCVP+g8SUCUAVNrl4sGaA1Ifeu8IhcF8MKcT0bvd+LU6ZEZHfU
h6pxTo90D0LTcq3Hsc9E3Jgol3V0V7hGnRu6VmsLwOpXA2ZSXyocD6MrbwJMM0cvl01bwA
zoxi/H8PSVS6r7OpeqcfFCus5nJVZj1Y6S55OACXN4+NYlr2GqAxLutzIwOnMnPEL6bXis
ztWbWp18phxVSsP2o7bcgHGy4UfgGrX7lDy8FYaoshjIJXfLqQuXKphCuvK02PYW7SsDiZ
wqC2Xa6bsq6dGsE0Ii27wuH4iHmY2KXIfBveS4GUIsfOID7i94hOyFHD1+u38g==
ARC-Authentication-Results: i=1;
mx1.freebsd.org;
none
ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1689612580; a=rsa-sha256; cv=none;
b=NFU4qSY1JgmreKVCN6Iw4zG2uPtdAirfxC5zrjvbErS93z5eTpK/aPkVS50/0XyXihzujf
59oz6gybuMikeS0I2SipcWatPUJvRQ3WOxiT0mNueUlbUzdB6Yj1IhRdiJrNYmiwJvbZ2L
dKEDAgGVtyOFA1oRgOMFbCjw31w3+DXanO3tLsKNSrqkP6nN53+S+tyn0t0EH/vAfxPHZI
OLqEiEhreva8tqhqPxXEB9ZqhUNrCtlSIFzxpZ9HImnKVbmSwoeh1+klYY25QhoTrdKqpQ
XvXkRk8kY9U8Y/pXYuyaLhFEUb8sVesFPPSqyCKtHkFuxrwfu056x8rB6Hfpew==
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 4R4Sjc0nMszWKc;
Mon, 17 Jul 2023 16:49:40 +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 36HGneD4081379;
Mon, 17 Jul 2023 16:49:40 GMT
(envelope-from git@gitrepo.freebsd.org)
Received: (from git@localhost)
by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 36HGnepx081378;
Mon, 17 Jul 2023 16:49:40 GMT
(envelope-from git)
Date: Mon, 17 Jul 2023 16:49:40 GMT
Message-Id: <202307171649.36HGnepx081378@gitrepo.freebsd.org>
To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org,
dev-commits-src-branches@FreeBSD.org
From: Mitchell Horne <mhorne@FreeBSD.org>
Subject: git: 387ee93e0794 - stable/13 - hwpmc(4): more detailed SYNOPSYS
List-Id: Commits to the stable branches of the FreeBSD src repository <dev-commits-src-branches.freebsd.org>
List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches
List-Help: <mailto:dev-commits-src-branches+help@freebsd.org>
List-Post: <mailto:dev-commits-src-branches@freebsd.org>
List-Subscribe: <mailto:dev-commits-src-branches+subscribe@freebsd.org>
List-Unsubscribe: <mailto:dev-commits-src-branches+unsubscribe@freebsd.org>
Sender: owner-dev-commits-src-branches@freebsd.org
X-BeenThere: dev-commits-src-branches@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: 387ee93e0794d8812e276745de148292bedf8ccc
Auto-Submitted: auto-generated
X-ThisMailContainsUnwantedMimeParts: N
The branch stable/13 has been updated by mhorne:
URL: https://cgit.FreeBSD.org/src/commit/?id=387ee93e0794d8812e276745de148292bedf8ccc
commit 387ee93e0794d8812e276745de148292bedf8ccc
Author: Mitchell Horne <mhorne@FreeBSD.org>
AuthorDate: 2023-06-16 16:38:03 +0000
Commit: Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-07-17 16:45:39 +0000
hwpmc(4): more detailed SYNOPSYS
Include some boilerplate similar to other section 4 man pages,
describing how to load the module at boot-time or include it in the
kernel.
Reviewed by: jkoshy, emaste
MFC after: 1 week
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D40542
(cherry picked from commit 0a1a48148ccd561464d643c05597cec2ae9e88b8)
---
share/man/man4/hwpmc.4 | 18 +++++++++++++++++-
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4
index 08edb6a16faf..6bd5d571793a 100644
--- a/share/man/man4/hwpmc.4
+++ b/share/man/man4/hwpmc.4
@@ -35,11 +35,27 @@
.Nm hwpmc
.Nd "Hardware Performance Monitoring Counter support"
.Sh SYNOPSIS
+The following option must be present in the kernel configuration file:
+.Bd -ragged -offset indent
.Cd "options HWPMC_HOOKS"
-.Cd "device hwpmc"
+.Ed
.Pp
Additionally, for i386 systems:
+.Bd -ragged -offset indent
.Cd "device apic"
+.Ed
+.Pp
+To load the driver as a module at boot time, place the
+following line in
+.Xr rc.conf 5 :
+.Bd -literal -offset indent
+kld_list="${kld_list} hwpmc"
+.Ed
+.Pp
+Alternatively, to compile this driver into the kernel:
+.Bd -ragged -offset indent
+.Cd "device hwpmc"
+.Ed
.Sh DESCRIPTION
The
.Nm