git: 387ee93e0794 - stable/13 - hwpmc(4): more detailed SYNOPSYS
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Mon, 17 Jul 2023 16:49:40 UTC
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