Page MenuHomeFreeBSD

nvmf_che: Add a manual page for the Chelsio NVMe/TCP PDU offload driver
ClosedPublic

Authored by jhb on Nov 14 2025, 6:52 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Jan 10, 2:27 AM
Unknown Object (File)
Thu, Jan 8, 8:27 AM
Unknown Object (File)
Wed, Jan 7, 2:19 PM
Unknown Object (File)
Tue, Jan 6, 2:27 PM
Unknown Object (File)
Sat, Jan 3, 9:08 PM
Unknown Object (File)
Fri, Jan 2, 1:20 AM
Unknown Object (File)
Wed, Dec 31, 12:35 PM
Unknown Object (File)
Sat, Dec 27, 10:25 PM
Subscribers

Details

Summary

Sponsored by: Chelsio Communications

Diff Detail

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

Event Timeline

jhb requested review of this revision.Nov 14 2025, 6:52 PM
share/man/man4/nvmf_che.4
12

This doesn't need to be quoted

16–18

This matches what we do on dozens of pages.

I like what you did here of calling it a module continuously.

share/man/man4/nvmf_che.4
16–18

Oh, I just copied this from nvmf_tcp.4 which uses the same markup. Presumably these nits need to be fixed in that.

share/man/man4/nvmf_che.4
16–18

Hmm, grepping in share/man/man4:

> git grep '_load="YES"' | wc -l
     504
> git grep '^\..*_load="YES"' 
acpi_wmi.4:.Dl acpi_wmi_load="YES"
mrsas.4:.Cd mrsas_load="YES"
rtsx.4:.Cd mmc_load="YES"
rtsx.4:.Cd mmcsd_load="YES"
rtsx.4:.Cd rtsx_load="YES"
u2f.4:.Cd u2f_load="YES"
umb.4:.Cd umb_load="YES"
vmm.4:.Cd vmm_load="YES"
wpi.4:.Dl if_wpi_load="YES"

Given the description of .Cd in mode(7) it seems like it should be used for device foo but not loader.conf entries.

Also, existing pages (which use prose) still indent these lines via a \.Bd block which I think we are stuck with until we settle on a format that doesn't use prose.

jhb marked an inline comment as done.Dec 9 2025, 3:56 PM
This revision was not accepted when it landed; it landed in state Needs Review.Dec 9 2025, 3:58 PM
This revision was automatically updated to reflect the committed changes.