Page MenuHomeFreeBSD

aq(4): Add man page
Needs ReviewPublic

Authored by emaste on Thu, Nov 20, 1:47 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Nov 21, 9:34 AM
Unknown Object (File)
Fri, Nov 21, 2:12 AM
Unknown Object (File)
Fri, Nov 21, 1:24 AM
Unknown Object (File)
Fri, Nov 21, 12:15 AM
Unknown Object (File)
Thu, Nov 20, 11:54 PM
Unknown Object (File)
Thu, Nov 20, 10:12 PM
Unknown Object (File)
Thu, Nov 20, 7:38 PM
Unknown Object (File)
Thu, Nov 20, 6:10 PM
Subscribers
This revision needs review, but there are no reviewers specified.

Details

Reviewers
None

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

emaste added a parent revision: D53839: aq: add module.
share/man/man4/aq.4
4

SPDX tag applied in local copy

share/man/man4/aq.4
10

This doesn't need to be quoted.

share/man/man4/aq.4
32

Or similar. The reasoning is then people can search through the hardware release notes to see what kind of hardware they need, if they want say, a 10g Ethernet card. I also wrote this in style.mdoc(7).

share/man/man4/aq.4
32

No objection, but that information is in the Nd -- aq – Aquantia / Marvell AQ1xx 10 Gigabit Ethernet driver

share/man/man4/aq.4
32

Yeah, it's not for the manual, it's for the HW Relnotes. The entire HARDWARE section appears verbatim in the HW Relnotes. When it has no context, then the document becomes only useful for a very narrow use case of "Find in Page"ing your specific hardware you already have.

And, I know, but if we do it this way, we can maintain it. Otherwise the HW Relnotes becomes full of dead links that someone has to actually line by line investigate the history of what it's talking about, which is a colossal effort.

Update HARDWARE introduction, thanks @ziaee

Are there kernconfs to compile the module? We also usually put that in synopsis.

I see this formulation in share/man/man4/mgb.4 and share/man/man4/muge.4 and I probably looked at one of those as a template. I'll take a look at updating those first. mgb(4) is a driver for PCIe GigE hw, muge(4) USB GigE.

Are there kernconfs to compile the module? We also usually put that in synopsis.

There isn't yet.