iavf(4): Improve man page
ClosedPublic
Actions

Authored by des on Dec 19 2023, 1:30 AM.

Details

Reviewers

Group Reviewers

Intel Networking
manpages

Commits

rGf9b5ecd25790: iavf(4): Improve man page
rGd823e80ef5a7: iavf(4): Improve man page
rG4c380c44c82f: iavf(4): Improve man page
rGba222f6fb4b2: iavf(4): Improve man page

Summary

The man page now contains a fuller description of the features and
capabilities of the iavf(4) driver.

Signed-off-by: Eric Joyner <erj@FreeBSD.org>

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

erj created this revision.Dec 19 2023, 1:30 AM

Herald added a subscriber: imp. · View Herald TranscriptDec 19 2023, 1:30 AM

erj requested review of this revision.Dec 19 2023, 1:30 AM

Harbormaster completed remote builds in B54997: Diff 131542.Dec 19 2023, 1:30 AM

erj added a reviewer: Intel Networking.Dec 19 2023, 1:31 AM

erj added a reviewer: docs.Dec 19 2023, 1:33 AM

I can't find ice(4). Where is it?

$ uname -a
FreeBSD vm-current 15.0-CURRENT FreeBSD 15.0-CURRENT #18 main-n266137-ede5d4ff5b39: Thu Oct 26 21:44:36 CEST 2023     root@vm-current:/usr/obj/usr/src/amd64.amd64/sys/GENERIC amd64
$ man 4 ice
No manual entry for ice

In D43093#982800, @fernape wrote:

I can't find ice(4). Where is it?

$ uname -a
FreeBSD vm-current 15.0-CURRENT FreeBSD 15.0-CURRENT #18 main-n266137-ede5d4ff5b39: Thu Oct 26 21:44:36 CEST 2023     root@vm-current:/usr/obj/usr/src/amd64.amd64/sys/GENERIC amd64
$ man 4 ice
No manual entry for ice

It doesn't exist yet; it's the next thing I'll add after this man page.

In D43093#982901, @erj wrote:
In D43093#982800, @fernape wrote:
I can't find ice(4). Where is it?
$ uname -a
FreeBSD vm-current 15.0-CURRENT FreeBSD 15.0-CURRENT #18 main-n266137-ede5d4ff5b39: Thu Oct 26 21:44:36 CEST 2023     root@vm-current:/usr/obj/usr/src/amd64.amd64/sys/GENERIC amd64
$ man 4 ice
No manual entry for ice
It doesn't exist yet; it's the next thing I'll add after this man page.

Does ice(4) reference iavf(4)? If not, it might be better to commit the ice(4) first.

erj mentioned this in D45270: Add man page for the ice network driver..May 20 2024, 5:44 PM

des added a subscriber: des.May 20 2024, 8:15 PM

des added inline comments.

share/man/man4/iavf.4
200	same below

Eric, do you want me to commandeer this?

In D43093#1033039, @des wrote:

Eric, do you want me to commandeer this?

Sure, go ahead!

des commandeered this revision.May 21 2024, 7:13 AM

des added a reviewer: erj.

clean up

Harbormaster completed remote builds in B57811: Diff 138832.May 21 2024, 8:20 AM

des edited reviewers, added: manpages; removed: docs.May 21 2024, 8:21 AM

The updates look good to me.

share/man/man4/iavf.4
338–348	I left out this section from the original man page when I uploaded my diff; is it worth keeping this information still in the man page? I also didn't check when the conversion happened; did it happen in 12.4?

des marked an inline comment as done.May 21 2024, 10:54 PM

des added inline comments.

share/man/man4/iavf.4
338–348	12.4 was the lowest-numbered FreeBSD release that shipped with `iavf` (although 13.1 was the _earliest_ such release, so maybe we should list both?)