Page MenuHomeFreeBSD

Add a manpage for mlx4ib
ClosedPublic

Authored by ngie on Jan 19 2017, 7:34 AM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 14 2024, 12:22 AM
Unknown Object (File)
Jan 9 2024, 10:29 PM
Unknown Object (File)
Jan 6 2024, 7:47 AM
Unknown Object (File)
Dec 20 2023, 2:56 AM
Unknown Object (File)
Nov 10 2023, 4:09 AM
Unknown Object (File)
Nov 10 2023, 3:04 AM
Unknown Object (File)
Nov 8 2023, 4:09 AM
Unknown Object (File)
Nov 7 2023, 12:11 AM
Subscribers

Details

Summary

This manpage isn't differentiated from mlx4en, other than IB/ib right now
where necessary.

Eventually the manpages will be split and the common bits be placed in a
manpage named "mlx4.4".

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ngie retitled this revision from to Add a manpage for mlx4ib.
ngie updated this object.
ngie edited the test plan for this revision. (Show Details)
ngie added a reviewer: hselasky.
ngie set the repository for this revision to rS FreeBSD src repository - subversion.
hselasky edited edge metadata.

I think the manual page should only be installed when WITH_OFED=YES, because that's when MLX4IB and the infiniband stack is installed? Else looks good.

This revision is now accepted and ready to land.Jan 19 2017, 8:26 AM
This revision was automatically updated to reflect the committed changes.

I think the manual page should only be installed when WITH_OFED=YES, because that's when MLX4IB and the infiniband stack is installed? Else looks good.

Done in the committed diff (the MK_OFED suggestion). I will need to look at mlx4en.4 being installed only when MK_OFED=yes as well because installing it without the OFED stack doesn't make sense to me (at least...).

wblock added inline comments.
head/share/man/man4/mlx4ib.4
35

s/the following/these/

44

s/the following/this/

50

s/the following lines/this line/

63

While Mellanox cards are no doubt awesome, the DESCRIPTION section is supposed to describe what this driver does, and these two sentences don't do that at all. The HARDWARE section below identifies the specific cards, but gives no other details. Things that could be described here that would be helpful for the reader could include whether all cards in the series are supported, particular features which are or are not supported, and in general anything that would be helpful to someone either trying to use these cards on FreeBSD or evaluating FreeBSD support for these cards before obtaining them.

78

Mandoc provides a .Lk macro for links. The older groff_mdoc mentions .Lk but only says "to be written". Still...

80
If an issue with this driver and a supported network adapter is identified,
81
please email the specific information to