hwpmc(4): update DEBUGGING section details
ClosedPublic
Actions

Authored by mhorne on Jul 7 2023, 6:29 PM.

Details

Reviewers

jkoshy
emaste
gnn

Group Reviewers

pmc

Commits

rG89240e0ab60a: hwpmc(4): update DEBUGGING section details

Summary

The examples I wrote previously do not work. We parse the flags using
explicit names, not the shortened flag suffix. Fix the list of major
flags, and add a compact list of minor flags. Fix the examples, and
tweak some wording for clarity.

Fixes: 5fc97cc32553 ("hwpmc(4): document debugging options")

Test Plan

Build a kernel with PMC_DEBUG and try setting the sysctl with the examples provided.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

mhorne created this revision.Jul 7 2023, 6:29 PM

Herald added a reviewer: gnn. · View Herald TranscriptJul 7 2023, 6:29 PM

Herald added a subscriber: imp. · View Herald Transcript

mhorne requested review of this revision.Jul 7 2023, 6:29 PM

Harbormaster completed remote builds in B52485: Diff 124301.Jul 7 2023, 6:29 PM

mhorne edited the test plan for this revision. (Show Details)Jul 7 2023, 6:30 PM

mhorne added inline comments.

share/man/man4/hwpmc.4

585–620

FYI this renders as:

The minor flags for each major flag group can vary.  The individual minor
flag names are:

      allocaterow, allocate, attach, bind, config, exec, exit, find,
      flush, fork, getbuf, hook, init, intr, linktarget, mayberemove,
      ops, read, register, release, remove, sample, scheduleio, select,
      signal, swi, swo, start, stop, syscall, unlinktarget, write

jkoshy accepted this revision.Jul 8 2023, 7:32 AM

This revision is now accepted and ready to land.Jul 8 2023, 7:32 AM

emaste accepted this revision.Jul 8 2023, 10:40 AM

Closed by commit rG89240e0ab60a: hwpmc(4): update DEBUGGING section details (authored by mhorne). · Explain WhyJul 9 2023, 7:04 PM

This revision was automatically updated to reflect the committed changes.

mhorne added a commit: rG89240e0ab60a: hwpmc(4): update DEBUGGING section details.