Page MenuHomeFreeBSD

Document additions from reviews D34687 and D34764 in cgem.4 manpage
Needs ReviewPublic

Authored by bsd_dino.sk on Aug 20 2022, 3:44 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Nov 14, 9:15 PM
Unknown Object (File)
Sun, Nov 3, 3:03 PM
Unknown Object (File)
Oct 5 2024, 10:38 PM
Unknown Object (File)
Oct 5 2024, 6:08 PM
Unknown Object (File)
Oct 4 2024, 2:14 PM
Unknown Object (File)
Oct 2 2024, 9:17 AM
Unknown Object (File)
Oct 2 2024, 12:31 AM
Unknown Object (File)
Sep 30 2024, 5:46 AM

Details

Reviewers
None
Group Reviewers
manpages
Summary

Review D34687 added if_cgem as loadable module.
Review D34764 added SGMII connection mode and some enhancements.
Document those in relevant manpage,

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

I'm not sure I understand the driver changes this is meant to document. Someone else will have to check for consistency with that. Perhaps the reviewer(s) for these changes. Meanwhile, could you upload a full diff next time as already requested in one of these reviews?

share/man/man4/cgem.4
110

s/RGMII,/RGMII;/ (comma splice)

111

s/in device tree/in the device tree/

English LGTM now but it really needs a subject matter expert to look at it.

mhorne added inline comments.
share/man/man4/cgem.4
54

While here, you could tweak this to mention the HiFive Unmatched instead. It is a more relevant example.

111–113

IMO, device tree properties are beyond the scope of what we would expect in a driver man page. I think it is enough to say the following:

The
.Nm
driver supports GMII, RGMII, and SGMII PHY connection modes.