Page MenuHomeFreeBSD

hwt(4) man page
ClosedPublic

Authored by br on Jul 7 2025, 2:50 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Aug 14, 2:18 AM
Unknown Object (File)
Tue, Aug 12, 11:17 AM
Unknown Object (File)
Mon, Aug 11, 7:05 AM
Unknown Object (File)
Sun, Aug 10, 11:32 AM
Unknown Object (File)
Sat, Aug 9, 8:24 AM
Unknown Object (File)
Fri, Aug 8, 2:36 PM
Unknown Object (File)
Fri, Aug 8, 11:53 AM
Unknown Object (File)
Wed, Aug 6, 9:34 PM
Subscribers

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

br requested review of this revision.Jul 7 2025, 2:50 PM
br created this revision.

Fix issues found by mandoc lint

I've been so excited for this! Awesome! Here's what I could find so far:

share/man/man4/hwt.4
1

You can use the SPDX short form as shown in style.9 or https://docs.freebsd.org/en/articles/license-guide/

29

This shouldn't be quoted

31–58

AIUC?

62

So, hwt is a framework, and coresight or pt are the drivers?

63

Roff wants each sentence on it's own line

76
86
87

Macros in argument width is an undefined behavior that misbehaves

89
91–92
98
100
108
126

For maintainability

127–143

Ioctls are usually Dv's afaict. I should probably put that in style.mdoc(5).

129
144–145
br marked 16 inline comments as done.

Address @ziaee comments

share/man/man4/hwt.4
31–58

You don't like this?

share/man/man4/hwt.4
31–58

yeah, it does not outline that HWT_HOOKS is mandatory option. Also not sure what is AUIC

62

Yes

share/man/man4/hwt.4
31–58

Okay, thanks. "AIUC" is "am I understanding correctly".

Can we describe it in DESCRIPTION?

I'm trying to increase the consistency and predictability of the manual. I gave a 5 min lightning talk about it at BSDCan.

https://people.freebsd.org/~ziaee/tmp/bsdcan25lightning-ziaee.webm

share/man/man4/hwt.4
31–58

Can you point to a similar man page as an example ?

https://man-dev.freebsd.org/vt
And in current (not synced to web interface yet), check out uftdi, uchcom, or pf

https://man-dev.freebsd.org/vt
And in current (not synced to web interface yet), check out uftdi, uchcom, or pf

Thanks. Could you take a look once again and accept once happy ?

Just this one stupid nit, thank you.
I wonder if we should MLINKS this page to the drivers, spe/coresight/pt?

share/man/man4/hwt.4
2
This revision is now accepted and ready to land.Jul 9 2025, 12:44 PM

Add hwt.4 to the build and create MLINKS

This revision now requires review to proceed.Jul 9 2025, 1:11 PM
This revision was not accepted when it landed; it landed in state Needs Review.Jul 9 2025, 4:00 PM
This revision was automatically updated to reflect the committed changes.