The ice(4) Intel Ethernet 800 Series Driver seems to be correctly included in the archetypal Hardware Notes: the following line appears in https://github.com/freebsd/freebsd-doc/blob/main/website/archetypes/release/hardware.adoc > &hwlist.ice; But the automatic generation of the Hardware Notes seems to fail, looking at the output in https://github.com/freebsd/freebsd-doc/blob/main/website/content/en/releases/15.0R/hardware.adoc In particular ice(4) entry cuts off prematurely and runs immediately into the igc(4) driver. > The ice driver supports 100Gb Ethernet adapters with these QSFP28 modules: > The igc driver supports the following models: It ought to have generated a bulleted list of supported devices. Compare to the Hardware section of the ice(4) man page which the Hardware Notes are generated from, https://man.freebsd.org/cgi/man.cgi?ice(4) > The ice driver supports 100Gb Ethernet adapters with these QSFP28 modules: > • Intel(R) 100G QSFP28 100GBASE-SR4 E100GQSFPSR28SRX > ... I have filed this as a "website" bug, though I suspect ultimately the bug either lies in the tooling that automatically generates the Hardware Notes from the man pages, or maybe something formatted weirdly in the man page itself which is confusing the tooling, https://github.com/freebsd/freebsd-src/blob/main/share/man/man4/ice.4 I'll quote part of the relevant section for convenience. Note that bulleted lists of devices starting ".Bl -bullet -compact" on other man pages are generating correctly on the Hardware Notes. While ice(4) is somewhat unusual in that its Hardware section contains multiple bulleted lists, so does e.g. ixl(4) and that does generate correctly. > .Sh HARDWARE > The > .Nm > driver supports the Intel Ethernet 800 series. > Some adapters in this series with SFP28/QSFP28 cages > have firmware that requires that Intel qualified modules are used; these > qualified modules are listed below. > This qualification check cannot be disabled by the driver. > .Pp > The > .Nm > driver supports 100Gb Ethernet adapters with these QSFP28 modules: > .Pp > .Bl -bullet -compact > .It > Intel\(rg 100G QSFP28 100GBASE-SR4 E100GQSFPSR28SRX > .It > Intel\(rg 100G QSFP28 100GBASE-SR4 SPTMBP1PMCDF > ... If I was going to stake a guess, is the tooling cutting off when it hits the "\(rg" in the first bullet point? I note that the em(4) and ixl(4) man pages also have lists of Intel devices in their Hardware sections but without "\(rg", and they are generating fine in the Hardware Notes. Might be worth pruning all the "\(rg" from the ice(4) man page and then try regenerating the Hardware Notes. As this affects the 15.0R Hardware Notes I guess this is one for @re or @ziaee. NB Same issue affects 14.2R and 14.3R versions of the Hardware Notes. Maybe at least the latter would be worth regenerating.
Alexander, what do you think of this one?
A commit in branch main references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=f30335c5cb5e18a1ef08f5ba1d6fa6fc06f39348 commit f30335c5cb5e18a1ef08f5ba1d6fa6fc06f39348 Author: Alexander Ziaee <ziaee@FreeBSD.org> AuthorDate: 2025-11-05 21:59:20 +0000 Commit: Alexander Ziaee <ziaee@FreeBSD.org> CommitDate: 2025-11-05 22:39:15 +0000 ice.4: Add ToC and E835 and editorial pass This manual is large enough and well structured enough that we can have a clickable table of contents. Use that to move some subsections which should not appear in Hardware Release Note to the description section. Adjust subsection names so this will work, preserving parentheticals for search by moving them to the bodies just below. Strip unnecessary copyright symbols and escaped hyphens. Copyright symbols never appear in the content of manual pages, including other Intel manual pages, and appear to break the Hardware Release Notes. Escaped hyphens were necessary decades ago for manual pages written in man(7), but this page is written in mdoc(7). Also misc touchups. Add the recently added E835 devices to the supported HARDWARE list. Add the speed ranges to description like the other ethernet drivers. PR: 290778 MFC after: 1 day Fixes: 09b48f811b4b (Add support for E835-XXV-4 adapter) Fixes: b202176dc76d (Add PCI IDs for E835 devices) Reviewed by: kgalazka (previous version) Reported by: kgalazka (additional hardware has been added) Reported by: bigsneaky@duck.com (HW Relnote is truncating) share/man/man4/ice.4 | 372 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 224 insertions(+), 148 deletions(-)
A commit in branch stable/15 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=71bd17b879a74f57573d41ad21a9a0e7f984ab11 commit 71bd17b879a74f57573d41ad21a9a0e7f984ab11 Author: Alexander Ziaee <ziaee@FreeBSD.org> AuthorDate: 2025-11-05 21:59:20 +0000 Commit: Alexander Ziaee <ziaee@FreeBSD.org> CommitDate: 2025-11-06 14:16:41 +0000 ice.4: Add ToC and E835 and editorial pass This manual is large enough and well structured enough that we can have a clickable table of contents. Use that to move some subsections which should not appear in Hardware Release Note to the description section. Adjust subsection names so this will work, preserving parentheticals for search by moving them to the bodies just below. Strip unnecessary copyright symbols and escaped hyphens. Copyright symbols never appear in the content of manual pages, including other Intel manual pages, and appear to break the Hardware Release Notes. Escaped hyphens were necessary decades ago for manual pages written in man(7), but this page is written in mdoc(7). Also misc touchups. Add the recently added E835 devices to the supported HARDWARE list. Add the speed ranges to description like the other ethernet drivers. PR: 290778 MFC after: 1 day Fixes: 09b48f811b4b (Add support for E835-XXV-4 adapter) Fixes: b202176dc76d (Add PCI IDs for E835 devices) Reviewed by: kgalazka (previous version) Reported by: kgalazka (additional hardware has been added) Reported by: bigsneaky@duck.com (HW Relnote is truncating) (cherry picked from commit f30335c5cb5e18a1ef08f5ba1d6fa6fc06f39348) share/man/man4/ice.4 | 372 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 224 insertions(+), 148 deletions(-)
A commit in branch releng/15.0 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=3a63ca9620f9dd5a9978d76d145f596d24cef9e7 commit 3a63ca9620f9dd5a9978d76d145f596d24cef9e7 Author: Alexander Ziaee <ziaee@FreeBSD.org> AuthorDate: 2025-11-05 21:59:20 +0000 Commit: Colin Percival <cperciva@FreeBSD.org> CommitDate: 2025-11-07 04:19:26 +0000 ice.4: Add ToC and E835 and editorial pass This manual is large enough and well structured enough that we can have a clickable table of contents. Use that to move some subsections which should not appear in Hardware Release Note to the description section. Adjust subsection names so this will work, preserving parentheticals for search by moving them to the bodies just below. Strip unnecessary copyright symbols and escaped hyphens. Copyright symbols never appear in the content of manual pages, including other Intel manual pages, and appear to break the Hardware Release Notes. Escaped hyphens were necessary decades ago for manual pages written in man(7), but this page is written in mdoc(7). Also misc touchups. Add the recently added E835 devices to the supported HARDWARE list. Add the speed ranges to description like the other ethernet drivers. Approved by: re (cperciva) PR: 290778 MFC after: 1 day Fixes: 09b48f811b4b (Add support for E835-XXV-4 adapter) Fixes: b202176dc76d (Add PCI IDs for E835 devices) Reviewed by: kgalazka (previous version) Reported by: kgalazka (additional hardware has been added) Reported by: bigsneaky@duck.com (HW Relnote is truncating) (cherry picked from commit f30335c5cb5e18a1ef08f5ba1d6fa6fc06f39348) (cherry picked from commit 71bd17b879a74f57573d41ad21a9a0e7f984ab11) share/man/man4/ice.4 | 372 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 224 insertions(+), 148 deletions(-)
A commit in branch main references this bug: URL: https://cgit.FreeBSD.org/doc/commit/?id=509b16588008f983d0998a541df2d3bb088bf758 commit 509b16588008f983d0998a541df2d3bb088bf758 Author: Alexander Ziaee <ziaee@FreeBSD.org> AuthorDate: 2025-11-11 16:31:52 +0000 Commit: Alexander Ziaee <ziaee@FreeBSD.org> CommitDate: 2025-11-11 16:37:23 +0000 15.0: Regenerate hardware notes This brings in fixes to aacraid, ciss, and ice, adds nvd, and removes a long lost section about misc. USB hardware. PR: 290778 Reported by: bigsneaky@duck.com website/content/en/releases/15.0R/hardware.adoc | 78 +++++++++++++++++++------ 1 file changed, 60 insertions(+), 18 deletions(-)