Page MenuHomeFreeBSD

Add man page for the ice network driver.
ClosedPublic

Authored by des on Mon, May 20, 1:06 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, May 25, 12:41 PM
Unknown Object (File)
Wed, May 22, 8:18 PM
Unknown Object (File)
Wed, May 22, 3:18 AM
Unknown Object (File)
Tue, May 21, 8:55 PM
Unknown Object (File)
Tue, May 21, 9:15 AM
Unknown Object (File)
Tue, May 21, 7:31 AM
Unknown Object (File)
Tue, May 21, 5:55 AM
Unknown Object (File)
Mon, May 20, 7:52 PM

Diff Detail

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

Event Timeline

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

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

erj requested changes to this revision.Mon, May 20, 5:44 PM

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.Mon, May 20, 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.

des marked 13 inline comments as done.Mon, May 20, 8:23 PM

Incorporate review feedback.

Content-wise, it looks good to me now.

This revision is now accepted and ready to land.Mon, May 20, 11:57 PM
This revision was automatically updated to reflect the committed changes.