Page MenuHomeFreeBSD

vtnet.4: improve existing descriptions and add missing ones
ClosedPublic

Authored by tuexen on Aug 17 2025, 7:29 PM.
Tags
None
Referenced Files
F132124730: D51985.id160509.diff
Mon, Oct 13, 11:25 PM
Unknown Object (File)
Sat, Oct 11, 2:51 PM
Unknown Object (File)
Fri, Oct 10, 11:15 PM
Unknown Object (File)
Fri, Oct 10, 11:15 PM
Unknown Object (File)
Fri, Oct 10, 11:15 PM
Unknown Object (File)
Fri, Oct 10, 11:15 PM
Unknown Object (File)
Fri, Oct 10, 4:59 PM
Unknown Object (File)
Thu, Oct 2, 10:02 AM

Details

Summary

Improve several descriptions for loader tunables and add descriptions of the statistics provided by read only sysctl-variables.
Right now all aggregated interface level counters dev.vtnet.X.tx_task_rescheduled, dev.vtnet.X.tx_tso_offloaded, dev.vtnet.X.tx_csum_offloaded, dev.vtnet.X.rx_task_rescheduled, dev.vtnet.X.rx_csum_offloaded, and dev.vtnet.X.rx_csum_failed are always reported as zero. In addition, the interface level counter dev.vtnet.X.tx_defrag_failed will count more than expected. Fixes for these issues are under review in D51999.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Looks good, other than these minor remarks.

share/man/man4/vtnet.4
161

"of", not "if"

163

Same

196

Other lines are in past tense, we should try to be consistent.

Improve spelling and grammar. In particular address the issues raised by Kristof.

Thanks for doing this!

share/man/man4/vtnet.4
171

Stupid style nit: This is equivalent (6 spaces) and preferred per style.mdoc(5)

share/man/man4/vtnet.4
171

Doesn't that man page say:

In case the longest item is too long and hurts readability, the
recommendation is to set the -width argument to ‘indent’,
.Bl -tag -width "indent"

Willing to change it, but the "xxxxxx" is used elsewhere in the man page. So I guess it is preferred to use the same pattern in the file?

share/man/man4/vtnet.4
171

Same pattern in the file is good, sorry.

I was thinking of the previous clause where we use the longest thing in between the quotes and not xxxx or nnnnn, which is harder to maintain because people don't want to count.

tuexen added inline comments.
share/man/man4/vtnet.4
171

All specifications of the width in this files are using "xxxxxx". So I keep it for consistency.

peter.lei_ieee.org added inline comments.
share/man/man4/vtnet.4
71–74

Nit: most (if not all) other pages currently refer to this as transmit checksum offloading instead of transmission.
(There are several instances of this below as well).

Looks good, thanks for documenting these!

This revision is now accepted and ready to land.Aug 21 2025, 6:18 PM