hwpmc(4): document debugging options
ClosedPublic
Actions

Authored by mhorne on Jun 14 2023, 5:58 PM.

Details

Reviewers

jkoshy
emaste
gnn

Group Reviewers

pmc

Commits

rG11b3648c4cbb: hwpmc(4): document debugging options
rG5fc97cc32553: hwpmc(4): document debugging options

Summary

The debug options for hwpmc are not documented in detail anywhere, and
setting it up was error-prone the first time I had to figure it out (and
each time I've had to remember it). Add some explanation of the required
options and describe the kern.hwpmc.debugflags sysctl format.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

mhorne created this revision.Jun 14 2023, 5:58 PM

Herald added a reviewer: gnn. · View Herald TranscriptJun 14 2023, 5:58 PM

Herald added a subscriber: imp. · View Herald Transcript

mhorne requested review of this revision.Jun 14 2023, 5:58 PM

Harbormaster completed remote builds in B52058: Diff 123242.Jun 14 2023, 5:58 PM

mhorne added a parent revision: D40544: hwpmc: add error for HWPMC_DEBUG without KTR.Jun 14 2023, 5:58 PM

emaste added inline comments.Jun 14 2023, 8:17 PM

share/man/man4/hwpmc.4
541	This is really useful only for debugging during development of hwpmc itself (and not a user of hwmpc), right? If so we may want to make that explicit here.