Hi I've realized that the manpage for ice(4) remains missing in 13-STABLE (and main to). There is a reference in the very first commit message in 2020 of that driver by erj@: "A man page for this driver will be forthcoming." A quick search in the commit history gave me the impression that said manpage didn't yet get added. Ideally it would "just" be a matter of imprting the manpage provided in the driver archive from Intel - unless some specific additions are required before importing it into FreeBSD? Regards Mathieu
Created attachment 232784 [details] Patch 1: Import and plug ice(4) manpage as is from Intel I'm far from knowledgeable enough to get the manpage properly integrated, but consider these patches as a starting point. I've tried following the current structure of other network drivers in the source tree. Ideally this would also be backported to 13-STABLE as it contains the same driver version.
Created attachment 232785 [details] Patch 2: Fix date when it was first introduced The second patch is really small and fixes the reference of the actual release date ice(4) was first part of a FreeBSD release based on checking the version control history.
I didn't want to add that one since it's got a lot of incorrect information and is missing some useful information; but I haven't been able to finish a version that I've been working on that tries to follow what's in the current upstream ixl(4) manpage.
Anyway, it might not be a bad idea to have at least some documentation upstream that says the ice(4) driver exists, and we can always edit it later, so I'd be ok with having this committed.
LGTM, I will follow up with doc team and get this into current, 12 & 13.
(In reply to Eric Joyner from comment #4) Hi Eric Thank you for sharing the reasoning why the manpage is currently missing. Maybe if you can point out the thing that are best dropped as they "so wrong" or misleading, I might prepare a cleaned-up patch. I guess it would be best if you as maintainer express your preference over having it either following ixl(4), or to be as close as possible to the download from Intel.com. But a simple thing missing is the supported hardware list like in ixl and ixgbe. This could be added use by skimming through ice_drv_info.h. I could extract a list of all cards mentioned in there where (= very long list) Examples would be full names: * Intel(R) Ethernet Network Adapter E810-C-Q1 [...] * Intel(R) Ethernet Controller E810-XXV [...] Or rather like in ixl(4) a shortened name of model families: * E810-C (100G) * E810-XXV (25G) Regards Mathieu
(In reply to Mathieu Simon from comment #6) I'd prefer it to follow the upstream ixl(4)'s format. I also think following the shortened list like ixl(4) is the right way to go, especially because as you've noticed, the Device ID list (and corresponding model name list) is already pretty long.
Hi Eric Thank you for your update! While I do have access to E810 cards by now, I'm not close enough with the code and intrinsics of the 800 series. I will not be able to verify most of the options, but I've started working in aligning the ice(4) manpage from Intel with ixl(4) in FreeBSD. You can check out my small progress here: https://github.com/matsimon/freebsd-src/blob/feature-ice-manpage/share/man/man4/ice.4 I hope this helps, let me know if this goes into the right direction for you? Best regards Mathieu
*** Bug 269760 has been marked as a duplicate of this bug. ***
A commit in branch main references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=8e5e42d54ad3093e38263814d1f3e7d8406d5421 commit 8e5e42d54ad3093e38263814d1f3e7d8406d5421 Author: Mathieu Simon <freebsd@simweb.ch> AuthorDate: 2024-05-21 05:49:50 +0000 Commit: Dag-Erling Smørgrav <des@FreeBSD.org> CommitDate: 2024-05-21 05:53:02 +0000 Add man page for the ice network driver. PR: 262892 MFC after: 3 days Reviewed by: concussious.bugzilla@runbox.com, erj Differential Revision: https://reviews.freebsd.org/D45270 share/man/man4/Makefile | 2 + share/man/man4/ice.4 (new) | 250 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 252 insertions(+)
A commit in branch stable/14 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=42e50eaf7f6f4459f1217564fd143ae4f8127154 commit 42e50eaf7f6f4459f1217564fd143ae4f8127154 Author: Mathieu Simon <freebsd@simweb.ch> AuthorDate: 2024-05-21 05:49:50 +0000 Commit: Dag-Erling Smørgrav <des@FreeBSD.org> CommitDate: 2024-05-23 02:41:32 +0000 Add man page for the ice network driver. PR: 262892 MFC after: 3 days Reviewed by: concussious.bugzilla@runbox.com, erj Differential Revision: https://reviews.freebsd.org/D45270 (cherry picked from commit 8e5e42d54ad3093e38263814d1f3e7d8406d5421) share/man/man4/Makefile | 2 + share/man/man4/ice.4 (new) | 250 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 252 insertions(+)
A commit in branch stable/13 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=c96451a0d94e046d1ce147f8db6e83c1e7968f2c commit c96451a0d94e046d1ce147f8db6e83c1e7968f2c Author: Mathieu Simon <freebsd@simweb.ch> AuthorDate: 2024-05-21 05:49:50 +0000 Commit: Dag-Erling Smørgrav <des@FreeBSD.org> CommitDate: 2024-05-23 02:43:49 +0000 Add man page for the ice network driver. PR: 262892 MFC after: 3 days Reviewed by: concussious.bugzilla@runbox.com, erj Differential Revision: https://reviews.freebsd.org/D45270 (cherry picked from commit 8e5e42d54ad3093e38263814d1f3e7d8406d5421) share/man/man4/Makefile | 2 + share/man/man4/ice.4 (new) | 250 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 252 insertions(+)
A commit in branch releng/14.1 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=3cec7e14b06edb74c6c30889bef5c8e448ecec71 commit 3cec7e14b06edb74c6c30889bef5c8e448ecec71 Author: Mathieu Simon <freebsd@simweb.ch> AuthorDate: 2024-05-21 05:49:50 +0000 Commit: Dag-Erling Smørgrav <des@FreeBSD.org> CommitDate: 2024-05-23 02:45:25 +0000 Add man page for the ice network driver. PR: 262892 MFC after: 3 days Reviewed by: concussious.bugzilla@runbox.com, erj Differential Revision: https://reviews.freebsd.org/D45270 (cherry picked from commit 8e5e42d54ad3093e38263814d1f3e7d8406d5421) (cherry picked from commit 42e50eaf7f6f4459f1217564fd143ae4f8127154) Approved by: re (karels) share/man/man4/Makefile | 2 + share/man/man4/ice.4 (new) | 250 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 252 insertions(+)