Add man page for the ice network driver.
ClosedPublic
Actions

Authored by des on May 20 2024, 1:06 PM.

Details

Reviewers

erj
freebsd_simweb.ch
concussious.bugzilla_runbox.com

Group Reviewers

manpages

Commits

rG3cec7e14b06e: Add man page for the ice network driver.
rGc96451a0d94e: Add man page for the ice network driver.
rG42e50eaf7f6f: Add man page for the ice network driver.
rG8e5e42d54ad3: Add man page for the ice network driver.

Summary

PR: 262892
MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

des created this revision.May 20 2024, 1:06 PM

Herald added a subscriber: imp. · View Herald TranscriptMay 20 2024, 1:06 PM

des requested review of this revision.May 20 2024, 1:06 PM

Harbormaster completed remote builds in B57787: Diff 138775.May 20 2024, 1:06 PM

correct nvmupdate port

Harbormaster completed remote builds in B57788: Diff 138776.May 20 2024, 1:13 PM

I'd like to get this into 14.1 if possible -- please review ASAP.

Similar to the iavf(4) update here: https://reviews.freebsd.org/D43093, the documentation team here has generated a new man page for ice(4), but I haven't converted it to the FreeBSD upstream format, yet. I'm fine with this version with some fixes, but if you give me a couple days I can convert it and submit it here for review.

Regardless, the iavf(4) update should be reviewed/submitted after this one.

share/man/man4/ice.4
61–66	There's a more complete list of currently supported 800 series devices in the iavf(4) review here: https://reviews.freebsd.org/D43093
143–156	I don't think there are any 10G/1G-only SFP+ 800 series adapters, but I think these modules can still be used in the 25G SFP28 ones.
173–190	These tunables don't exist.
201	The sysctls in this section should start with something like "dev.ice.#" instead of "hw.ice"
208–209	The driver supports many more speeds than the ones listed here; for now it'd be quicker to just remove this last sentence.
229	Minor nit, but 40G speeds aren't currently supported.
235–244	None of these error messages exist in the driver.

This revision now requires changes to proceed.May 20 2024, 5:44 PM

I can only comment on markup nits, I don't have this equipment.

New sentance, new line (linter says 74,175,179,183,185,203, and 207), I didn't "suggest edit" for that because they should be reflowed accordingly.

share/man/man4/ice.4
2	New file definitely should tag?
34	Title shouldn't be lowercase
88	Sections and subsections create their own newline, and complain to the linter if it's explicitly suggested
200	Same as above
227
234	Although, for just one item, I think it's incorrect to call it a list and I prefer Pp then Dl. This saves a line for the El as well, when it's the end of a section like this.