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

Authored by tuexen on Aug 17 2025, 7:29 PM.

Details

Reviewers

bryanv
timo.voelker_fh-muenster.de
kp
bcr

Group Reviewers

manpages

Commits

rGc2fe29000d17: vtnet.4: improve existing descriptions and add missing ones
rGac87d70563f8: vtnet.4: improve existing descriptions and add missing ones

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

tuexen created this revision.Aug 17 2025, 7:29 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptAug 17 2025, 7:29 PM

tuexen requested review of this revision.Aug 17 2025, 7:29 PM

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.

tuexen marked 3 inline comments as done.Aug 18 2025, 9:50 AM

tuexen edited the summary of this revision. (Show Details)Aug 18 2025, 12:44 PM

Thanks for doing this!

share/man/man4/vtnet.4
171	Stupid style nit: This is equivalent (6 spaces) and preferred per style.mdoc(5)

tuexen added inline comments.Aug 18 2025, 4:27 PM

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?

ziaee added inline comments.Aug 18 2025, 5:36 PM

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 marked 2 inline comments as done.Aug 18 2025, 5:44 PM

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.

tuexen marked an inline comment as done.Aug 18 2025, 5:45 PM

tuexen added a reviewer: bcr.Aug 18 2025, 10:58 PM

peter.lei_ieee.org added a subscriber: peter.lei_ieee.org.Aug 21 2025, 2:57 PM

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).